tencent cloud

REST API 是即时通信 IM 提供给 App 后台的 HTTP 管理接口，其主要目的在于为 App 后台提供一个后台管理入口。目前即时通信 IM 支持的 REST API 请参见 REST API 接口列表。
除了 REST API，App 控制台也可实现简单的数据管理、单发/群发消息，开发者可以在控制台进行简单的数据管理、查看及测试。相比之下，REST API 接口较为原始，但管理能力却更为强大。
为了安全性，REST API 仅提供 HTTPS 接口。

前提条件

要调用 REST API，您必须已完成：

1. 在即时通信 IM 控制台创建 App，具体方法参见 应用接入指引。
2. 为您的 App 指定管理员帐号，具体方法参见 基础配置 的帐号体系集成。

注意：

调用 REST API 时请务必使用 App 管理员帐号，否则会导致不必要的调用错误。

调用方法

请求 URL

REST API 的 URL 格式如下：

https://xxxxxx/$ver/$servicename/$command?sdkappid=$SDKAppID&identifier=$identifier&usersig=$usersig&random=99999999&contenttype=json

其中各个参数的含义以及取值如下（参数名称及其取值均区分大小写）：

注意：

• App 服务端在调用 REST API 时，identifier 必须为 App 管理员帐号。
• App 可以在每次调用 REST API 时都生成管理员帐号的 UserSig，亦可生成一个固定的 UserSig 重复使用，但请特别注意 UserSig 的有效期。

HTTP 请求包体格式

REST API 仅支持 POST 方法，其请求包体为 JSON 格式，具体的包体格式参见每个 API 的详细描述。
需要特别注意的是，POST 包体不能为空，即使某条协议包体中不需要携带任何信息，也需要携带一个空的 JSON 对象，即{}。

HTTP 返回码

除非发生网络错误（例如502错误），否则 REST API 的调用结果均为200，真正的 API 调用错误码与错误信息在 HTTP 应答包体中返回。

HTTP 应答包体格式

REST API 的应答包体也是 JSON 格式，其格式符合如下特征：

{
    "ActionStatus": "OK", 
    "ErrorInfo": "", 
    "ErrorCode": 0
    // REST API 其他应答内容
}

应答包体中必然包含 ActionStatus、ErrorInfo、ErrorCode 这三个属性，其含义如下：

调用示例

以下为通过 REST API 来 获取 App 中所有群组 示例。

HTTPS 请求：

POST /v4/group_open_http_svc/get_appid_group_list?usersig=xxx&identifier=admin&sdkappid=88888888&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
Access-Control-Allow-Methods: POST

{
    "ActionStatus": "OK", 
    "ErrorCode": 0, 
    "GroupIdList": [
        {
            "GroupId": "@TGS#1YTTZEAEG"
        }, 
        {
            "GroupId": "@TGS#1KVTZEAEZ"
        }
    ], 
    "TotalCount": 58530
}

REST API 公共错误码

FAQ

REST API 请求有概率超时，收不到任何响应

1. 即时通信 IM 后台 REST 接口设置的超时时间是 3s，调用方设置的超时时间应该长于 3s。
2. telnet console.tim.qq.com 443 确认能否连接服务端口。
3. 使用 curl -I https://console.tim.qq.com 简单测试看状态码是否为200。
4. 确认机器的 dns server 配置是内网 dns server，还是公共 dns server。如果是内网 dns server，请确保 dns server 网络出口和本机器网络出口 IP 所在地域运营商一致。
5. 建议业务调用方使用“长连接+连接池”模式。

   说明：

   由于 HTTPS 短连接建连耗时比较大，每次请求都有TCP + tls 握手开销，所以建议 REST API 长连接接入。
   使用标准 HTTP 库的场景：HTTP1.0 需要指定请求头部 Connection: keep-alive，HTTP1.1 默认支持长连接；基于 TCP 封装 HTTPS 请求的场景，可以复用 TCP 连接来收发请求。