接口调用说明
支持在 App 后台主动调用 REST API 接口,获取机器人寒暄库问题。
注意:
通过 REST API 获取的问题库为现网生效(发布后状态)问题库。
请求 URL 示例
https://xxxxxx/v4/openim_console_http_svc/list_chitchat?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/openim_console_http_svc/list_chitchat | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json 。 |
最高调用频率
5次/秒。
请求包示例
{"PageIndex": 1,"PageSize": 3,"Question":"机器人","CategoryId":10463,"Status":4}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
PageIndex | Integer | 必填 | 分页参数(大于0)。 |
PageSize | Integer | 必填 | 分页参数(大于0)。 |
Question | String | 选填 | 主问题关键词过滤。 |
CategoryId | Integer | 选填 | 分类 ID 过滤。 |
Status | Integer | 选填 | 状态过滤。 如果填写需满足枚举状态: 4 - 生效。 5 - 停用。 其他值非法。 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"AllQuestionCount": 4,"StandardQuestionCount": 2,"QuestionList": [{"StandardQuestionId": "1500086166-@RBT#DeskDefaultRobot-dhoLfseT3tvxP4HB","StandardQuestion": "你是人工智能吗?","Status": 4,"CategoryId": 10463,"Answer": "我是智能小机器人,我可以回答你的问题、提供信息,您有任何问题或需要帮助,请随时告诉我。","AnswerType": 0,"QuestionType": 1,"SimilarQuestions": []},{"StandardQuestionId": "1500086166-@RBT#DeskDefaultRobot-y0WjnE0Siv1oDbLR","StandardQuestion": "你是智能机器人吗?","Status": 4,"CategoryId": 10463,"Answer": "我是智能小机器人,我可以回答你的问题、提供信息,您有任何问题或需要帮助,请随时告诉我。","AnswerType": 0,"QuestionType": 1,"SimilarQuestions": []}]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败。 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败。 |
ErrorInfo | String | 错误信息。 |
AllQuestionCount | Integer | 全部问题数量。 |
StandardQuestionCount | Integer | 标准问题数量。 |
QuestionList | Array | 问题列表。 |
StandardQuestionId | String | 标准问题 ID。 |
StandardQuestion | String | 标准问题。 |
Status | Integer | 状态。状态值枚举: 4 - 生效。 5 - 停用。 |
CategoryId | Integer | 分类 ID。 |
Answer | String | 回答。 |
AnswerType | Integer | 回答类型。回答类型枚举: 0 - 普通文本。 2 - 富文本。 |
QuestionType | Integer | 问题类型。问题类型枚举: 0 - 普通问题。 1 - 系统预设。 |
SimilarQuestions | Array | 相似问题列表。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 描述 |
-7 | 参数解析失败,请检查请求包是否符合 JSON 规范或者请求参数符合要求。 |
-14 | 超过该接口允许的最大频率限制。 |
-20 | 请求需要 App 管理员权限。 |