接口调用说明
App 管理员主动调用 REST API 接口更新机器人信息（昵称）。
请求 URL 示例
https://xxxxxx/v4/openim_console_http_svc/desk_update_robot?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/openim_console_http_svc/desk_update_robot | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
最高调用频率
5次/秒。
请求包示例
{"RobotId": "@RBT#DeskDefaultRobot","Nick": "test-robot"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
RobotId | String | 必填 | 机器人的 RobotId。 |
Nick | String | 必填 | 机器人的新昵称。不大于 50 个字符。 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果，OK 表示处理成功，FAIL 表示失败。 |
ErrorCode | Integer | 错误码，0表示成功，非0表示失败。 |
ErrorInfo | String | 错误信息。 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下：
错误码 | 描述 |
-1 | 系统错误，请联系我们处理。 |
-7 | 参数解析失败，请检查请求包是否符合 JSON 规范或者请求参数符合要求。 |
-14 | 超过该接口允许的最大频率限制。 |
-20 | 请求需要 App 管理员权限。 |
-50040 | 未开通智能客服。 |
-50059 | 智能客服版本过期。 |
接口调试工具
参考
联系我们
如果您在接入过程中有任何疑问，请用微信或企业微信扫码加入智能客服交流群进行咨询。
