推送消息到Android设备端,消息通过阿里云推送自有通道下发。设备上App接收到消息后,需要自行处理后续动作,比如实现业务行为,或者构造本地通知弹出等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
 - 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
 - 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
 - 对于不支持资源级授权的操作,用
全部资源表示。 
 - 条件关键字:是指云产品自身定义的条件关键字。
 - 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
 
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| mpush:PushMessageToAndroid | none | *全部资源 * | 
  | 无 | 
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| AppKey | long | 是 | 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 | 
返回参数
示例
正常返回示例
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. | 服务端错误,建议重试,仍然失败则提工单 | 
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | 
|---|---|---|
| 2024-01-22 | OpenAPI 错误码发生变更 | 查看变更详情 | 
| 2023-10-12 | OpenAPI 去除了 deprecated 标记、OpenAPI 入参发生变更 | 查看变更详情 | 
