编辑器配置信息

  • 接口地址: /api/fresns/editor/configs
  • 请求方式: POST
  • 请求格式: JSON

header 可选参数:

参数名公开模式(是否必传)私有模式(是否必传)
uidYESYES
midYESYES
tokenYESYES

body 参数:

参数名类型是否必传说明
typeNumberYES1.帖子编辑器 / 2.评论编辑器

返回结果:

成功-帖子

{
    "code": 0,
    "message": "ok",
    "data": {
        "publishPerm": {
            "status": true, //是否有权发表;有四项判断,对应 tips 中的原因,每个都要检查
            "review": false, //原样输出成员主角色 post_review 配置值
            "tips": {
                //无权时提示原因,因哪个原因导致无权发表的,在这里列出键名
                "expired_at": "输出 Error Code 30304 描述,多语言", //如果是私有模式,成员过期 members > expired_at 导致的不可发表
                "post_publish": "输出 Error Code 30403 描述,多语言", //主角色无权;来自主角色 post_publish 配置
                "post_email_verify": "输出 Error Code 30700 描述,多语言", //主角色或全局要求绑定了邮箱;来自角色或全局的 post_email_verify 配置;判断 users > email 字段是否有值。
                "post_phone_verify": "输出 Error Code 30701 描述,多语言", //主角色或全局要求绑定了手机号;来自角色或全局的 post_phone_verify 配置;判断 users > phone 字段是否有值。
                "post_prove_verify": "输出 Error Code 30702 描述,多语言" //主角色或全局要求实名制;来自角色或全局的 post_prove_verify 配置;判断 users > prove_verify 字段值为 2。
            }
        },
        "editPerm": {
            "status": true, //原样输出配置表 post_edit 键值
            "timeLimit": 5, //单位 分钟,原样输出配置表 post_edit_timelimit 键值
            "editSticky": false, //原样输出配置表 post_edit_sticky 键值
            "editEssence": false //原样输出配置表 post_edit_essence 键值
        },
        "roleLimit": {
            "status": false, //是否显示角色特殊权限(角色表);未开启或者不在限制时间内,不显示提示
            "roleName": "主角色名称", //多语言
            "limitType": 1, //post_limit_type / 1.指定某个时间段范围内生效 2.指定每天的某个时间段范围内循环生效
            "limitTimeStart": "开始日期或时间", //post_limit_period_start 或 post_limit_cycle_start
            "limitTimeEnd": "结束日期或时间", //post_limit_period_end 或 post_limit_cycle_end
            "limitRule": 1 //post_limit_rule 1.可以发表,但是需要审核 2.禁止发表
        },
        "globalLimit": {
            "status": false, //是否显示全局特殊权限(配置表);主角色在白名单 post_limit_whitelist 里,不显示;未开启或者不在限制时间内,也不显示。
            "limitType": 1, //post_limit_type / 1.指定某个时间段范围内生效 2.指定每天的某个时间段范围内循环生效
            "limitTimeStart": "开始日期或时间", //post_limit_period_start 或 post_limit_cycle_start
            "limitTimeEnd": "结束日期或时间", //post_limit_period_end 或 post_limit_cycle_end
            "limitRule": 1, //post_limit_rule / 1.可以发表,但是需要审核 2.禁止发表
            "limitPrompt": "限制提示语" //post_limit_prompt 多语言
        },
        "toolbar": {
            "emoji": true, //原样输出配置表 post_editor_emoji 键值
            "image": {
                "status": true, //如果配置表 post_editor_image 键值等于 false 直接输出;如果等于 true 则输出成员主角色权限参数 post_editor_image 配置值。
                "url": "https://abc.com/upload?abc=abc", //配置表 images_service 键值的插件 URL,逻辑见下方开发说明。
                "extensions": "png,gif,jpg,jpeg,bmp,heic", //原样输出配置表 images_ext 键值
                "maxSize": 5 //单位 MB;当成员主角色 images_max_size 权限参数配置值为空时,输出配置表 images_max_size 键值
            },
            "video": {
                "status": true, //如果配置表 post_editor_video 键值等于 false 直接输出;如果等于 true 则输出成员主角色权限参数 post_editor_video 配置值。
                "url": "https://abc.com/upload?abc=abc", //配置表 videos_service 键值的插件 URL,逻辑见下方开发说明。
                "extensions": "wmv,rm,mov,mpeg,mp4,3gp,flv,avi,rmvb", //原样输出配置表 videos_ext 键值
                "maxSize": 50, //单位 MB;当成员主角色 videos_max_size 配置值为空时,输出配置表 videos_max_size 键值
                "maxTime": 15 //单位 秒;当成员主角色 videos_max_time 权限参数配置值为空时,输出配置表 videos_max_time 键值
            },
            "audio": {
                "status": true, //如果配置表 post_editor_audio 键值等于 false 直接输出;如果等于 true 则输出成员主角色权限参数 post_editor_audio 配置值。
                "url": "https://abc.com/upload?abc=abc", //配置表 audios_service 键值的插件 URL,逻辑见下方开发说明。
                "extensions": "mp3,wav,m4a", //原样输出配置表 audios_ext 键值
                "maxSize": 50, //单位 MB;当成员主角色 audios_max_size 配置值为空时,输出配置表 audios_max_size 键值
                "maxTime": 60 //单位 秒;当成员主角色 audios_max_time 权限参数配置值为空时,输出配置表 audios_max_time 键值
            },
            "doc": {
                "status": true, //如果配置表 post_editor_doc 键值等于 false 直接输出;如果等于 true 则输出成员主角色权限参数 post_editor_doc 配置值。
                "url": "https://abc.com/upload?abc=abc", //配置表 docs_service 键值的插件 URL,逻辑见下方开发说明。
                "extensions": "doc,docx,xls,xlsx,csv,ppt,pptx,pps,ppts,pdf,txt,md,markdown,rar,zip,7z,epub,mobi", //原样输出配置表 docs_ext 键值
                "maxSize": 10 //单位 MB;当成员主角色 docs_max_size 权限参数配置值为空时,输出配置表 docs_max_size 键值
            },
            "title": {
                "status": true, //原样输出配置表 post_editor_title 键值
                "view": 1, //原样输出配置表 post_editor_title_view 键值,1.默认显示 2.默认隐藏
                "required": true, //原样输出配置表 post_editor_title_required 键值
                "wordCount": 60 //原样输出配置表 post_editor_title_word_count 键值
            },
            "mention": true, //原样输出配置表 post_editor_mention 键值
            "hashtag": {
                "status": true, //原样输出配置表 post_editor_hashtag 键值
                "showMode": 1 //原样输出配置表 hashtag_show 键值
            },
            "expand": {
                "status": true, //原样输出配置表 post_editor_expand 键值
                "list": [
                    //plugin_usages > type = 3 + scene 为空或者包含 1 的数据
                    {
                        "plugin": "plugin_usages > plugin_unikey",
                        "name": "plugin_usages > name 多语言",
                        "icon": "plugin_usages > icon_file_url",
                        "url": "详见 plugins 地址拼接说明",
                        "number": "plugin_usages > editor_number"
                    }
                ]
            }
        },
        "features": {
            "postGroup": {
                "status": true, //原样输出配置表 post_editor_group 键值
                "required": true //原样输出配置表 post_editor_group_required 键值
            },
            "isLbs": {
                "status": true, //原样输出配置表 post_editor_lbs 键值
                "maps": [
                    //plugin_usages > type = 9 的数据
                    {
                        "plugin": "plugin_usages > plugin_unikey",
                        "name": "plugin_usages > name 多语言",
                        "icon": "plugin_usages > icon_file_url",
                        "url": "详见 plugins 地址拼接说明"
                    }
                ]
            },
            "isAnonymous": true, //原样输出配置表 post_editor_anonymous 键值
            "contentWordCount": 10000 //原样输出配置表 post_editor_word_count 键值
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

成功-评论

{
    "code": 0,
    "message": "ok",
    "data": {
        "publishPerm": {
            "status": true, //是否有权发表;有四项判断,对应 tips 中的原因
            "review": false, //原样输出成员主角色 comment_review 配置值
            "tips": {
                //无权时提示原因,因哪个原因导致无权发表的,在这里列出键名
                "expired_at": "输出 Error Code 30304 描述,多语言", //如果是私有模式,成员过期 members > expired_at 导致的不可发表
                "comment_publish": "输出 Error Code 30403 描述,多语言", //主角色无权;来自主角色 comment_publish 配置
                "comment_email_verify": "输出 Error Code 30700 描述,多语言", //主角色或全局要求绑定了邮箱;来自角色或全局的 comment_email_verify 配置;判断 users > email 字段是否有值。
                "comment_phone_verify": "输出 Error Code 30701 描述,多语言", //主角色或全局要求绑定了手机号;来自角色或全局的 comment_phone_verify 配置;判断 users > phone 字段是否有值。
                "comment_prove_verify": "输出 Error Code 30702 描述,多语言" //主角色或全局要求实名制;来自角色或全局的 comment_prove_verify 配置;判断 users > prove_verify 字段值为 2。
            }
        },
        "editPerm": {
            "status": true, //原样输出配置表 comment_edit 键值
            "timeLimit": 5, //单位 分钟,原样输出配置表 comment_edit_timelimit 键值
            "editSticky": false, //原样输出配置表 comment_edit_sticky 键值
        },
        "roleLimit": {
            "status": false, //是否显示角色特殊权限(角色表);未开启或者不在限制时间内,不显示提示
            "roleName": "主角色名称", //多语言
            "limitType": 1, //comment_limit_type / 1.指定某个时间段范围内生效 2.指定每天的某个时间段范围内循环生效
            "limitTimeStart": "开始日期或时间", //comment_limit_period_start 或 comment_limit_cycle_start
            "limitTimeEnd": "结束日期或时间", //comment_limit_period_end 或 comment_limit_cycle_end
            "limitRule": 1 //comment_limit_rule 1.可以发表,但是需要审核 2.禁止发表
        },
        "globalLimit": {
            "status": false, //是否显示全局特殊权限(配置表);主角色在白名单 comment_limit_whitelist 里,不显示;未开启或者不在限制时间内,也不显示。
            "limitType": 1, //comment_limit_type / 1.指定某个时间段范围内生效 2.指定每天的某个时间段范围内循环生效
            "limitTimeStart": "开始日期或时间", //comment_limit_period_start 或 comment_limit_cycle_start
            "limitTimeEnd": "结束日期或时间", //comment_limit_period_end 或 comment_limit_cycle_end
            "limitRule": 1, //comment_limit_rule / 1.可以发表,但是需要审核 2.禁止发表
            "limitPrompt": "限制提示语" //comment_limit_prompt 多语言
        },
        "toolbar": {
            "emoji": true, //原样输出配置表 comment_editor_emoji 键值
            "image": {
                "status": true, //如果配置表 comment_editor_image 键值等于 false 直接输出;如果等于 true 则输出成员主角色权限参数 comment_editor_image 配置值。
                "url": "https://abc.com/upload?abc=abc", //配置表 images_service 键值的插件 URL,逻辑见下方开发说明。
                "extensions": "png,gif,jpg,jpeg,bmp,heic", //原样输出配置表 images_ext 键值
                "maxSize": 5 //单位 MB;当成员主角色 images_max_size 权限参数配置值为空时,输出配置表 images_max_size 键值
            },
            "video": {
                "status": true, //如果配置表 comment_editor_video 键值等于 false 直接输出;如果等于 true 则输出成员主角色权限参数 comment_editor_video 配置值。
                "url": "https://abc.com/upload?abc=abc", //配置表 videos_service 键值的插件 URL,逻辑见下方开发说明。
                "extensions": "wmv,rm,mov,mpeg,mp4,3gp,flv,avi,rmvb", //原样输出配置表 videos_ext 键值
                "maxSize": 50, //单位 MB;当成员主角色 videos_max_size 配置值为空时,输出配置表 videos_max_size 键值
                "maxTime": 15 //单位 秒;当成员主角色 videos_max_time 权限参数配置值为空时,输出配置表 videos_max_time 键值
            },
            "audio": {
                "status": true, //如果配置表 comment_editor_audio 键值等于 false 直接输出;如果等于 true 则输出成员主角色权限参数 comment_editor_audio 配置值
                "url": "https://abc.com/upload?abc=abc", //配置表 audios_service 键值的插件 URL,逻辑见下方开发说明。
                "extensions": "mp3,wav,m4a", //原样输出配置表 audios_ext 键值
                "maxSize": 50, //单位 MB;当成员主角色 audios_max_size 配置值为空时,输出配置表 audios_max_size 键值
                "maxTime": 60 //单位 秒;当成员主角色 audios_max_time 权限参数配置值为空时,输出配置表 audios_max_time 键值
            },
            "doc": {
                "status": true, //如果配置表 comment_editor_doc 键值等于 false 直接输出;如果等于 true 则输出成员主角色权限参数 comment_editor_doc 配置值
                "url": "https://abc.com/upload?abc=abc", //配置表 docs_service 键值的插件 URL,逻辑见下方开发说明。
                "extensions": "doc,docx,xls,xlsx,csv,ppt,pptx,pps,ppts,pdf,txt,md,markdown,rar,zip,7z,epub,mobi", //原样输出配置表 docs_ext 键值
                "maxSize": 10 //单位 MB;当成员主角色 docs_max_size 权限参数配置值为空时,输出配置表 docs_max_size 键值
            },
            "mention": true, //原样输出配置表 comment_editor_mention 键值
            "hashtag": {
                "status": true, //原样输出配置表 comment_editor_hashtag 键值
                "showMode": 1 //原样输出配置表 hashtag_show 键值
            },
            "expand": {
                "status": true, //原样输出配置表 comment_editor_expand 键值
                "list": [
                    //plugin_usages > type = 3 + scene 为空或者包含 2 的数据
                    {
                        "plugin": "plugin_usages > plugin_unikey",
                        "name": "plugin_usages > name 多语言",
                        "icon": "plugin_usages > icon_file_url",
                        "url": "详见 plugins 地址拼接说明",
                        "number": "plugin_usages > editor_number"
                    }
                ]
            }
        },
        "features": {
            "isLbs": {
                "status": true, //原样输出配置表 comment_editor_lbs 键值
                "maps": [
                    //plugin_usages > type = 9 的数据
                    {
                        "plugin": "plugin_usages > plugin_unikey",
                        "name": "plugin_usages > name 多语言",
                        "icon": "plugin_usages > icon_file_url",
                        "url": "详见 plugins 地址拼接说明"
                    }
                ]
            },
            "isAnonymous": true, //原样输出配置表 comment_editor_anonymous 键值
            "contentWordCount": 10000 //原样输出配置表 comment_editor_word_count 键值
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

失败

{
    "code": "code_messages > code",
    "message": "code_messages > message"
}
1
2
3
4

开发说明

  • false = 无/无权/不显示
  • true = 有/有权/显示
  • 插件完整的 URL 地址,由域名字段 plugin_domain 加路径字段 access_path 拼接完成,当 plugin_domain 为空时,与后端地址(配置表键名 backend_domain)拼接成完整 URL 地址。