Obtaining Subscriber Information of Official Accounts
Feature Overview
This API is used by the app administrator to obtain the information of all users subscribing to a specific official account.
API Calling Description
Sample Request URL
https://xxxxxx/v4/official_account_open_http_svc/get_subscriber_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_subscriber_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
{ "Official_Account": "@TOA#_test_for_penn","Limit": 50,"Next": ""}
Request Fields
Field | Type | Required | Description |
Official_Account | String | Yes | Official account ID requested. Use the OfficialAccountUserID field returned by the API during creation. |
Limit | Integer | No | The maximum number of members' information that can be obtained at one time, not to exceed 200. If not specified, the information of all members in the group will be obtained. |
Next | String | Yes | The position of the subscriber last pulled. For the first call, fill in ""; for subsequent pulls, use the Next value returned in the response. |
Sample Response Packets
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"Next": "TGSOTk=", // The marker for the subsequent pull. If not empty, input in the Next field for the next request."SubscriberNum": 780031, // Total number of subscribers to this official account"SubscriberList": [{"Subscriber_Account": "millaccount13356", // Subscriber account"SubscribeTime": 1698821747, // Time of subscription"CustomString": "", // Custom field at the subscriber level"MsgFlag": "AcceptAndNotify", // The message receiving option for subscribers, similar to the message receiving option for group members"LastSendMsgTime": 0 // Time of the last message sent},{"Subscriber_Account": "millaccount13100","SubscribeTime": 1698821690,"CustomString": "","MsgFlag": "AcceptAndNotify","LastSendMsgTime": 0}// The rest of the subscriber information is omitted below.]}
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. |
Next | String | The marker for the subsequent pull. The server response packet returns Next as "" for the last pull, indicating there is no subsequent subscriber information, and the client should end the query. |
SubscriberNum | Integer | Returns the number of all subscribers under the official account. |
SubscriberList | Array | Returned subscriber list, including the following information: Subscriber_Account: subscriber account SubscribeTime: time of subscription CustomString: custom field at the subscriber level MsgFlag: the message receiving option for subscribers, similar to the message receiving option for group members LastSendMsgTime: time of the last message sent |
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. |
130007 | Incorrect official account user ID. Please modify and retry. |
130008 | The official account user ID is already in use. Please modify and retry. |
131000 | This AppId has not been enabled with official account service. Please enable it and retry. |
130010 | The number of created official accounts exceeds the limit. Please dissolve some official accounts or upgrade the service. |
References