跳到主要内容

离线状态下消息推送前的回调

功能说明​

在消息发送至客户端前，App 业务服务端可以通过该回调接收到发送消息的请求。业务服务端可以根据需要对消息进行拦截、修改或添加额外的推送信息。

注意事项​

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

可能触发该回调的场景​

  • 群成员退出群组。
  • 群成员被踢出群组。
  • 群组解散。

回调发生时机​

  • OpenIMServer 准备向客户端推送消息前。

接口说明​

请求 URL 示例​

此处CallbackCommand为：callbackBeforeOfflinePushCommand

{WEBHOOK_ADDRESS}/callbackBeforeOfflinePushCommand?contenttype=json

请求包示例​

{
  "callbackCommand": "callbackBeforeOfflinePushCommand",
  "platformID": 1,
  "platform": "iOS",
  "userIDList": ["user123", "user456"],
  "title": "New Message",
  "desc": "You have a new message",
  "ex": "Extra push info",
  "iOSPushSound": "default",
  "iOSBadgeCount": true,
  "signalInfo": "Signal data",
  "clientMsgID": "msg123",
  "sendID": "user789",
  "groupID": "group123",
  "contentType": 1,
  "sessionType": 2,
  "atUserIDList": ["user101", "user102"],
  "content": "Hello, this is a test message"
}

请求包字段说明​

字段类型描述
callbackCommandstring回调命令，这里是消息推送前的回调
platformIDint平台 ID（如 1 代表 iOS，2 代表 Android）
platformstring平台名称（如 iOS、Android）
userIDListarray用户 ID 列表，表示哪些用户将接收此消息
titlestring推送消息的标题
descstring推送消息的描述
exstring额外的推送信息
iOSPushSoundstringiOS 推送时的声音设置
iOSBadgeCountbooliOS 推送时是否改变应用角标计数
signalInfostring推送携带的附加信号信息
clientMsgIDstring客户端消息 ID
sendIDstring发送者的用户 ID
groupIDstring群组 ID，如果是群消息的话
contentTypeint消息内容的类型
sessionTypeint会话类型（如 1 代表单聊，2 代表群聊）
atUserIDListarray被@的用户 ID 列表
contentstring发送的消息内容

应答包示例​

允许推送​

允许消息被推送到客户端。

{
  "actionCode": 0,
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "nextCode": "",
  "userIDList": ["user123", "user456"],
  "offlinePushInfo": {
    "title": "New Message",
    "desc": "You have a new message",
    "ex": "Extra push info",
    "iOSPushSound": "default",
    "iOSBadgeCount": true,
    "signalInfo": "Signal data"
  }
}

应答包字段说明​

字段类型描述
actionCode0表示业务系统的回调是否正确执行。0表示操作成功。
errCode5001表示自定义错误码，范围在 5000-9999 之间。在 actionCode 不等于 0 时设置；在 nextCode 等于 1 时设置。
errMsg"An error message"自定义错误码对应的简单错误信息。
errDlt"Detailed error information"自定义错误码对应的详细错误信息。
nextCode1下一步执行指令，1表示拒绝继续执行，actionCode 等于0时设置。
userIDListarray用户 ID 列表，表示允许接收消息的用户。
offlinePushInfoobject离线推送信息对象。