Obtaining Official Channel Information
Feature Overview
This API is used by the app administrator to obtain relevant information of an official channel.
API Calling Description
Sample Request URL
https://xxxxxx/v4/official_account_open_http_svc/get_official_account_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The table below only lists the parameters modified when this API is called and their descriptions. For details on the parameters, refer to RESTful API Overview.
Parameter | Description |
xxxxxx | The dedicated domain name corresponding to the country/region of the SDKAppID: China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.com Frankfurt: adminapiger.im.qcloud.com Silicon Valley: adminapiusa.im.qcloud.com Jakarta: adminapiidn.im.qcloud.com |
v4/official_account_open_http_svc/get_official_account_info | Request API. |
sdkappid | The SDKAppID assigned by the Chat console when an application is created. |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | The value is always json . |
Maximum Call Frequency
200 times/second
Sample Request Packets
{"OfficialAccountIdList": [ // List of official channels requested, with a maximum of 50 official channels per pull{"Official_Account": "@TOA#_test_for_penn"},{"Official_Account": "@TOA#_@TOA#dZDP"}],"ResponseFilter": { // Filter fields"OfficialAccountBaseInfoFilter": [ // Filter fields for official channel information"CreateTime","Name","Owner_Account","LastMsgTime","SubscriberNum","Introduction","FaceUrl","Organization","CustomString"]}}
Request Fields
Field | Type | Required | Description |
OfficialAccountIdList | Array | Yes | List of official channel IDs requested. |
Official_Account | String | Yes | Official account ID requested. Use the OfficialAccountUserID field returned by the API during creation. |
ResponseFilter | Object | No | Filter fields for the returned official channel information. If not specified, all fields are returned by default, including the OfficialAccountBaseInfoFilter filter. The valid values include: CreateTime: creation time of the official channel Name: name of the official channel Owner_Account: user who owns the official channel LastMsgTime: time of the last message within the official channel SubscriberNum: current number of subscribers to the official channel Introduction: introduction to the official channel FaceUrl: avatar URL of the official channel Organization: organization of the official channel CustomString: custom field at the official channel level |
Sample Response Packets
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0, // This ErrorCode indicates the result of the entire request."OfficialAccountInfoList": [ // List of official channel information returned{"ErrorCode": 0, // This ErrorCode indicates the result of obtaining the official channel. 0 indicates success; other values indicate failure."ErrorInfo": "","Name": "test_modify_official_account3","Official_Account": "@TOA#_test_for_penn","CreateTime": 1696577604,"Owner_Account": "107867","LastMsgTime": 1699501664,"SubscriberNum": 780031,"Introduction": "test compare introduction","FaceUrl": "http://this.is.face.url1","Organization": "test compare organization","CustomString": "modify_custom_string"},{"ErrorCode": 0,"ErrorInfo": "","Name": "Test Environment Test Official Account","Official_Account": "@TOA#_@TOA#dZDP","CreateTime": 1694514910,"Owner_Account": "109635","LastMsgTime": 1698894911,"SubscriberNum": 1004,"Introduction": "waynezou","FaceUrl": "","Organization": "Tencent","CustomString": ""}]}
Response Fields
Field | Type | Description |
ActionStatus | String | Processing result: OK: succeeded. FAIL: failed. |
ErrorCode | Integer | Error code: 0: succeeded. Other values: failed. |
ErrorInfo | String | Error information. |
OfficialAccountInfoList | Array | The returned official channel list field. The results are filtered information based on the filter fields set in the filter. |
Error Codes
Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packets represent the actual error code and error information.
For common error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API:
Error Code | Description |
6017 | Invalid request parameter. Please modify and retry. |
10004 | Internal server error. Please try again. |
20001 | Invalid request packet. Please modify and retry. |
20005 | Internal server error. Please try again. |
130002 | Insufficient operation permissions. Please check the request parameters based on the error message. |
130004 | The official channel does not exist, or once existed but has now been terminated. |
130007 | Incorrect official channel ID. Please modify and retry. |
131000 | This AppId has not been enabled with official channel service. Please enable it and retry. |