After Official Account Is Subscribed

最終更新日:2024-06-18 16:10:05

Feature Overview
After subscribing to the Official Account, the app backend can use this webhook to view the subscription messages in real-time, including: Notification to the app backend when a member subscribes to the Official Account, allowing the app to perform necessary data synchronization.
Notes
To enable the webhook, you must configure the Webhook URL and toggle on the corresponding protocol. For more information on the configuration method, see Webhook Configuration.
During this webhook, the Chat backend initiates an HTTP POST request to the app backend.
After receiving the webhook request, the app backend must check whether the SDKAppID contained in the request URL is the SDKAppID of the app.
For additional safety-related concerns, please refer to the Webhook Overview: Security Considerations document.
Webhook Triggering Scenarios
App users subscribe to the Official Account through the client.
The app admin adds subscribers via the REST API.
Webhook Triggering Timing
After a user successfully subscribes to the Official Account.
API Calling Description
Sample request URL
In the subsequent example, the webhook URL configured within the app is https://www.example.com.
Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
Request parameters
Parameter
Description
https
The request protocol is HTTPS, and the request method is POST.
www.example.com
Webhook URL.
SdkAppid
SDKAppID assigned by the Chat console when an app is created.
CallbackCommand
Set to: OfficialAccount.CallbackAfterAddSubscriber.
contenttype
Fixed value: JSON.
ClientIP
Client IP, such as: 127.0.0.1.
OptPlatform
Client Platform, for values please refer to Webhook Overview: Webhook Protocol for the meaning of the OptPlatform parameter.
Sample request
 {
    "CallbackCommand": "OfficialAccount.CallbackAfterAddSubscriber",
    "Official_Account": "@TOA#_test_for_penn",
    "Operator_Account": "107867",
    "SubscribeAccountList": [
        {
            "Subscriber_Account": "jared"
        },
        {
            "Subscriber_Account": "leckie"
        }
    ],
    "EventTime": 1670574414123// Event trigger timestamp in milliseconds		
}
Request fields
Object
Features
Feature
CallbackCommand
String
Webhook command.
Official_Account
String
Official Account user ID of the subscription.
Operator_Account
String
Operator UserID who initiated the request.
SubscribeAccountList
Array
List of subscribers added.
EventTime
Integer
Event trigger timestamp in milliseconds.
Sample response
Following data synchronization, the app backend dispatches a webhook response packet.
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // Ignore response results
}
Response fields
Field
Type
Attribute
Description
ActionStatus
String
Mandatory
Processed Request Result:
OK: Indicates successful processing
FAIL: Indicates failure
ErrorCode
Integer
Mandatory
Error Code, 0 means response results can be ignored.
ErrorInfo
String
Mandatory
Error message.
References
﻿Webhook Overview﻿
REST API:Adding Subscribers﻿
﻿
﻿

tencent cloud

Recent Pages

After Official Account Is Subscribed

Feature Overview

Notes

Webhook Triggering Scenarios

Webhook Triggering Timing

API Calling Description

Sample request URL

Request parameters

Sample request

Request fields

Sample response

Response fields

References

この記事はお役に立ちましたか？

この記事はお役に立ちましたか？

Parameter	Description
https	The request protocol is HTTPS, and the request method is POST.
www.example.com	Webhook URL.
SdkAppid	SDKAppID assigned by the Chat console when an app is created.
CallbackCommand	Set to: OfficialAccount.CallbackAfterAddSubscriber.
contenttype	Fixed value: JSON.
ClientIP	Client IP, such as: 127.0.0.1.
OptPlatform	Client Platform, for values please refer to Webhook Overview: Webhook Protocol for the meaning of the OptPlatform parameter.

Object	Features	Feature
CallbackCommand	String	Webhook command.
Official_Account	String	Official Account user ID of the subscription.
Operator_Account	String	Operator UserID who initiated the request.
SubscribeAccountList	Array	List of subscribers added.
EventTime	Integer	Event trigger timestamp in milliseconds.

Field	Type	Attribute	Description
ActionStatus	String	Mandatory	Processed Request Result: OK: Indicates successful processing FAIL: Indicates failure
ErrorCode	Integer	Mandatory	Error Code, 0 means response results can be ignored.
ErrorInfo	String	Mandatory	Error message.

tencent cloud

サインアップ

ログイン

Recent Pages

After Official Account Is Subscribed

Feature Overview

Notes

Webhook Triggering Scenarios

Webhook Triggering Timing

API Calling Description

Sample request URL

Request parameters

Sample request

Request fields

Sample response

Response fields

References

この記事はお役に立ちましたか？

この記事はお役に立ちましたか？