功能说明
该 API 接口的作用是导入群组成员,不会触发回调、不会下发通知。
当 App 需要从其他即时通信系统迁移到即时通信 IM 时,使用该协议导入存量群成员数据。
接口调用说明
适用的群组类型
群组类型 | 支持此 REST API |
Private | 支持,同新版本中的 Work(好友工作群) |
Public | 支持 |
ChatRoom | 支持,同新版本中的 Meeting(会议群) |
AVChatRoom | 不支持 |
Community(社群) | 支持 |
说明
AVChatRoom(直播群)所适用的场景一般不需要导入成员,因此不支持导入群成员功能,对此类型的群组进行操作时会返回10007错误。
请求 URL 示例
https://xxxxxx/v4/group_open_http_svc/import_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 硅谷: adminapiusa.im.qcloud.com 雅加达: adminapiidn.im.qcloud.com |
v4/group_open_http_svc/import_group_member | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
用来向群中导入成员,一次请求最多支持添加100个成员;使用本接口设置的未读消息数如果大于群当前的消息数,未读消息数会设为群当前的消息总数。
注意
请保证导入成员的入群时间大于群的创建时间并小于当前时间,否则该成员会导入失败。
{"GroupId": "@TGS#2J4SZEAEL", // 要操作的群组(必填)"MemberList": [ // 一次最多添加100个成员{"Member_Account": "tommy", // 要添加的群成员 ID(必填)"Role":"Admin", // 导入成员的角色,目前只有 Admin(可选)"JoinTime":1448357837, // 导入的成员入群时间(选填)"UnreadMsgNum":5 // 该成员的未读消息数(选填)},{"Member_Account": "jared","JoinTime":1448357857,"UnreadMsgNum":2}]}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
GroupId | String | 必填 | 操作的群 ID |
MemberList | Array | 必填 | 待添加的群成员数组 |
Member_Account | String | 必填 | 待导入的群成员账号 |
Role | String | 选填 | 待导入群成员角色;目前只支持填 Admin,不填则为普通成员 Member |
JoinTime | Integer | 选填 | 待导入群成员的入群时间,JoinTime 的时间需要大于群资料的建群时间,并且小于当前时间戳,否则会因为不合理导致响应的 Result 字段会为0。 |
UnreadMsgNum | Integer | 选填 | 待导入群成员的未读消息计数 |
应答包体示例
{"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 | 返回的群成员账号 |
Result | Integer | 导入结果: 0:表示失败 1:表示成功 2:表示已经是群成员 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为 200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码 | 描述 |
10002 | 服务器内部错误,请重试 |
10003 | 请求命令字非法 |
10004 | 参数非法,请根据错误描述检查请求是否正确 |
10005 | 请求包体中携带的账号数量过多 |
10006 | 操作频率限制,请尝试降低调用的频率 |
10007 | 操作权限不足,例如 Public 群组中普通成员尝试执行踢人操作,但只有 App 管理员才有权限 |
10010 | 群组不存在,或者曾经存在过,但是目前已经被解散 |
10015 | 群组 ID 非法,请检查群组 ID 是否填写正确 |