浏览 平台 API
服务端 API

群聊消息已读后

复制

在群聊消息已读状态更新后同步已读事件。

触发时机

项目说明
类型后置回调
配置项afterGroupMsgRead
回调命令callbackAfterGroupMsgReadCommand

HTTP 请求

POST {WEBHOOK_ADDRESS}/callbackAfterGroupMsgReadCommand
Content-Type: application/json
operationID: {OPERATION_ID}
{
  "callbackCommand": "callbackAfterGroupMsgReadCommand",
  "sendID": "user_001",
  "receiveID": "",
  "unreadMsgNum": 1,
  "contentType": 1
}

请求体参数

参数名是否必填类型说明
callbackCommandstring回调命令,值与当前页面的回调命令一致。
sendIDstring消息发送者用户 ID。
receiveIDstring消息接收者用户 ID。
unreadMsgNumint当前未读消息数量。
contentTypeint消息内容类型,参见消息内容类型

响应

业务服务端应返回 HTTP 成功状态和 JSON 响应体。

{
  "actionCode": 0,
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "nextCode": 0
}

响应参数

参数名类型说明
actionCodeint处理状态,参见Webhooks 概述的 CallbackAction
errCodeint业务错误码;拒绝前置操作时返回业务约定的非零错误码。
errMsgstring错误简要信息。
errDltstring错误详细信息。
nextCodeint处理下一步,参见Webhooks 概述的 CallbackNextCode

处理规则

  • 事件发生后,OpenIM 异步调用该地址。
  • 回调响应不能改变已经完成的 OpenIM 操作。
  • 接收方应快速返回成功状态,再异步执行耗时业务。
  • 接收方应按业务主键或 operationID 做幂等处理。

相关页面