tencent cloud

Chat

제품 소개
제품 개요
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
Electron
Unity
React Native
C APIs
C++
서버 APIs
Secure authentication with UserSig
RESTful APIs
Webhooks
콘솔 가이드
New Console Introduction
애플리케이션 생성 및 업그레이드
기본 설정
기능 설정
계정 관리
그룹 관리
Official Channel Management
콜백 설정
모니터링 대시보드
Viewing Guide for Resource Packages
Real-Time Monitor
개발 보조 툴
액세스 관리
Advanced Features
FAQ
uni-app FAQs
구매
SDK 관련 질문
계정 인증
사용자 정보 및 관계망
메시지
그룹
라이브 방송 그룹
닉네임 및 프로필 사진
협약 및 인증
Service Level Agreement
컴플라이언스 인증
IM 정책
개인 정보 보호 정책
데이터 개인 정보 보호 및 보안 계약
에러 코드
문의하기
문서Chat

All Users / Tags / UserID Push Callback

포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-10-27 10:39:23

Feature Description

After enabling the push plugin, the push results can be forwarded to the app backend by configuring the basic callback.

Notes

This callback belongs to the event callback after downstream diffusion. To prevent a large number of callback requests from overwhelming the App backend, default QPS: 1000 times/s. Overfrequency callbacks will be retried after a delay. If you need to adjust QPS due to business requirements, you can submit a ticket to apply.
To enable this callback, you must configure the callback URL and enable the corresponding switch for this callback. For more information on the configuration method, see the Webhooks documentation.
During this callback, the Chat backend initiates an HTTP POST request to the app backend.
After receiving the callback request, the app backend must check whether the SDKAppID contained in the request URL is consistent with its own SDKAppID.
For additional safety-related concerns, please refer to the Third-Party Callback Overview: Security Considerations document.

API Description

Request URL sample:

In the following example, the callback URL configured in the App configuration is https://www.example.com
Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json

Request parameters

Field
Description
https
Request protocol is HTTPS
Request method is POST
www.example.com
Callback URL
SdkAppid
SDKAppID allocated by the Instant Messaging console at the time of Application creation
CallbackCommand
Fixed as: Push.AllMemberPush
contenttype
The request payload is fixed as JSON

Sample request packets

{
    "Events": [   // The length of the events array ranges from 1 to 100
      {
        "CallbackCommand":"Push.AllMemberPush",
        "EventType": 1,                                                // Event type, EventType=1 indicates offline push
        "TaskId": "657bf434_537529d8_2000005e80aa873_2780d131_bc614e", // TaskId for all-member/Tag/single push
        "TaskTime": 1557481127,                                        // Timestamp when the all-member push task was initiated, in seconds
        "EventTime": 1557481128,                                       // Timestamp when the event occurred, in seconds
        "To_Account": "user2",                                         // Recipient
        "PushPlatform": 1,                                             // Vendor
        "PushStage": 1,                                                // Push stage
        "ErrCode": 0,                                                  // Push event result
        "ErrInfo": "OK"                                                // Push event result description, may be empty
      },
      {
        "CallbackCommand":"Push.AllMemberPush",
        "EventType": 2,                                                // Event type, EventType=2 indicates online push
        "TaskId": "657bf434_537529d8_2000005e80aa873_2780d131_9",      // TaskId for all-member/Tag/single push
        "TaskTime": 1557481127,                                        // Timestamp when the all-member push task was initiated, in seconds
        "EventTime": 1557481129,                                       // Timestamp when the event occurred, in seconds
        "To_Account": "user3",                                         // Recipient
        "PushPlatform": 0,                                             // Vendor
        "PushStage": 1,                                                // Push stage
        "ErrCode": 0,                                                  // Push event result
        "ErrInfo": "OK"                                                // Push event result description, may be empty
      },
      ....
    ]
}

Request packet fields

Field
Type
Description
Events
Array [ Event Object ]
Batch callback content, containing data for up to 100 callback events (Event Object)
Event Object Structure
Field
Type
Description
CallbackCommand
String
Callback command
EventType
Integer
Event Type:
EventType = 1 indicates offline push
EventType = 2 indicates online push
TaskId
String
Task ID returned when the all-member push is sent
DataId
String
The custom business identifier, which is transparently transmitted within the callback push request.
TaskTime
Integer
Timestamp when the all-member push task was initiated, in seconds
EventTime
Integer
Timestamp when the event occurred, in seconds
To_Account
String
Recipient's UserID
PushPlatform
Integer
Push vendor (for online push EventType = 2, vendor is not distinguished, default is 0):
PushPlatform = 0 indicates unknown vendor
PushPlatform = 1 indicates Apple APNS push
PushPlatform = 2 indicates Xiaomi push
PushPlatform = 3 indicates Huawei push
PushPlatform = 4 indicates Google FCM push
PushPlatform = 5 indicates Meizu push
PushPlatform = 6 indicates OPPO push
PushPlatform = 7 indicates vivo push
PushPlatform = 8 indicates Honor push
DeviceType
Integer
Push vendor (for offline push EventType = 1, vendor is not distinguished, default is 0):
PushPlatform = 0 indicates unknown device
PushPlatform = 1 indicates Apple APNS device
PushPlatform = 2 indicates Xiaomi device
PushPlatform = 3 indicates Huawei device
PushPlatform = 4 indicates Google FCM device
PushPlatform = 5 indicates Meizu device
PushPlatform = 6 indicates OPPO device
PushPlatform = 7 indicates vivo device
PushPlatform = 8 indicates Honor device
PushStage
Integer
Push stage:
PushStage = 1 indicates push sent
PushStage = 2 indicates push reached
PushStage = 3 indicates push clicked
ErrCode
Integer
Push event result:
ErrCode = 0 indicates success
ErrCode non-zero indicates failure
ErrInfo
String
Push event result description, may be empty

Response packet example

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // 0 means callback success, 1 means callback error
}

Response packet field description

Field
Type
Description
ActionStatus
String
Processed Request Result:
OK Signifies Successful Handling
FAILURE signifies unsuccessful execution
ErrorCode
Integer
Error Code
ErrorInfo
String
Error Description


다음 주제: 제품 개요

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백