https://xxxxxx/v4/official_account_open_http_svc/get_subscribed_official_account_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
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_subscribed_official_account_list | 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 . |
{"Subscriber_Account": "107867", //Subscriber"Limit": 200,"Offset": 0,"ResponseFilter":{ //Filter fields"OfficialAccountBaseInfoFilter":[ //Filter fields for official account information"CreateTime","Name","Owner_Account","LastMsgTime","SubscriberNum","Introduction","FaceUrl","Organization","CustomString"],"SelfInfoFilter":[ //Filter fields for subscriber information"SubscribeTime","CustomString"]}}
Field | Type | Required | Description |
Subscriber_Account | String | Yes | ID of the subscriber whose information is to be modified. |
Limit | Integer | No | Number of official accounts pulled in a single pull, currently supporting a maximum value of 200. If not specified, the default is 200. |
Offset | Integer | No | Indicates starting pulling from which official account. |
ResponseFilter | Object | No | Includes two filters: OfficialAccountBaseInfoFilter and SelfInfoFilter. OfficialAccountBaseInfoFilter: Indicates the basic information fields of official accounts to be pulled, mainly including: CreateTime: creation time of the official account Name: name of the official account Owner_Account: user who owns the official account LastMsgTime: time of the last message within the official account SubscriberNum: current number of subscribers to the official account Introduction: introduction to the official account FaceUrl: avatar URL of the official account Organization: organization of the official account CustomString: custom field at the official account level If not specified, all fields will be pulled. SelfInfoFilter: Indicates the need to pull subscriber's own information, mainly including: SubscribeTime: time when the subscriber subscribed to the official account CustomString: custom field at the subscriber level If not specified, all fields will be pulled. |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"TotalCount": 8, //The total number of subscribed official accounts, unrelated to the pull limit"OfficialAccountInfoList": [ //List of official accounts returned{"Name": "test_mill_subscriber_OA","Official_Account": "@TOA#_test_mill_subscriber_OA","Owner_Account": "107867","LastMsgTime": 1698894911,"SubscriberNum": 499800,"Introduction": "This is test Introduction","FaceUrl": "http://this.is.face.url","Organization": "Tencent","CustomString": "test_custom_string","SelfInfo": {"SubscribeTime": 1700655351,"CustomString": ""}//...There might be a lot more information to follow, but here information of only one official account is displayed.],"CompleteFlag": 1, //Indicates whether the pull has ended. 1 means it has ended; 0 means it has not ended."Next": 0 //If the pull has ended, returns 0.}
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 official account information obtained. The results are filtered information based on the filter fields set in the filter. |
TotalCount | Integer | Number of official accounts subscribed by the user. |
CompleteFlag | Integer | Indicates whether the pull has ended. 1: The pull has ended. 0: The pull has not ended. |
Next | Integer | Indicates the next pull. If the current pull has not ended, it can be filled in the offset of the next pull as the offset for pagination. |
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 account user does not exist, or once existed but has now been terminated. |
130007 | Incorrect official account user ID. Please modify and retry. |
131000 | This AppId has not been enabled with official account service. |
Was this page helpful?