功能说明
App 管理员和群主可以往直播群在线成员列表添加“机器人”账号，“机器人”账号无需调用加群接口即可固定在在线成员列表中，并且不受“机器人”账号是否在线影响。本 API 实际上是为“机器人”账号设置特殊标记（500），具体可以参考“设置直播群成员标记”接口。该功能需旗舰版或企业版，并且在 IM 控制台“群功能配置”中开通“直播群在线成员列表”功能。其他套餐版本调用该 API 将返回失败。
接口调用说明
适用的群组类型
群组类型 ID | 是否支持此 REST API |
Private | 不支持，同新版本中的 Work（好友工作群）。 |
Public | 不支持。 |
ChatRoom | 不支持，同新版本中的 Meeting（临时会议群）。 |
AVChatRoom | 支持。 |
Community（社群） | 不支持。 |
注意：
此功能需 旗舰版或企业版套餐，并且已开通“直播群在线成员列表”功能(控制台“群功能配置”)。
其他套餐版本调用该 API 返回失败。
本 API 实际上是为“机器人”账号设置特殊标记（500），具体可以参见 设置直播群成员标记 接口。
可以通过 在群组中发送普通消息 接口发消息。
可以通过 设置资料 接口设置用户资料。
请求 URL 示例
https://xxxxxx/v4/group_open_avchatroom_http_svc/add_robots?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com首尔： adminapikr.im.qcloud.com东京： adminapijpn.im.qcloud.com法兰克福： adminapiger.im.qcloud.com硅谷： adminapiusa.im.qcloud.com雅加达： adminapiidn.im.qcloud.com利雅得： adminapiksa.im.qcloud.com |
v4/group_open_avchatroom_http_svc/add_robots | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
最高调用频率
200次/秒。
请求包示例
为直播群添加 bot1 和 bot2 两个机器人：
{"GroupId": "@TGS#a6I4ZUUGO","Member_Account": ["bot1", "bot2"]}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
GroupId | String | 必填 | 操作的群 ID。 |
Member_Account | Array | 必填 | 需要设置的“机器人”账号列表。 |
应答包体示例
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "","RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果： OK：表示处理成功 FAIL：表示失败 |
ErrorCode | Integer | 错误码： 0：表示成功 非0：表示失败 |
ErrorInfo | String | 错误信息。 |
RequestId | String | 本次请求的唯一标识 ID，可用于问题排查。 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码 | 含义说明 |
10001 | 用户未登录错误，请检查 admin 账号和 usersig 是否正确。 |
10002 | 系统错误，请再次尝试或联系技术客服。 |
10003 | 请求命令非法，请再次尝试或联系技术客服。 |
10004 | 参数非法。请根据应答包中的 ErrorInfo 字段，检查必填字段是否填充，或者字段的填充是否满足协议要求。 |
10007 | 权限不足，本 API 需 App 管理员或者群主调用。 |
10010 | 群组不存在，或者曾经存在过，但是目前已经被解散。 |
10015 | 群组 ID 非法，请检查群组 ID 是否填写正确。 |
