https://console.tim.qq.com/$ver/$servicename/$command?sdkappid=$SDKAppID&identifier=$identifier&usersig=$usersig&random=99999999&contenttype=json
Parameter | Meaning | Fetching Value |
https | Request protocol | The request protocol is HTTPS, and the request method is POST |
console.tim.qq.com | Request domain name | Fixed as console.tim.qq.com |
ver | Protocol version number | Fixed as v4 |
servicename | Internal service name, different service names correspond to different service types | Example: v4/room_engine_http_srv/create_room , where room_engine_http_srv is the servicename |
command | The word command , combined with the servicename , is used to indicate a specific business feature | Example: v4/room_engine_http_srv/create_room , where create_room is the command |
sdkappid | The application identifier accessed in the Chat console | Obtained when applying for integration |
identifier | username, must be an App Administrator Account when calling RESTful APIs | |
usersig | password corresponding to username | |
random | Identifies the random number parameter for the current request | 32-bit unsigned integer random number, ranging from 0 to 4294967295 |
contenttype | Request format | Fixed value: json |
{}
, must be included.{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"RequestId": "Id-70e312f1de024af5a36714b7b71da224-O-Seq-63504"// Other response content of REST API}
Field | Type | Description |
ActionStatus | String | The result of the request processing. OK for success, FAIL for failure. If it's FAIL, ErrorInfo will provide the reason for failure. |
ErrorInfo | String | Cause of failure |
ErrorCode | Integer | Error code. 0 for success, others for failure. You can refer to the Error Code Table for specific reasons. |
RequestId | String | Error code. 0 for success, others for failure. You can refer to the Error Code Table for specific reasons. |
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}
Error code | Description |
60002 | An error occurred when parsing the HTTP request. Check the format of the HTTP request URL. |
60003 | An error occurred when parsing the JSON data of the HTTP request. Check the JSON format. |
60004 | Account or signature in the request URL or JSON packet is incorrect. |
60005 | Account or signature in the request URL or JSON packet is incorrect. |
60006 | Invalid SDKAppID. Check the validity of the SDKAppID. |
60007 | The RESTful API call exceeds the frequency limit. Please reduce the request frequency. |
60008 | The service request timed out or the format of the HTTP request is incorrect. Please check and try again. |
60009 | Request resource error. Please check the request URL. |
60010 | The request requires App administrator permission. |
60011 | The SDKAppID request exceeds the frequency limit. Please reduce the request frequency. |
60012 | SDKAppID is required when calling the RESTful API. Check the SDKAppID in the request URL. |
60013 | An error occurred when parsing the JSON data in the HTTP response packet. |
60014 | Account switching timed out. |
60015 | The type of the account in the request packet is incorrect. Please ensure that the UserID is in string format. |
60016 | The SDKAppID is disabled. |
60017 | The request is disabled. |
60018 | Too many requests. Try again later. |
60019 | Too many requests. Try again later. |
60020 | Your professional edition plan has expired and been disabled, please log in to Chat Purchase Page to repurchase the plan. It will take effect 5 minutes after purchase. |
60021 | The source IP of the RESTful API call is invalid. |
telnet console.tim.qq.com 443
to confirm if the service port can be connected.curl -I https://console.tim.qq.com
to simply test if the status code is 200.
Was this page helpful?