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서버 APIsRESTful APIs Session RelatedSession Grouping TagPulling Conversation Group Mark Data

Pulling Conversation Group Mark Data

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-03-26 16:09:05

Feature Overview

This API supports batch obtaining user's conversation group mark data.
Note:
Each user can create up to 20 conversation groups. A session can join multiple groups. The session capacity limit per group is 1000. Exceeding this limit will return error code: 51008.
The upper limit for session tags and custom fields is 1000 sessions. Exceeding this limit will return error code: 51008.
The conversation grouping and tagging features require enabling Ultimate Edition or Enterprise Edition. The number of cloud-based sessions that can be pulled is limited by the Chat Basic Package "Number of Cloud-based Session List Pulls". If the number of grouped or tagged sessions exceeds the corresponding limit, complete session pulling will be unavailable. You can upgrade the Chat package version to increase the cloud-based session limit.

API Calling Description

Sample request URL

https://xxxxxx/v4/recentcontact/get_contact_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
Parameter
Description
xxxxxx
Domain name corresponding to the country/region where your SDKAppID is located.
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/recentcontact/get_contact_group
Request API.
sdkappid
SDKAppID assigned by the Chat console when an app is created.
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
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
Request format, which should always be json.

Maximum call frequency

200 calls per second

Sample request

{
    "From_Account":"user0",
    "StartIndex":0
}

Request fields

Field
Type
Required
Description
From_Account
String
Yes
Fill in UserID, request to get conversation group/mark for this user.
StartIndex
Integer
Yes
Start index for the current page pulling. Enter 0 for the first pull and enter the value of NextStartIndex returned last time.

Sample response

{
    "ContactItem": [
        {
            "Type": 1,
            "To_Account": "teacher4",
            "StandardMark": "111001",
            "ContactGroupId": [
                1,
                2
            ],
            "Timestamp": 1670843110
        },
        {
            "Type": 2,
            "ToGroupId": "@TGS#1N3RSUYG2",
            "StandardMark": "111001",
            "CustomMark": "abcd",
            "Timestamp": 1672998266
        }
    ],
    "GroupItem": [
        {
            "GroupName": "test1x",
            "GroupId": 1
        },
        {
            "GroupName": "test10",
            "GroupId": 2
        }
    ],
    "CompleteFlag": 1,
    "NextStartIndex": 0,
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": ""
}

Response fields

Field
Type
Description
ActionStatus
String
Request result. OK: Successful; FAIL: Failed.
ErrorCode
Integer
Error code. 0: Successful; other values: Failed.
ErrorInfo
String
Error information.
ContactItem
Integer
Conversation object.
Type
String
Conversation type：
1: One-to-one conversation.
2: Group conversation.
ToGroupId
String
Assign value only for Group conversation, fill in the group ID of the conversation party.
To_Account
String
Assign value only for One-to-one conversation, fill in the UserID of the conversation party.
Timestamp
Integer
Last update timestamp of the conversation group.
StandardMark
String
Standard mark capability bit, for example, 011111110.
CustomMark
String
Custom mark.
ContactGroupId
Array
Group to which the conversation belongs.
CompleteFlag
Integer
Required.
NextStartIndex
Integer
Required.

Error Codes

The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ResultCode, ResultInfo, ErrorCode, and ErrorInfo.
For public error codes (60000 to 79999), please see Error Codes.
The following table describes the error codes specific to this API:
Error Code
Description
50001
The requested UserID has not been imported to Chat. Please import the UserID first.
50002
Incorrect request parameter. Check your request according to the error description.
50003
The request requires app admin permissions.
50004
Internal server error. Please try again.
50005
Network timeout. Try again later.
51006
When you are modifying conversation mark, the number of conversations is empty or exceeds the upper limit of 100.
51007
Failed to replace GroupID with GroupCode because an internal error occurred or the group was disbanded.
51008
The total number of conversations in the conversation group exceeds 1,000.
51009
The conversation group does not exist when a deletion attempt is made.
51010
The number of conversation groups exceeds the upper limit of 20.
51011
The conversation group name contains more than 32 bytes.
51012
Exceeded the maximum number of conversations pinned to the top.
51013
If the requested app is not of the Pro edition 、Pro Plus edition、Enterprise edition, an error will be reported when a standard conversation mark or conversation group is modified.

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.
이전 주제: Searching for Conversation Group Marks다음 주제: Getting All Groups in an App

도움말 및 지원

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

피드백