- 动态与公告
- 产品简介
- 购买指南
- 体验 Demo
- 下载中心
- 快速入门
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 客服场景
- 智能机器人
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
- 动态与公告
- 产品简介
- 购买指南
- 体验 Demo
- 下载中心
- 快速入门
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 客服场景
- 智能机器人
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
功能说明
App 管理员可以通过该接口向指定的群中添加新成员。
接口调用说明
适用的群组类型
群组类型 | 支持此 REST API |
Private | 支持，同新版本中的Work(好友工作群) |
Public | 支持 |
ChatRoom | 支持，同新版本中的Meeting(会议群) |
AVChatRoom | 不支持 |
Community（社群） | 支持 |
注意
AVChatRoom（直播群）不支持增加群成员，对此类型群组进行操作时会返回10007错误。用户加入此类型群组的唯一方式是用户申请加群。
请求 URL 示例
https://xxxxxx/v4/group_open_http_svc/add_group_member?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com首尔： adminapikr.im.qcloud.com法兰克福： adminapiger.im.qcloud.com孟买： adminapiind.im.qcloud.com硅谷： adminapiusa.im.qcloud.com雅加达： adminapiidn.im.qcloud.com |
v4/group_open_http_svc/add_group_member | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
基础形式。
用来向群中进行邀请加人，一次请求最多支持添加300个成员。后台默认情况下会给群中所有成员下发加群系统通知，不包括没有激活的 Private 类型（即新版本中的 Work，好友工作群）群组外。
{"GroupId": "@TGS#2J4SZEAEL", // 要操作的群组（必填）"MemberList": [ // 一次最多添加300个成员{"Member_Account": "tommy" // 要添加的群成员ID（必填）},{"Member_Account": "jared"}]}
静默加人。
当 Silence 为 1 时，成员添加成功后，不会给任何人下发系统通知。
{"GroupId": "@TGS#2J4SZEAEL", // 要操作的群组（必填）"Silence": 1, // 是否静默加人（选填）"MemberList": [ // 一次最多添加300个成员{"Member_Account": "tommy" // 要添加的群成员 ID（必填）},{"Member_Account": "jared"}]}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
GroupId | String | 必填 | 操作的群 ID |
Silence | Integer | 选填 | 是否静默加人。0：非静默加人；1：静默加人。不填该字段默认为0 |
MemberList | Array | 必填 | 待添加的群成员数组 |
Member_Account | String | 必填 | 待添加的群成员 UserID |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"MemberList": [{"Member_Account": "tommy","Result": 1 // 加人结果：0 为失败；1 为成功；2 为已经是群成员},{"Member_Account": "jared","Result": 1}]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果，OK 表示处理成功，FAIL 表示失败 |
ErrorCode | Integer | 错误码，0表示成功，非0表示失败 |
ErrorInfo | String | 错误信息 |
MemberList | Array | 返回添加的群成员结果 |
Member_Account | String | 返回的群成员 UserID |
Result | Integer | 加人结果：0-失败；1-成功；2-已经是群成员；3-等待被邀请者或者管理员审核 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下：
错误码 | 含义说明 |
10002 | 服务器内部错误，请重试 |
10003 | 请求命令字非法 |
10004 | 参数非法，请根据错误描述检查请求是否正确 |
10005 | 请求包体中携带的 Member_Account 数量超过300 |
10007 | 操作权限不足，请确认该群组类型是否支持邀请加群。例如 AVChatRoom 和 BChatRoom 不允许任何人拉人入群 |
10014 | |
10010 | 群组不存在，或者曾经存在过，但是目前已经被解散 |
10015 | 群组 ID 非法，请检查群组 ID 是否填写正确 |
10016 | 开发者后台通过第三方回调拒绝本次操作 |
10019 | 请求的 UserID 不存在，请检查 MemberList 中的所有 Member_Account 是否正确 |
10026 | 该 SDKAppID 请求的命令字已被禁用，请联系客服 |
10037 | 被邀请的成员加入群组数量超过了限制，请检查并删除群组数量超过限制的 Member_Account 或者按实际需要【购买升级】。跳转到 功能 |
是
否
本页内容是否解决了您的问题？