跳到主要内容

创建群聊会话后的回调

功能说明​

App 业务服务端可以通过该回调实时对用户的单聊消息进行操作，如：

  • 对创建群聊会话进行实时记录（记录日志或同步到其他系统）。

注意事项​

  • 为启用回调，必须配置回调 URL，并开启本条回调协议对应的开关。配置方法详见 回调说明 文档。
  • 回调的方向是 OpenIMServer 向 App 后台发起 HTTP/HTTPS POST 请求。
  • APP 业务服务端需在超时时间内响应此请求。

可能触发该回调的场景​

  • App 用户通过客户端创建群聊会话。
  • App 管理员通过 REST API 创建群聊会话

回调发生时机​

  • OpenIMServer 收到用户创建群聊会话消息，并将该消息下发给目标用户之后。

接口说明​

请求 URL 示例​

此处CallbackCommand为：callbackAfterSendSingleMsgCommand

{WEBHOOK_ADDRESS}/callbackAfterSendSingleMsgCommand?contenttype=json

请求包示例​

{
  "callbackCommand": "callbackAfterCreateSingleChatConversationsCommand",
  "ownerUserId": "123228123",
  "conversationId": "sg_123421231",
  "conversationType": 3,
  "groupId": "123421231",
  "recvMsgOpt": 0,
  "isPinned": false,
  "isPrivateChat": false,
  "burnDuration": 0,
  "groupAtType": 0,
  "attachedInfo": "",
  "ex": "Extra conversation data"
}

请求包字段说明​

对象类型描述
callbackCommandstring回调命令，这里是创建群聊会话后的回调
ownerUserIdstring会话的拥有者用户 Id
conversationIdstring会话 Id
conversationTypeint会话类型，1 为单聊，3 为群聊
groupIdstring会话群组 Id，当会话类型为 3 时，此字段生效
recvMsgOptint接收消息参数，0 为接收消息；1 为不接收消息；2 为接收消息但不提醒
isPinnedboolean会话是否置顶
isPrivateChatboolean是否开启阅后即焚
burnDurationint阅后即焚消息持续时间
groupAtTypeint群会话公告强提示类型，群公告有人@ownerUserID , @全体 的特殊标识符
attachedInfostringopenIM 使用的拓展字段
exstring用户使用的拓展字段

应答包示例​

成功响应​

App 业务服务端同步数据后，发送回调应答包

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

应答包字段说明​

字段值说明
actionCode0表示业务系统的回调是否正确执行。0表示操作成功。
errCode0表示自定义错误码，此处填 0 代表忽略回调结果。
errMsg"An error message"自定义错误码对应的简单错误信息。
errDlt"Detailed error information"自定义错误码对应的详细错误信息。
nextCode1下一步执行指令，1表示拒绝继续执行，actionCode 等于0时设置。