tencent cloud

功能说明

App 后台可以通过该接口查询特定帐号的单聊总未读数（包含所有的单聊会话）或者单个单聊会话的未读数。

接口调用说明

请求 URL 示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

最高调用频率

200次/秒。

查询特定帐号的单聊总未读数

请求包示例

管理员查询 dramon1 未读的单聊消息的总数。只填 To_Account 即可。

{
    "To_Account":"dramon1"
}

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "AllC2CUnreadMsgNum": 12
}

批量查询多个单聊会话的未读消息数

请求包示例

管理员查询 dramon1 在与 dramon2 和 teacher 两个单聊会话中的未读消息数。

{
    "To_Account":"dramon1",
    "Peer_Account":[
        "dramon2",
        "teacher"
    ]
}

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "C2CUnreadMsgNumList": [
        {
            "Peer_Account": "dramon2",
            "C2CUnreadMsgNum": 12
        },
        {
            "Peer_Account": "teacher",
            "C2CUnreadMsgNum": 12
        }
    ]
}

请求包字段说明

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

参考

• 单发单聊消息（v4/openim/sendmsg）
• 批量发单聊消息（v4/openim/batchsendmsg）
• 查询单聊消息（v4/openim/admin_getroammsg）
• 撤回单聊消息（v4/openim/admin_msgwithdraw）