Appearance
推送通知
基本信息
中文名: 推送通知
接口名: /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 | 可选 | object | sync通道推送内容。类型为JSONObject。<br/>当push_strategy选择为combined或者syncpush_only时,必填。 |
└└ topic | 必填 | string | 消息主题,每条消息必须携带topic,供三方应用订阅消费 |
└└ data | 必填 | string | 数据内容,长度限制2MB |
返回参数
参数 | 类型 | 说明 |
---|---|---|
success | bool | 请求是否成功。true:请求成功,false:请求失败 |
bizErrorCode | String | 错误码 |
content | object | |
└ success | bool | 业务处理是否成功 |
└ responseCode | String | 业务处理错误码 |
└ responseMessage | String | 业务处理错误信息 |
└ data | object | |
└└ task_id | String | 本次推送的任务id,全局唯一,方便全链路追踪、问题排查 |