Deleting Subscribers
Feature Overview
This API is used by the app administrator to make a user unsubscribe from an official account and be removed from the list of subscribers.
API Calling Description
Sample Request URL
https://xxxxxx/v4/official_account_open_http_svc/delete_subscriber?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/delete_subscriber | 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#_@TOA#dOEF", // The desired official account (required)"SubscriberToDel_Account": [ ////UserID of the subscriber to be deleted"107867","966582476"]}
Request Fields
Field | Type | Required | Description |
Official_Account | String | Yes | ID of the official account to be subscribed to. Use the OfficialAccountUserID field returned by the API during creation. |
SubscriberList | Array | Yes | Array of subscribers to be added. |
Subscriber_Account | String | Yes | UserID of the subscriber to be added. |
Sample Response Packets
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"SubscriberList": [{"Subscriber_Account": "107867","Result": 1},{"Subscriber_Account": "966582476","Result": 1}]}
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. |
SubscriberList | Array | Returned results of deleted subscribers. |
Subscriber_Account | String | Returned subscriber UserID. |
Result | Integer | Deletion result: 0: failed. 1: succeeded. 2: not subscribed to this official account. |
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 account user does not exist, or once existed but has now been terminated. |
130007 | Incorrect official account user ID. Please modify and retry. |
130008 | The official account user ID is already in use. |
131000 | This AppId has not been enabled with official account service. |
References
Possibly Triggered Callbacks