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 정책
개인 정보 보호 정책
데이터 개인 정보 보호 및 보안 계약
에러 코드
문의하기

Obtaining Subscriber Information of Official Channel

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-10-23 15:24:44

Feature Overview

This API is used by the app administrator to obtain the information of all users subscribing to a specific official channel.
Note:
The feature is only available for Enterprises. To enable it, contact us. You can trial this feature in the console . The trial version allows creating up to 5 public accounts, valid for one month.

API Calling Description

Sample Request URL

https://xxxxxx/v4/official_account_open_http_svc/get_subscriber_info?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
Tokyo:adminapijpn.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/get_subscriber_info
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#_test_for_penn",
"Limit": 50,
"Next": ""
}

Request Fields

Field
Type
Required
Description
Official_Account
String
Yes
Official account ID requested. Use the OfficialAccountUserID field returned by the API during creation.
Limit
Integer
No
The maximum number of members' information that can be obtained at one time, not to exceed 200. If not specified, the information of all members in the group will be obtained.
Next
String
Yes
The position of the subscriber last pulled. For the first call, fill in ""; for subsequent pulls, use the Next value returned in the response.


Sample Response Packets

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"Next": "TGSOTk=", // The marker for the subsequent pull. If not empty, input in the Next field for the next request.
"SubscriberNum": 780031, // Total number of subscribers to this official channel
"SubscriberList": [
{
"Subscriber_Account": "millaccount13356", // Subscriber account
"SubscribeTime": 1698821747, // Time of subscription
"CustomString": "", // Custom field at the subscriber level
"MsgFlag": "AcceptAndNotify", // The message receiving option for subscribers, similar to the message receiving option for group members
"LastSendMsgTime": 0 // Time of the last message sent
},
{
"Subscriber_Account": "millaccount13100",
"SubscribeTime": 1698821690,
"CustomString": "",
"MsgFlag": "AcceptAndNotify",
"LastSendMsgTime": 0
}
// The rest of the subscriber information is omitted below.
]
}

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.
Next
String
The marker for the subsequent pull. The server response packet returns Next as "" for the last pull, indicating there is no subsequent subscriber information, and the client should end the query.
SubscriberNum
Integer
Returns the number of all subscribers under the official channel.
SubscriberList
Array
Returned subscriber list, including the following information:
Subscriber_Account: subscriber account
SubscribeTime: time of subscription
CustomString: custom field at the subscriber level
MsgFlag: the message receiving option for subscribers, similar to the message receiving option for group members
LastSendMsgTime: time of the last message sent

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.
130007
Incorrect official channel user ID. Please modify and retry.
130008
The official channel user ID is already in use. Please modify and retry.
131000
This AppId has not been enabled with official channel service. Please enable it and retry.
130010
The number of created official channels exceeds the limit. Please dissolve some official channels or upgrade the service.

References





도움말 및 지원

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

피드백