添加机器人寒暄库问题

最近更新时间:2025-04-02 16:50:22

我的收藏

接口调用说明

App 管理员主动调用 REST API 接口,添加问题到机器人寒暄库。
注意:
通过 RESTAPI 设置后直接现网生效(管理端设置并发布)。

请求 URL 示例

https://xxxxxx/v4/openim_console_http_svc/add_chitchat?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参见 REST API 简介
参数
说明
v4/openim_console_http_svc/add_chitchat
请求接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295。
contenttype
请求格式固定值为json

最高调用频率

5次/秒。

请求包示例

{
"CategoryId": 77514,
"Question": "REST_API 添加问题",
"Answer":"REST_API添加回答",
"AnswerType":0,
"SimilarQuestions":[
"相似问题 1",
"相似问题 2"
]
}

请求包字段说明

字段
类型
说明
CategoryId
Integer
要添加到的分类。
Question
String
添加的问题。
Answer
String
回答。
AnswerType
Integer
回答类型。需满足枚举值:
0 - 普通文本回答。
2 - 富文本回答。
SimilarQuestions
Array
相似问题。

应答包体示例

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果,OK 表示处理成功,FAIL 表示失败。
ErrorCode
Integer
错误码,0表示成功,非0表示失败。
ErrorInfo
String
错误信息。

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码
描述
-7
参数解析失败,请检查请求包是否符合 JSON 规范或者请求参数符合要求。
-14
超过该接口允许的最大频率限制。
-20
请求需要 App 管理员权限。

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

查询单聊消息(v4/openim/admin_getroammsg