功能说明
本接口用于批量将 App 自有账号导入即时通信 IM 账号系统,为该账号创建一个对应的内部 ID,使该账号能够使用即时通信 IM 服务。
说明
本接口单次最多支持导入100个账号,同一个账号重复导入仅会创建1个内部 ID。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/im_open_login_svc/multiaccount_import?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/im_open_login_svc/multiaccount_import | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
100次/秒。
老版本请求包示例
{"Accounts": ["UserID_001","UserID_002","UserID_003"]}
老版本请求包字段说明
字段 | 类型 | 属性 | 说明 |
Accounts | Array | 必填 | 用户名列表,单个用户名长度不超过32字节,单次最多导入100个用户名 |
新版本请求包示例
{"AccountList": [{"UserID": "UserID_001","Nick": "Nick_001","FaceUrl": "http://www.qq.com"},{"UserID": "UserID_002","Nick": "Nick_002","FaceUrl": "http://www.qq.com"},{"UserID": "UserID_002","Nick": "Nick_001","FaceUrl": "http://www.qq.com"}]}
新版本请求包字段说明
应答包体示例
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "","FailAccounts": ["UserID_002","UserID_003"]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果 OK 表示处理成功 FAIL 表示失败 |
ErrorCode | Integer | 错误码 0表示成功 非0表示失败 |
ErrorInfo | String | 错误信息 |
FailAccounts | Array | 导入失败的账号列表 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码 | 含义说明 |
40006 | 设置资料时服务器内部错误,请稍后重试 |
40601 | 资料字段的 Value 长度超过500字节 |
70169 | 服务端内部超时,请稍后重试 |
70202 | 服务端内部超时,请稍后重试 |
70398 | |
70399 | 非 IM 体验版应用,账号被删除后,三个月内不允许重新导入 |
70402 | 参数非法,请检查必填字段是否填充,或者字段的填充是否满足协议要求 |
70403 | 请求失败,需要 App 管理员权限 |
70500 | 服务器内部错误,请稍后重试 |
接口调试工具
参考
失效账号登录态(v4/im_open_login_svc/kick)
查询账号在线状态( v4/openim/query_online_status)