https://xxxxxx/$ver/$servicename/$command?sdkappid=$SDKAppID&identifier=$identifier&usersig=$usersig&random=99999999&contenttype=json
参数 | 含义 | 取值 |
https | 请求协议 | 请求协议为 HTTPS,请求方式为 POST |
xxxxxx | 域名。 当域名dns被运营商劫持,可使用备域名。 | 中国:console.tim.qq.com,备域名 adminapi.my-imcloud.com 新加坡:adminapisgp.im.qcloud.com,备域名 adminapisgp.my-imcloud.com 首尔:adminapikr.im.qcloud.com,备域名 adminapikr.my-imcloud.com 法兰克福:adminapiger.im.qcloud.com,备域名 adminapiger.my-imcloud.com 硅谷:adminapiusa.im.qcloud.com,备域名 adminapiusa.my-imcloud.com 雅加达:adminapiidn.im.qcloud.com,备域名 adminapiidn.my-imcloud.com |
ver | 协议版本号 | 固定为 v4 |
servicename | 内部服务名,不同的 servicename 对应不同的服务类型 | 示例: v4/im_open_login_svc/account_import ,其中im_open_login_svc 为servicename |
command | 命令字,与 servicename 组合用来标识具体的业务功能 | 示例: v4/im_open_login_svc/account_import ,其中account_import 为command |
sdkappid | App 在即时通信 IM 控制台获取的应用标识 | 在申请接入时获得 |
identifier | 用户名,调用 REST API 时必须为 App 管理员账号 | |
usersig | 用户名对应的密码 | 参见 生成 UserSig |
random | 标识当前请求的随机数参数 | 32位无符号整数随机数,取值范围0 - 4294967295 |
contenttype | 请求格式 | 固定值为 json |
{}
。{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0// REST API 其他应答内容}
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败,如果为 FAIL,ErrorInfo 带上失败原因 |
ErrorInfo | String | 失败原因 |
ErrorCode | Integer |
POST /v4/group_open_http_svc/get_appid_group_list?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json HTTP/1.1Host: console.tim.qq.comContent-Length: 22{"Limit": 2}
HTTP/1.1 200 OKServer: nginx/1.7.10Date: Fri, 09 Oct 2015 02:59:55 GMTContent-Length: 156Connection: keep-aliveAccess-Control-Allow-Origin: *Access-Control-Allow-Headers: X-Requested-WithAccess-Control-Allow-Methods: POST{"ActionStatus": "OK","ErrorCode": 0,"GroupIdList": [{"GroupId": "@TGS#1YTTZEAEG"},{"GroupId": "@TGS#1KVTZEAEZ"}],"TotalCount": 58530}
错误码 | 含义说明 |
60002 | HTTP 解析错误 ,请检查 HTTP 请求 URL 格式 |
60003 | HTTP 请求 JSON 解析错误,请检查 JSON 格式 |
60004 | 请求 URL 或 JSON 包体中账号或签名错误 |
60005 | 请求 URL 或 JSON 包体中账号或签名错误 |
60006 | SDKAppID 失效,请核对 SDKAppID 有效性 |
60007 | REST 接口调用频率超过限制,请降低请求频率 |
60008 | 服务请求超时或 HTTP 请求格式错误,请检查并重试 |
60009 | 请求资源错误,请检查请求 URL |
60010 | 请求需要 App 管理员权限 |
60011 | SDKAppID 请求频率超限,请降低请求频率 |
60012 | REST 接口需要带 SDKAppID,请检查请求 URL 中的 SDKAppID |
60013 | HTTP 响应包 JSON 解析错误 |
60014 | 置换账号超时 |
60015 | 请求包体账号类型错误,请确认账号为字符串格式 |
60016 | SDKAppID 被禁用。 |
60017 | 请求被禁用。 |
60018 | 请求过于频繁,请稍后重试。 |
60019 | 请求过于频繁,请稍后重试。 |
60020 | |
60021 | RestAPI 调用来源 IP 非法。 |
本页内容是否解决了您的问题?