管理聊天室机器人
更新时间: 2024/07/17 17:57:35
网易云信 IM 服务端支持在指定聊天室添加、删除或清空机器人账号。
添加聊天室机器人
功能描述
在指定聊天室内批量添加机器人,机器人过期时间为24小时。
URL
httpPOST https://api.netease.im/nimserver/chatroom/addRobot.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
roomid | long | 是 | 聊天室id |
accids | JSONArray | 是 | 机器人账号accid列表,必须是有效账号,账号数量上限100个 |
roleExt | String | 否 | 机器人信息扩展字段,请使用json格式,长度4096字符 |
notifyExt | String | 否 | 机器人进入聊天室通知的扩展字段,请使用json格式,长度2048字符 |
示例
cURL请求示例
curlcurl -X POST -H "CheckSum: 51eb13ea5**8e61c65c7866c366" -H "AppKey: f541664055e**866ad7799" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=70&accids=["zhangsan","lisi"]' 'https://api.netease.im/nimserver/chatroom/addRobot.action'
请求成功返回示例
json
"Content-Type": "application/json; charset=utf-8"
{
"desc": {
"failAccids": "[\"hzzhangsan\"]",
"successAccids": "[\"hzlisi\"]",
"oldAccids": "[\"hzwangwu\"]"
},
"code": 200
}
删除机器人
功能描述
批量删除指定聊天室内的机器人,最多删除 100 个机器人账号。
httpPOST https://api.netease.im/nimserver/chatroom/removeRobot.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
roomid | long | 是 | 聊天室id |
accids | JSONArray | 是 | 机器人账号accid列表,必须是有效账号,账号数量上限100个 |
示例
cURL请求示例
curlcurl -X POST -H "CheckSum: 51eb13e**61c65c7866c366" -H "AppKey: f541664055e**66ad7799" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=70&accids=["zhangsan","lisi"]' 'https://api.netease.im/nimserver/chatroom/removeRobot.action'
请求成功返回示例
json
"Content-Type": "application/json; charset=utf-8"
{
"desc": {
"failAccids": "[\"hzzhangsan\"]",
"successAccids": "[\"hzlisi\"]"
},
"code": 200
}
清空机器人
功能描述
删除聊天室内全部机器人。
URL
httpPOST https://api.netease.im/nimserver/chatroom/cleanRobot.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
roomid | long | 是 | 聊天室id |
notify | boolean | 否 | 是否发送退出聊天室通知消息,默认为false |
示例
cURL请求示例
curlcurl -X POST -H "CheckSum: 51eb13ea**61c65c7866c366" -H "AppKey: f5416640**66ad7799" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=70¬ify=false' 'https://api.netease.im/nimserver/chatroom/cleanRobot.action'
请求成功返回示例
json
"Content-Type": "application/json; charset=utf-8"
{
"code": 200,
"desc": {
"size": 2
}
}
状态码
上述 API 在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码。
此文档是否对你有帮助?