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

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

Feature Overview

This API is used by the app administrator to obtain the list information of all official channels subscribed by a user.
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_subscribed_official_account_list?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_subscribed_official_account_list
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

{
"Subscriber_Account": "107867", //Subscriber
"Limit": 200,
"Offset": 0,
"ResponseFilter":{ //Filter fields
"OfficialAccountBaseInfoFilter":[ //Filter fields for official channel information
"CreateTime",
"Name",
"Owner_Account",
"LastMsgTime",
"SubscriberNum",
"Introduction",
"FaceUrl",
"Organization",
"CustomString"
],
"SelfInfoFilter":[ //Filter fields for subscriber information
"SubscribeTime",
"CustomString"
]
}
}

Request Fields

Field
Type
Required
Description
Subscriber_Account
String
Yes
ID of the subscriber whose information is to be modified.
Limit
Integer
No
Number of official channels pulled in a single pull, currently supporting a maximum value of 200. If not specified, the default is 200.
Offset
Integer
No
Indicates starting pulling from which official channel.
ResponseFilter
Object
No
Includes two filters: OfficialAccountBaseInfoFilter and SelfInfoFilter.
OfficialAccountBaseInfoFilter: Indicates the basic information fields of official channels to be pulled, mainly including:
CreateTime: creation time of the official channel
Name: name of the official channel
Owner_Account: user who owns the official channel
LastMsgTime: time of the last message within the official channel
SubscriberNum: current number of subscribers to the official channel
Introduction: introduction to the official channel
FaceUrl: avatar URL of the official channel
Organization: organization of the official channel
CustomString: custom field at the official channel level
If not specified, all fields will be pulled.
SelfInfoFilter: Indicates the need to pull subscriber's own information, mainly including:
SubscribeTime: time when the subscriber subscribed to the official channel
CustomString: custom field at the subscriber level
If not specified, all fields will be pulled.

Sample Response Packets

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"TotalCount": 8, //The total number of subscribed official channels, unrelated to the pull limit
"OfficialAccountInfoList": [ //List of official channels returned
{
"Name": "test_mill_subscriber_OA",
"Official_Account": "@TOA#_test_mill_subscriber_OA",
"Owner_Account": "107867",
"LastMsgTime": 1698894911,
"SubscriberNum": 499800,
"Introduction": "This is test Introduction",
"FaceUrl": "http://this.is.face.url",
"Organization": "Tencent",
"CustomString": "test_custom_string",
"SelfInfo": {
"SubscribeTime": 1700655351,
"CustomString": ""
}
//...There might be a lot more information to follow, but here information of only one official channel is displayed.
],
"CompleteFlag": 1, //Indicates whether the pull has ended. 1 means it has ended; 0 means it has not ended.
"Next": 0 //If the pull has ended, returns 0.
}

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.
OfficialAccountInfoList
Array
The official channel information obtained. The results are filtered information based on the filter fields set in the filter.
TotalCount
Integer
Number of official channels subscribed by the user.
CompleteFlag
Integer
Indicates whether the pull has ended.
1: The pull has ended.
0: The pull has not ended.
Next
Integer
Indicates the next pull. If the current pull has not ended, it can be filled in the offset of the next pull as the offset for pagination.

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.
130002
Insufficient operation permissions. Please check the request parameters based on the error message.
130004
The official channel user does not exist, or once existed but has now been terminated.
130007
Incorrect official channel user ID. Please modify and retry.
131000
This AppId has not been enabled with official channel service.

References



도움말 및 지원

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

피드백