即时通信 IM
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 即时通信 IM > 服务端 API > REST API > 会话相关 > 会话列表 > 拉取会话列表

拉取会话列表

最近更新时间：2023-12-12 15:56:25

我的收藏

本页目录：

功能说明

支持分页拉取会话列表，会话上限请参见 会话列表拉取个数配置。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/recentcontact/get_list?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
孟买：adminapiind.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/recentcontact/get_list
请求接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
请求格式固定值为json。

最高调用频率

200次/秒。

请求包示例

{
  "From_Account": "id1",
  "TimeStamp": 0,
  "StartIndex": 0,
  "TopTimeStamp": 0,
  "TopStartIndex": 0,
  "AssistFlags": 15
}

请求包字段说明

字段
类型
属性
说明
From_Account
String
必填
填 UserID，请求拉取该用户的会话列表。
TimeStamp
Integer
必填
普通会话的起始时间，第一页填 0。
StartIndex
Integer
必填
普通会话的起始位置，第一页填 0。
TopTimeStamp
Integer
必填
置顶会话的起始时间，第一页填 0。
TopStartIndex
Integer
必填
置顶会话的起始位置，第一页填 0。
AssistFlags
Integer
必填
会话辅助标志位：填固定值 15。

应答包体示例

{
  "SessionItem": [
    {
      "Type": 1,
      "To_Account": "id2",
      "MsgTime": 1630997627,
      "TopFlag": 1
    },
    {
      "Type": 2,
      "GroupId": "id3",
      "MsgTime": 1630997628,
      "TopFlag": 1
    },
    {
      "Type": 1,
      "To_Account": "id4",
      "MsgTime": 1630997630,
      "TopFlag": 0
    },
    {
      "Type": 2,
      "GroupId": "id5",
      "MsgTime": 1630997650,
      "TopFlag": 0
    }
  ],
  "CompleteFlag": 1,
  "TimeStamp": 1631012800,
  "StartIndex": 0,
  "TopTimeStamp": 1631012800,
  "TopStartIndex": 0,
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": "",
  "ErrorDisplay": ""
}

应答包字段说明

字段
类型
说明
SessionItem
Array
会话对象数组。
Type
Integer
会话类型：
1： 表示 C2C 会话
2：表示 G2C 会话
To_Account
String
C2C 会话才会返回，返回会话方的 UserID。
GroupId
String
G2C 会话才会返回，返回群 ID。
MsgTime
Integer
会话时间。
TopFlag
Integer
置顶标记：
0：标识普通会话
1：标识置顶会话
CompleteFlag
Integer
结束标识：
1：表示已返回全量会话
0：表示还有会话没拉完
TimeStamp
Integer
普通会话下一页拉取的起始时间，分页拉取时通过请求包的 TimeStamp 字段带给移动通信后台。
StartIndex
Integer
普通会话下一页拉取的起始位置，分页拉取时通过请求包的 StartIndex 字段带给移动通信后台。
TopTimeStamp
Integer
置顶会话下一页拉取的起始时间，分页拉取时通过请求包的 TopTimeStamp 字段带给移动通信后台。
TopStartIndex
Integer
置顶会话下一页拉取的起始位置，分页拉取时通过请求包的 TopStartIndex 字段带给移动通信后台。
ActionStatus
String
请求包的处理结果：
OK：表示处理成功
FAIL：表示失败
ErrorCode
Integer
错误码，0表示成功，非0表示失败，非0取值的详细描述请参见错误码说明。
ErrorInfo
String
详细错误信息。
ErrorDisplay
String
详细的客户端展示信息。

错误码说明

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

接口调试工具

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