Skip to content

推送通知

基本信息

中文名: 推送通知

接口名: /im/push/notify

所在目录: 消息

调用方式: POST(HTTPS)

发布版本: V3.0.3

请求参数

参数是否必填类型说明
data必填String待推送消息,类型为JSONObject
└sender必填string发起方用户id或者应用名
└recipients必填string[]推送目标, 不可为空。类型为JSONObject:<br/>[“111”, “222”]表示发给用户ID为111或222的设备,列表长度不能超过100
└setting可选object推送设置,可为空
└└request_id可选string请求id,可用于日志追踪
└└create_time可选int64消息创建时间,不设置会取当前时间
└└push_strategy可选string推送策略: <br/>combined - 表示先使用sync通道进行在线推送,用户不在线,则使用厂商通道进行通知推送;syncpush_only - 表示只使用sync通道进行在线推送; ospush_only - 表示只使用厂商通道进行通知推送。<br/>可为空,为空则默认为ospush_only。<br/>combined 本期暂不支持。
└message必填object推送内容, 不可为空。类型为JSONObject:
└└type可选int消息类型扩展字段:1 - 文本。可为空,为空则默认为文本;
└└ content必填object消息内容,长度上限为62个字符,20个汉字,超过限制推送失败
└sync_data可选objectsync通道推送内容。类型为JSONObject。<br/>当push_strategy选择为combined或者syncpush_only时,必填。
└└ topic必填string消息主题,每条消息必须携带topic,供三方应用订阅消费
└└ data必填string数据内容,长度限制2MB

返回参数

参数类型说明
successbool请求是否成功。true:请求成功,false:请求失败
bizErrorCodeString错误码
contentobject
└ successbool业务处理是否成功
└ responseCodeString业务处理错误码
└ responseMessageString业务处理错误信息
└ dataobject
└└ task_idString本次推送的任务id,全局唯一,方便全链路追踪、问题排查