tencent cloud

文档反馈

设置单聊消息已读

最后更新时间:2024-07-16 10:41:26

    功能说明

    设置用户的某个单聊会话的消息已读。

    接口调用说明

    请求 URL 示例

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

    最高调用频率

    200次/秒。

    请求包示例

    管理员指定 dramon1 将会话 dramon2 的单聊消息全部已读。
    {
    "Report_Account":"dramon1",
    "Peer_Account":"dramon2"
    }

    请求包字段说明

    字段
    类型
    属性
    说明
    Report_Account
    String
    必填
    进行消息已读的用户 UserId
    Peer_Account
    String
    必填
    进行消息已读的单聊会话的另一方用户 UserId
    MsgReadTime
    String
    选填
    时间戳(秒),该时间戳之前的消息全部已读。若不填,则取当前时间戳

    应答包体示例

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

    应答包字段说明

    字段
    类型
    说明
    ActionStatus
    String
    请求处理的结果,OK 表示处理成功,FAIL 表示失败
    ErrorCode
    Integer
    错误码,0表示成功,非0表示失败
    ErrorInfo
    String
    错误信息

    错误码说明

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

    接口调试工具

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

    参考

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

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

    技术支持

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

    7x24 电话支持