推送消息到Android设备端,消息通过阿里云推送自有通道下发。设备上App接收到消息后,需要自行处理后续动作,比如实现业务行为,或者构造本地通知弹出等。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
mpush:PushMessageToAndroid |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AppKey |
integer |
是 |
AppKey 信息。 |
23267207 |
| Target |
string |
是 |
推送目标。可取值:
|
ALL |
| TargetValue |
string |
是 |
根据 Target 来设定,多个值使用逗号分隔,超过限制需要分多次推送。
|
all |
| Title |
string |
是 |
发送的消息的标题。 |
my title |
| Body |
string |
是 |
发送的消息内容。 |
my body |
| StoreOffline |
boolean |
否 |
消息是否离线保存。StoreOffline 默认设置为 false。 若保存,在推送时候用户不在线,在过期时间(ExpireTime)内用户上线时会被再次发送。ExpireTime 默认为 72 小时。 |
true |
| JobKey |
string |
否 |
推送任务自定义标识,当 JobKey 不为空时,回执日志中会附带该字段。查看回执日志参见回执日志。 |
123 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| MessageId |
string |
标志一次推送的消息 ID。 |
501029 |
| RequestId |
string |
请求 ID。 |
9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC |
示例
正常返回示例
JSON格式
{
"MessageId": "501029",
"RequestId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Invalid%s.Format | The specified %s format is invalid. | 参数格式错误。 |
| 400 | Invalid%s.Empty | The specified %s cannot be empty. | 参数不能为空。 |
| 400 | Invalid.Parameter | The specified parameter is invalid: %s. | 参数%s无效。 |
| 500 | Timeout | The request processing is timeout. | 请求处理超时。 |
| 500 | InternalError | The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket. | 服务端错误,建议重试,仍然失败则提工单 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。