tencent cloud

Chat

ドキュメントChatサービス側 APIsRESTful APIs Session RelatedSession Grouping TagPulling Conversation Group Mark Data

Pulling Conversation Group Mark Data

PDF
フォーカスモード
フォントサイズ
最終更新日: 2026-04-14 11:25:28

Feature Overview

This API supports batch obtaining user's conversation group mark data.
Note:
Conversation grouping and Conversation Marking operate independently from the recent contacts list. The REST API supports CRUD operations for conversation grouping, Standard Conversation Marking, and Custom Conversation Marking fields.
Each user can create up to 20 conversation groups. A session can join multiple groups. The session cap is set at 1000, and exceeding it will return error code: 51008.
Session tags and session custom fields have a combined upper limit of 1000 sessions. Exceeding this limit will return error code: 51008.
Conversation grouping and marking features require enabling Pro Edition、Pro Plus Edition or Enterprise Edition. The number of cloud sessions that can be pulled is limited by the "Number of Conversations to Pull" in the Chat basic package. If the number of grouped or marked sessions exceeds the corresponding limit, complete session retrieval may fail. You can upgrade the Chat package version to increase the cloud 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": "user_0001",
  "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": "user_0002",
      "StandardMark": "111001",
      "ContactGroupId": [
        1,
        2
      ],
      "Timestamp": 1670843110
    },
    {
      "Type": 2,
      "ToGroupId": "@TGS#1B2AUI7RZ",
      "StandardMark": "111001",
      "CustomMark": "abcd",
      "Timestamp": 1672998266
    }
  ],
  "GroupItem": [
    {
      "GroupName": "group_0001",
      "GroupId": 1
    },
    {
      "GroupName": "group_0002",
      "GroupId": 2
    }
  ],
  "CompleteFlag": 1,
  "NextStartIndex": 0,
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": ""
}

Response fields

Field
Type
Description
ContactItem
Integer
Conversation object.
Type
Integer
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.
StandardMark
String
Standard mark capability bit, for example, 011111110.
CustomMark
String
Custom mark.
ContactGroupId
Array
Group to which the conversation belongs.
Timestamp
Integer
Last update timestamp of the conversation group.
GroupItem
Array
Conversation group object.
GroupName
String
Conversation group name.
GroupId
Integer
Conversation group ID.
CompleteFlag
Integer
Required.
NextStartIndex
Integer
Required.
ActionStatus
String
Request result.
OK: Successful;
FAIL: Failed.
ErrorCode
Integer
Error code.
0: Successful;
other values: Failed.
ErrorInfo
String
Error information.

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.

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

ヘルプとサポート

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

フィードバック