tencent cloud

RESTful APIs are HTTP management APIs that provide the app backend with a management entry. For more information about RESTful APIs that Chat supports, see RESTful API List.
In addition to RESTful APIs, the app console also supports simple data management and one-to-one/group messaging. Developers can manage, check, and test data in the console. Even though RESTful APIs are less user-friendly, they provide powerful management capabilities.
For security concerns, RESTful APIs are supported over HTTPS only.

Prerequisites

Before you call a RESTful API, complete the following operations:

1. Create an app in the Chat console. For more information, see Creating and Upgrading an Application.
2. Assign an admin account to the app. For more information, see the Configuring Account Admins section in Basic Configuration.

Note：

To avoid unnecessary call errors, use the admin account to call a RESTful API.

Calling Method

Request URL

The URL format of a RESTful API is as follows:

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

The descriptions and values ​​of parameters are as follows (parameter names and parameter values ​​are case-sensitive):

Note：

• When the app server calls a RESTful API, identifier must be the app admin account.
• The app can generate a UserSig for the admin account each time it calls a RESTful API or generate a fixed UserSig for reuse with period of validity.

HTTP request body format

RESTful APIs only support the POST method, and its request body is in JSON format. For more information about the request body format, see the detailed description of each API.
Note that POST request bodies cannot be empty. Even when no information is required in a request body, the request body still needs to carry an empty JSON object ({}).

HTTP return code

The returned HTTP status code for RESTful APIs is always 200 unless a network error (such as error 502) occurs. The specific error code and error message are included in the HTTP response body.

HTTP response body format

The RESTful API response body is in the JSON format and has the following elements:

{
    "ActionStatus": "OK", 
    "ErrorInfo": "", 
    "ErrorCode": 0
    // Other RESTful API response content
}

The response body must contain the ActionStatus, ErrorInfo, and ErrorCode fields. These three fields are described as follows:

Sample Call

The following example shows how to use the RESTful API to get all groups in an app.

HTTPS request:

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 response:

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
}

RESTful API Common Error Codes

FAQs

The RESTful API request timed out and no response was received.

1. The timeout period specified for the RESTful API in the Chat backend is three seconds. You need to specify a timeout period that is longer than three seconds.
2. Run telnet console.tim.qq.com 443 to check whether the service port is accessible.
3. Run curl -I https://console.tim.qq.com to check whether the status code is 200.
4. Check whether the machine uses a private or public DNS server. If the machine uses a private DNS server, make sure that the DNS server egress is in the same region as the ISP to which the egress IP of the machine belongs.
5. You are advised to use the "persistent connection+connection pool" mode.

   Note：

   It is recommended that you use a RESTful API persistent connection to connect to the SDK. The reason is that it takes a long time to establish HTTPS non-persistent connections because each request causes TCP+TLS handshake overhead.
   For scenario where a standard HTTP library is used: for HTTP 1.0, the request header Connection: keep-alive needs to be specified; for HTTP 1.1, persistent connections are supported by default; for scenarios where HTTPS requests are encapsulated based on TCP, TCP connections can be reused to send and receive requests.