文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>即时通信 IM>智能客服（Desk）>服务端 API>REST API>会话相关接口>查询客服号会话的未读数

查询客服号会话的未读数

最近更新时间：2025-11-25 09:57:01

我的收藏

本页目录：

接口调用说明

通过该接口可以查询指定用户与客服号之间的单聊未读数。该接口仅支持查询 应用（SDK 轻量开发）的用户端的客服号会话未读数。

请求 URL 示例

https://console.tim.qq.com/v4/desk_http_svc/get_im_agent_unread_msg_num?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
v4/desk_http_svc/get_im_agent_unread_msg_num
请求接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
请求格式固定值为json。

请求包示例

{
  "ClientUserID": "user123",
  "IMAgentUserIDList": ["agent1", "agent2"]
}

请求包字段说明

字段
类型
属性
说明
ClientUserID
String
必填
用户 UserID。
IMAgentUserIDList
Array
选填
客服号 ID 列表。
若 IMAgentUserIDList 为空，则查询 ClientUserID 的所有客服号会话的未读数。
若指定了 IMAgentUserIDList，则查询这些客服号会话的未读数。

应答包体示例

{
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": "",
  "AllIMAgentUnreadMsgNum": 5,
  "UnreadMsgNumList": [
    {      
      "IMAgentUserID": "agent1",
      "UnreadMsgNum": 3
    },
    {
      "IMAgentUserID": "agent2",
      "UnreadMsgNum": 2
    }
  ],
  "ErrorList": [
    {
      "IMAgentUserID": "agent3",
      "ErrorCode": 141004
    }
  ]
}

应答包字段说明

字段
类型
说明
ErrorCode
Integer
请求错误码：
0表示成功。
非0表示失败。
ErrorInfo
String
错误信息。
ActionStatus
String
请求处理的结果。
AllIMAgentUnreadMsgNum
Integer
所有客服号会话的未读总数。
UnreadMsgNumList
Array
各客服号会话的未读数列表。
IMAgentUserID
String
客服号 UserID。
UnreadMsgNum
Integer
该客服号的未读数。
ErrorList
Array
查询错误的列表。
IMAgentUserID
String
查询错误的客服号 UserID。
ErrorCode
Integer
错误码。

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
描述
141000
该应用非智能客服应用。
141002
内部错误，请重试。
141004
参数非法。
141009
接口限频。

接口调试工具

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