请求说明
推送鉴权:接口需要增加验证 Header,请查看 鉴权说明
推送结果:业务方收到推送,需保证相应状态码200视为接收推送成功。
机制说明: 消息抄送会尝试推送3次, 每次间隔100ms, 如果3次都失败, 视为一次推送失败。推送采用Google自适应的熔断机制,如果滑动时间窗口内失败过多会触发熔断机制,暂时停止向业务抄送。
请求参数
| 参数 | 数据类型 | 是否必填 | 参数说明 | |
|---|---|---|---|---|
| event_type | string | 是 | 事件类型,消息订阅固定为 message | |
| timestamp | int64 | 是 | 事件时间戳(毫秒) | |
| payload | array | 是 | 消息事件列表 | |
| payload[].platform | string | 是 | 消息发送平台,可选值:iOS、Android、Web、PC、Server | |
| payload[].sender | string | 是 | 消息发送者 ID;最多 32 个字符 | |
| payload[].receiver | string | 是 | 消息接收者 ID;最多 32 个字符 | |
| payload[].conver_type | int | 是 | 会话类型。1:单聊;2:群聊;3:聊天室 | |
| payload[].msg_type | string | 是 | 消息类型标识;最多 50 个字符 | |
| payload[].msg_content | string | 是 | 消息内容,建议使用 JSON 格式 | |
| payload[].mention_info.mention_type | string | 否 | @ 消息类型。mention_all:@所有人;mention_someone:@某些人;mention_all_someone:@所有人和某些人 | |
| payload[].mention_info.target_user_ids | array | 否 | 当 @ 某些人时,指定被 @ 用户的 ID;数组元素(用户 ID)最多 32 个字符 | |
| payload[].msg_id | string | 是 | 消息 ID | |
| payload[].msg_time | int64 | 是 | 消息发送时间戳(毫秒) |
请求示例
POST /message/notification HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
{
"event_type": "message", //事件类型 message, online, offline
"timestamp": 1713456000000, //毫秒时间戳
"payload": [
{
"platform":"iOS",// iOS/Android/Web/PC/Server
"sender": "userid1", //发送uid
"receiver": "userid2", //接收uid
"conver_type": 1, // 1:private 2:group 3:chatroom
"msg_type": "text",
"msg_content": "Hello, world!",
"mention_info":{
"mention_type":"mention_all",
"target_user_ids":["userid1","userid2"]
},
"msg_id": "123",
"msg_time": 1718980832156
}
]
}