| 承载协议 | HTTPS POST |
|---|---|
| 接口方向 | 开发者服务器 -> 个推Push服务器 |
| 接口URL | https://oh-push-api.getui.com/v3/[appId]/messages:send [appId]:应用ID,应用开发者提供相应资质和应用信息后,由个推侧提供 |
| 数据格式 | Content-Type: application/json |
| 参数 | 取值描述 | 样例 |
|---|---|---|
| Authorization | 鉴权方式:JWT方式。 详情请见 基于应用信息生成鉴权令牌 文档 建议JWT令牌过期时间设置为3600秒,有效期内可以复用。 Bearer后面拼接空格,再拼接获取的鉴权信息。 |
Bearer eyJr*OiIx---.eyJh*iJodHR--.QRod**4Gp---** |
| push-type | 消息类型,取值如下: 0:Alert消息(通知消息) 2:语音播报消息 6:后台消息 10:应用内通话消息 |
0 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| payload | 是 | Object | 推送消息结构体,不同的push-type场景拥有不同的payload定义: 0:AlertPayload 通知消息 2:ExtensionPayload 语音播报消息 6:BackgroundPayload 后台消息 10:VoIPCallPayload 应用内通话消息 |
| pushOptions | 否 | Object | 发送控制参数,详情请参见请求体参数说明-pushOptions的定义。 |
| target | 是 | Object | 发送目标,详情请参见请求体参数说明-target的定义。 |