tencent cloud

即时通信 IM

文档即时通信 IM服务端 APIREST API会话相关会话分组标记拉取会话分组标记数据

拉取会话分组标记数据

PDF
聚焦模式
字号
最后更新时间： 2026-04-14 11:25:27

功能说明

本接口支持批量获取用户的会话分组标记数据。
说明：
会话分组、会话标记独立于最近联系人，REST API 支持会话分组、会话标准标记、会话自定义标记等字段增删改查。
每个用户最多可创建20个会话分组，一个会话可以加入多个分组，设置分组的会话上限默认是1000，超过会返回错误码：51008。
设置标准标记和自定义标记的会话上限默认是1000，超过会返回错误码：51008。
会话分组和标记功能需开通专业版、专业版 Plus 或企业版，同时可拉取的云端会话数受 Chat 基础套餐中云端会话数的限制，若分组、标记会话数超过对应限制，则无法完整拉取会话，可通过升级 Chat 套餐版本提升云端会话数限制。

接口调用说明

请求 URL 示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 RESTful API 概述。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
首尔：adminapikr.im.qcloud.com
东京：adminapijpn.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/recentcontact/get_contact_group
请求接口。
sdkappid
创建应用时 Chat 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
usersig
App 管理员账号生成的签名，具体操作请参见 UserSig 鉴权。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
请求格式固定值为 json。

最高调用频率

200次/秒。

请求包示例

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

请求包字段说明

字段
类型
属性
说明
From_Account
String
必填
填 UserID，请求拉取该用户的会话分组标记。
StartIndex
Integer
必填
当前分页拉取的起始索引，首次拉取填0，后续填上次返回的 NextStartIndex。

应答包体示例

{
  "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": ""
}

应答包字段说明

字段
类型
说明
ContactItem
Array
会话分组标记数据列表。
Type
Integer
会话类型：
1：表示 C2C 会话。
2：表示 G2C 会话。
ToGroupId
String
G2C 会话才会返回，返回会话方的群 ID。
To_Account
String
C2C 会话才会返回，返回会话方的 UserID。
StandardMark
String
标准标记能力位，bit 位字符串。示例：011111110。
CustomMark
String
自定义标记。
ContactGroupId
Array
会话所属分组。
Timestamp
Integer
会话分组对应最近更新时间戳。
GroupItem
Array
会话分组对象。
GroupName
String
会话分组名称。
GroupId
Integer
会话分组 ID。
CompleteFlag
Integer
拉取结束标志。
NextStartIndex
Integer
下一次拉取时起始序号。
ActionStatus
String
请求处理的结果：
OK 表示处理成功。
FAIL 表示失败。
ErrorCode
Integer
错误码：
0表示成功。
非0表示失败。
ErrorInfo
String
错误信息。

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。 公共错误码（60000到79999）请参见 错误码。 本 API 私有错误码如下：
错误码
描述
50001
请求的 UserID 没有导入 Chat，请先将 UserID 导入 Chat。
50002
请求参数错误，请根据错误描述检查请求参数。
50003
请求需要 App 管理员权限。
50004
服务端内部错误，请重试。
50005
网络超时，请稍后重试。

接口调试工具

通过 REST API 在线调试工具 调试本接口。
上一篇: 搜索会话分组标记下一篇: 获取 App 中的所有群组

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈