PDF《云通信》

identifier=$identi fier&

usersig=$usersig&

random=99999999&

contenttype=json 其中各个参数的含义以及取值如下(参数名称及其取值均区分大小写): 参数 含义 取值 https 请求协议 请求协议为 HTTPS,请求方式为 POST console.tim.qq.com 请求域名 固定为 console.tim.qq.com REST API REST API 简介 最近更新时间:2019-06-19 10:12:27 注意: 调用 REST API 时请务必使用 App 管理员帐号,否则会导致不必要的调用错误. 云通信 版权所有:腾讯云计算(北京)有限责任公司 第13 共348页 参数 含义 取值 ver 协议版本号 固定为 v4 servicename 内部服务名,不同的 servicename 对应不同的服 务类型 示例: v4/im_open_login_svc/account_import , 其中 im_open_login_svc 为servicename 更多详情请参见 REST API 接口列表 command 命令字,与servicename 组 合用来标识具体的业务功能 示例: v4/im_open_login_svc/account_import , 其中 account_import 为command 更多详情请参见 REST API 接口列表 sdkappid App 在云通信 IM 控制台获 取的应用标识 在申请接入时获得 identifier 用户名,调用 REST API 时必 须为 App 管理员帐号 参见 App 管理员 usersig 用户名对应的密码 参见 生成 UserSig random 标识当前请求的随机数参数 32位无符号整数随机数 contenttype 请求格式 固定值为 JSON HTTP 请求包体格式 REST API 仅支持 POST 方法,其请求包体为 JSON 格式,具体的包体格式参见每个 API 的详细描述. 需要特别注意的是,POST 包体不能为空,即使某条协议包体中不需要携带任何信息,也需要携带一个空的 JSON 对象,即{} . HTTP 返回码 除非发生网络错误(例如502错误),否则 REST API 的调用结果均为200,真正的 API 调用错误码与错误信息在 HTTP 应答包体中返回. HTTP 应答包体格式 注意: 1. App 服务端在调用 REST API 时,identifier 必须为 App 管理员帐号. 2. App 可以在每次调用 REST API 时都生成管理员帐号的 usersig,亦可生成一个固定的 usersig 重复使用, 但请特别注意 usersig 的有效期. 云通信 版权所有:腾讯云计算(北京)有限责任公司 第14 共348页REST API 的应答包体也是 JSON 格式,其格式符合如下特征: { ActionStatus : OK , ErrorInfo : , ErrorCode :

0 // REST API 其他应答内容 } 应答包体中必然包含 ActionStatus、ErrorInfo、ErrorCode 这三个属性,其含义如下: 字段 类型 说明 ActionStatus String 请求处理的结果,OK 表示处理成功,FAIL 表示失败,如果为 FAIL,ErrorInfo 带上失败原因 ErrorInfo String 失败原因 ErrorCode Integer 错误码,0为成功,其他为失败,可查询 错误码表 得到具体的原因 调用示例 以下为通过 REST API 来 获取 App 中所有群组 示例. HTTPS 请求: POST /v4/group_open_http_svc/get_appid_group_list?usersig=xxx&

identifier=admin&

sdkappid=8888 8888&

random=99999999&

contenttype=json HTTP/1.1 Host: console.tim.qq.com Content-Length:

22 { Limit :

2 } HTTPS应答: HTTP/1.1

200 OK Server: nginx/1.7.10 Date: Fri,

09 Oct

2015 02:59:55 GMT Content-Length:

156 Connection: keep-alive Access-Control-Allow-Origin: * Access-Control-Allow-Headers: X-Requested-With 云通信 版权所有:腾讯云计算(北京)有限责任公司 第15 共348页Access-Control-Allow-Methods: POST { ActionStatus : OK , ErrorCode : 0, GroupIdList : [ { GroupId : @TGS#1YTTZEAEG }, { GroupId : @TGS#1KVTZEAEZ } ], TotalCount :

58530 } REST API 公共错误码 错误码 含义说明