无 UI 集成方案

服务端 API

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

功能说明

本接口用于将 App 自有帐号导入即时通信 IM 帐号系统,为该帐号创建一个对应的内部 ID,使该帐号能够使用即时通信 IM 服务。

注意:

同一个帐号重复导入仅会创建1个内部 ID。

以下视频将帮助您快速了解如何将 App 自有帐号导入即时通信 IM 帐号系统:

接口调用说明

请求 URL 示例

https://console.tim.qq.com/v4/im_open_login_svc/account_import?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介

参数 说明
v4/im_open_login_svc/account_import 请求接口
sdkappid 创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier 必须为 App 管理员帐号,更多详情请参见 App 管理员
usersig App 管理员帐号生成的签名,具体操作请参见 生成 UserSig
random 请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype 请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

{
   "UserID":"test",
   "Nick":"test",
   "FaceUrl":"http://www.qq.com"
}

请求包字段说明

字段 类型 属性 说明
UserID String 必填 用户名,长度不超过32字节
Nick String 选填 用户昵称
FaceUrl String 选填 用户头像 URL

应答包体示例

{
   "ActionStatus":"OK",
   "ErrorInfo":"",
   "ErrorCode":0
}

应答包字段说明

字段 类型 说明
ActionStatus String 请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode Integer 错误码,0表示成功,非0表示失败
ErrorInfo String 错误信息

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:

错误码 含义说明
40006 设置资料时服务器内部错误,请稍后重试
40601 资料字段的 Value 长度超过500字节
70169 服务端内部超时,请稍后重试
70398 帐号数超限。如需创建多于100个帐号,请将应用升级为专业版,具体操作指引请参见 购买指引
70402 参数非法,请检查必填字段是否填充,或者字段的填充是否满足协议要求
70403 请求失败,需要 App 管理员权限
70500 服务器内部错误,请稍后重试

接口调试工具

通过 REST API 在线调试 工具调试本接口。

参考

目录