接口调用说明
App 管理员主动调用 REST API 接口,更新当前机器人现网发布状态配置。
请求 URL 示例
https://xxxxxx/v4/openim_console_http_svc/update_robot_config?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/openim_console_http_svc/update_robot_config | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json 。 |
请求包示例
{"WelcomeCardQuestions": ["今天天气怎么样","RESTAPI设置欢迎语"],"WelcomeCardEnable": 1,"WelcomeCardTitle": "猜你想问","ToAgentEnable": 0,"DirectAnsweringReaches": "0.56","ChitchatEnable": 1,"ChitchatReaches": "0.88","ClarifyEnable": 1,"ClarifyReaches": "0.21","ClarifyMessage": "你可能想问","ClarifyNumber": 6,"FallbackMsg": "触发兜底了","LanguageTag": ""}
请求包字段说明
字段 | 类型 | 说明 |
WelcomeCardEnable | Integer | 欢迎卡片功能开关。 |
WelcomeCardTitle | String | 欢迎卡片标题。 |
WelcomeCardQuestions | Array | 欢迎卡片问题列表。 |
ToAgentEnable | Integer | 转人工意图识别开关。 |
DirectAnsweringReaches | String | 问答库直接回答相似度阈值(引导提问相似度最大阈值)。 |
ChitchatEnable | Integer | 寒暄库开关。 |
ChitchatReaches | String | 寒暄库直接回答相似度阈值。 |
ClarifyEnable | Integer | 引导提问开关。 |
ClarifyReaches | String | 引导提问相似度最小阈值。 |
ClarifyMessage | String | 引导话术。 |
ClarifyNumber | Integer | 引导条数。 |
FallbackMsg | String | 兜底回复话术。 |
LanguageTag | String | 要更新的语言,需已添加该语言,默认语言为空。 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败。 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败。 |
ErrorInfo | String | 错误信息。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 描述 |
-7 | 参数解析失败,请检查请求包是否符合 JSON 规范或者请求参数符合要求。 |
-14 | 超过该接口允许的最大频率限制。 |
-20 | 请求需要 App 管理员权限。 |
-50003 | 智能客服资源无效。 |
-50040 | 请求应用未开通智能客服服务。 |