製品の説明

製品の概要

Basic Concepts

ユースケース

機能概要

アカウントシステム

ユーザープロフィールとリレーションシップチェーン

メッセージ管理

グループシステム

Official Account

Audio/Video Call

使用制限

購入ガイド

課金概要

価格説明

Purchase Instructions

Renewal Guide

支払い延滞説明

Refund Policy

ダウンロードセンター

SDK & Demo ソースコード

更新ログ

シナリオプラン

Live Streaming Setup Guide

AI Chatbot

極めて大規模なエンターテインメントコラボレーションコミュニティ

Discord実装ガイド

ゲーム内IM統合ガイド

WhatsApp Channel-style Official Account Integration Solution

Send Red Packet

Firewall Restrictions

クライアントAPIs

SDK API（Web）

Android

iOS & macOS

Swift

Flutter

SDK API（Electron）

SDK APIs (Unity)

SDK API（React Native）

C APIs

C++

サービス側 APIs

UserSigの生成

RESTful APIs

Webhooks

コンソールガイド

New Console Introduction

アプリケーションの作成とアップグレード

基本設定

機能設定

アカウント管理

グループ管理

Official Channel Management

コールバック設定

監視ダッシュボード

Viewing Guide for Resource Packages

Real-Time Monitor

補助ツールの開発

アクセス管理

Advanced Features

よくあるご質問

uni-app FAQs

購入に関する質問

SDKに関する質問

アカウント認証に関する質問

ユーザープロファイルとリレーションシップチェーンに関する質問

メッセージに関する質問

グループに関する質問

ライブ配信グループに関する質問

ニックネームプロフィール画像に関連した問題

一般的なリファレンス

Service Level Agreement

セキュリティコンプライアンス認証

IM ポリシー

プライバシーポリシー

データプライバシーとセキュリティ契約

エラーコード

お問い合わせ

Before Official Channel Is Subscribed

PDF

フォーカスモード

フォントサイズ

最終更新日: 2025-05-27 10:18:15

Feature Overview
This webhook event allows the app backend to check user subscription requests to the Official Channel in real time, including the capability for the backend to intercept such requests.
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 Channel through the client.
The app admin adds subscribers via the REST API.
Webhook Triggering Timing
Before a user subscribes to the Official Channel.
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 to: OfficialAccount.CallbackBeforeAddSubscriber.
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.CallbackBeforeAddSubscriber",
    "Official_Account": "@TOA#_test_for_penn",
    "Operator_Account": "107867",
    "SubscribeAccountList": [
        {
            "Subscriber_Account": "jared"
        },
        {
            "Subscriber_Account": "leckie"
        }
    ],
    "EventTime": 1670574414123// Millisecond level, event trigger timestamp		
}
Request fields
Object
Features
Feature
CallbackCommand
String
Webhook command.
Official_Account
String
Official Channel 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
Allow all users to follow the Official Channel
The App backend agrees to let all users in all requests follow the Official Channel.
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 
}
Block certain users from subscribing to the Official Channel
The App backend rejects some users in the request from subscribing to the Official Channel and returns these Identifiers in RefusedMembers_Account.
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "RefusedSubscribers_Account": [ // List of users who were denied subscription
        "jared"
    ]
}
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 allows continuing to add requests (including allowing some users to be added); 1 rejects the request.
ErrorInfo
String
Mandatory
Error message.
RefusedSubscribers_Account
Array
Optional
Collection of user IDs denied addition.
References
﻿Webhook Overview﻿
REST API:Adding Subscribers﻿
﻿

ヘルプとサポート

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

営業担当者にお問い合わせいただくかチケットを提出してサポートを求めることができます。

フィードバック

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 to: OfficialAccount.CallbackBeforeAddSubscriber.
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 Channel 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 allows continuing to add requests (including allowing some users to be added); 1 rejects the request.
ErrorInfo	String	Mandatory	Error message.
RefusedSubscribers_Account	Array	Optional	Collection of user IDs denied addition.

tencent cloud

Chat

Before Official Channel 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

Allow all users to follow the Official Channel

Block certain users from subscribing to the Official Channel

Response fields

References

ヘルプとサポート