이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.
Docs Overview/
Adding Subscribers/

Adding Subscribers

Feature Overview

The API is used by the app administrator to make a user subscribe to an official account and become a subscriber of the official account.

API Calling Description

Sample Request URL

https://xxxxxx/v4/official_account_open_http_svc/add_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/add_subscriber
Request API.
sdkappid
The SDKAppID assigned by the Chat console when an application is created.
identifier
The app admin account. For details, see App Admin.
usersig
The signature generated by the app admin account. For details, see Generating 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)
    "SubscriberList": [		// Up to 100 subscribers can be added at a time.
        {
            "Subscriber_Account": "107867"	// UserID of the subscriber to be added
        },
      	{
            "Subscriber_Account": "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": 2
        },
        {
            "Subscriber_Account": "966582476",
            "Result": 1		// Addition result. 0: failed; 1: succeeded; 2: already subscribed.
        }
    ]
}

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 added subscribers.
Subscriber_Account
String
Returned subscriber UserID.
Result
Integer
Addition result:
0: failed.
1: succeeded.
2: already followed 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.
130006
The number of subscribers for this official account has reached its limit. Please refer to Pricing to purchase or upgrade related packages and expand the maximum number of subscribers for the official account. (After upgrading, you need to call the Modifying Official Account Information API to update the maximum number of subscribers supported.)
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.
130010
The number of official accounts a subscriber can join has exceeded the limit. Please check and unsubscribe from some official accounts.

References

Creating Official Accounts
Deleting Subscribers

Possibly Triggered Callbacks

Before an Official Account Is Subscribed To
After an Official Account Is Subscribed To
When the Official Account's Subscription Limit is Reached