Docs Overview/
Chat/
服务端 API/
RESTful 接口/
会话相关/
会话组标签/
拉取会话组标记数据/

拉取会话组标记数据

功能说明

本接口支持批量获取用户的会话分组标记数据。

接口调用说明

请求 URL 示例

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

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

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

请求包字段说明

字段
类型
属性
说明
From_Account
String
必填
请求方 uid
StartIndex
Integer
必填
当前分页拉取的起始索引，首次拉取填0，后续填上次返回的 NextStartIndex

应答包体示例

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

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败
ErrorCode
Integer
错误码，0表示成功，非0表示失败
ErrorInfo
String
错误信息
ContactItem
Integer
会话对象
Type
String
会话类型，c2c=1,group=2
ToGroupId
String
群 ID
To_Account
String
用户 ID
Timestamp
Integer
会话分组对应最近更新时间戳
StandardMark
String
标准标记能力位，bit位字符串。eg: 011111110
CustomMark
String
自定义标记
ContactGroupId
Array
会话所属分组
CompleteFlag
Integer
必填
NextStartIndex
Integer
必填

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。
公共错误码（60000到79999）请参见 错误码。
本 API 私有错误码如下：
错误码
描述
50001
请求的 UserID 没有导入腾讯云移动通信后台，请先将 UserID 导入腾讯云移动通信后台
50002
请求参数错误，请根据错误描述检查请求参数
50003
请求需要 App 管理员权限
50004
服务端内部错误，请重试
50005
网络超时，请稍后重试
51006
修改会话标记时，调整的会话数为空或者超过了100个上限。
51007
GroupID 换 GroupCode 失败，内部错误或 Group 已经解散。
51008
会话分组的总的会话数超过了1000。
51009
删除会话分组时分组不存在。
51010
会话分组数超过了20个上限。
51011
会话分组名超过了32个字节。
51012
超过置顶会话数量上限。
51013
若请求的应用非进阶版，修改标准会话标记或者会话分组报错。

接口调试工具

通过 REST API 在线调试工具 调试本接口。