tencent cloud

文档反馈

查询单聊未读消息计数

最后更新时间:2024-07-16 10:52:14

    功能说明

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

    接口调用说明

    请求 URL 示例

    https://xxxxxx/v4/openim/get_c2c_unread_msg_num?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/openim/get_c2c_unread_msg_num
    请求接口
    sdkappid
    创建应用时即时通信 IM 控制台分配的 SDKAppID
    identifier
    必须为 App 管理员账号,更多详情请参见 App 管理员
    usersig
    App 管理员账号生成的签名,具体操作请参见 生成 UserSig
    random
    请输入随机的32位无符号整数,取值范围0 - 4294967295
    contenttype
    请求格式固定值为json

    最高调用频率

    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
    }
    ]
    }

    请求包字段说明

    字段
    类型
    属性
    说明
    To_Account
    String
    必填
    待查询的用户 UserId
    Peer_Account
    Array
    选填
    待查询的单聊会话对端的用户 UserId
    若要查询单个会话的未读数,该字段必填
    该数组最大大小为10

    应答包字段说明

    字段
    类型
    说明
    ActionStatus
    String
    请求处理的结果,OK 表示处理成功,FAIL 表示失败
    ErrorCode
    Integer
    错误码,0表示成功,非0表示失败
    ErrorInfo
    String
    错误信息
    AllC2CUnreadMsgNum
    Integer
    单聊消息总未读数
    C2CUnreadMsgNumList.Peer_Account
    String
    单聊会话对端 UserId
    C2CUnreadMsgNumList.C2CUnreadMsgNum
    Integer
    该单聊会话的未读数
    ErrorList.Peer_Account
    String
    查询错误的目标账号
    ErrorList.ErrorCode
    Integer
    查询错误的错误码。若目标账号的错误码为70107表示该账号不存在

    错误码说明

    除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
    公共错误码(60000到79999)参见 错误码 文档。
    本 API 私有错误码如下:
    错误码
    描述
    90001
    JSON 格式解析失败,请检查请求包是否符合 JSON 规范。
    90003
    JSON 格式请求包体中缺少 To_Account 字段或者 To_Account 账号不存在。
    90008
    JSON 格式请求包体中缺少 From_Account 字段或者 From_Account 账号不存在。

    参考

    单发单聊消息(v4/openim/sendmsg
    批量发单聊消息(v4/openim/batchsendmsg
    查询单聊消息(v4/openim/admin_getroammsg
    撤回单聊消息(v4/openim/admin_msgwithdraw
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持