本文介绍消息通知事件的字段说明和示例。

事件说明

发送的每条单聊和群聊消息都会产生一个消息通知事件,通知主要用于厂商通道的推送,比如APNs、小米、华为推送通道。

字段说明

参数名称 类型 是否必选 示例值 描述
userMessage Object 消息信息。
msg Object 消息对象。
senderId String 1001 消息发送者ID
conversationType Integer 1 会话类型。取值:
  • 1:单聊。
  • 2:群聊
appCid String 1abcd 会话ID。
msgId String PNGM1345 消息ID。
contentType Integer 1 消息内容类型。取值:
  • 1:文本。
  • 2:图片。
  • 3:语音。
  • 4:视频。
  • 5:地理位置。
  • 8:群@消息。
  • 9:文件。
  • 10:回复消息。
  • 11: 消息合并转发。
  • 101:自定义消息。
content String {"text": "hello"} 消息内容。详情请参见消息类型说明
receiverIds List<String> ["1001","1002"] 消息接收者账号ID。
createTime Long 1613700223000 消息发送时间。
extensions Map {"k1":"v1"} 消息扩展信息。
userExtensions Map {"k1":"v1"} 用户消息扩展信息。
userLocations Map 用户在线状态。
String {"1234":[ { "clientAppKey": "****", "deviceId": "****", "isOnline": true, "offlineTime": 1333444555}, ]}
  • key是接收者账号ID。
  • value是用户在线状态的列表。

    在线状态的详细信息,请参见表 1

notificationProperty Map 用户通知属性信息。
String {"12345":{"muteNotification": false, "title": "478547"}
  • key是接收者账号ID。
  • value是用户通知所需的属性信息。

    属性信息的详细信息,请参见表 2

表 1. userLocations
参数名称 类型 是否必选 示例值 描述
clientAppKey String 96C5FA0B2E3CC89E6A68F6DE63F9**** 客户端appKey。
deviceId String iOS_Device_A7DB72F4-1F6B-4C0D-8176-AB9DD150**** 设备ID。
isOnline Boolean true 是否在线。取值:
  • true:在线。
  • false:离线。
offlineTime Long 1333444555 离线时间。
表 2. notificationProperty
参数名称 类型 是否必选 示例值 描述
muteNotification Boolean false 是否免打扰。取值:
  • true:是。
  • false:否。

默认为false

title String 478547 群名称。目前只有群聊才有该字段。

示例

{
  "userMessage":
  {
    "msg": 
    {
      "appCid": "1abcd",
      "conversationType": 1,
      "msgId": "PNGM1345",
      "createTime": 1613700223000,
      "senderId": "1",
      "receiverIds":[],
      "contentType": 1,
      "content": "{"text":"hello"}",
      "extensions": {"k1": "v1"}
    },
    "userExtensions":{"k1": "v1"}
  },
  "userLocations":
  {
    "1234": 
    [
      {
        "clientAppKey": "96C5FA0B2E3CC89E6A68F6DE63F9****",
        "deviceId": "iOS_Device_A7DB72F4-1F6B-4C0D-8176-AB9DD150****",
        "isOnline": true,
        "offlineTime": 1333444555
      },
    ]
  },
  "notificationProperty": 
  {
    "12345":
    {
      "muteNotification": false,
      "title": "478547"
    }
  }
}