- 제품 소개
- 구매 가이드
- 다운로드 센터
- 시나리오 솔루션
- 클라이언트 APIs
- 서버 APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- 그룹 생성 전 콜백
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- 그룹 내 발언 전 콜백
- 그룹 내 발언 후 콜백
- 그룹 만원 후 콜백
- After a Group Is Disbanded
- 그룹 정보 변경 후 콜백
- 그룹 메시지 회수 후 콜백
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- 토픽 생성 전 콜백
- 토픽 생성 후 콜백
- 토픽 해산 후 콜백
- 토픽 프로필 수정 후 콜백
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- 콘솔 가이드
- FAQ
- 협약 및 인증
- IM 정책
- 에러 코드
- 문의하기
- 제품 소개
- 구매 가이드
- 다운로드 센터
- 시나리오 솔루션
- 클라이언트 APIs
- 서버 APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- 그룹 생성 전 콜백
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- 그룹 내 발언 전 콜백
- 그룹 내 발언 후 콜백
- 그룹 만원 후 콜백
- After a Group Is Disbanded
- 그룹 정보 변경 후 콜백
- 그룹 메시지 회수 후 콜백
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- 토픽 생성 전 콜백
- 토픽 생성 후 콜백
- 토픽 해산 후 콜백
- 토픽 프로필 수정 후 콜백
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- 콘솔 가이드
- FAQ
- 협약 및 인증
- IM 정책
- 에러 코드
- 문의하기
Feature Overview
The app backend can use this webhook to view in real time the activity of users unsubscribing from the official account, including: real-time recording of user unsubscriptions (e.g., logging or synchronization with other systems).
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 unsubscribe from the official account through the client.
App administrators delete subscribers through REST API.
Webhook Triggering Timing
After a user successfully unsubscribes from an 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 | Fixed as: OfficialAccount.CallbackAfterDeleteSubscriber. |
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.CallbackAfterDeleteSubscriber", // Webhook command"Official_Account" : "@TOA#_test_OA_for_penn","Operator_Account": "leckie", // Operator"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 who unsubscribed. |
Operator_Account | String | Operator UserID who initiated the request. |
SubscribeAccountList | Array | List of users who unsubscribed. |
EventTime | Integer | Event trigger timestamp in milliseconds. |
Sample response
A response is returned after the app backend synchronizes the data.
{"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
REST API:Delete Subscriber
예
아니오
문제 해결에 도움이 되었나요?