调用PushNoticeToAndroid推送通知给Android设备。
接口说明
该接口默认只发送给在线设备,要发送离线保存消息请使用推送高级接口。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | PushNoticeToAndroid |
系统规定参数。取值:PushNoticeToAndroid。 |
AppKey | Long | 是 | 23267207 |
AppKey信息。 |
Target | String | 是 | ALL |
推送目标。可取值:
|
TargetValue | String | 是 | ALL |
根据Target来设定,多个值使用逗号分隔,超过限制需要分多次推送。
|
Title | String | 是 | title |
发送的通知标题。 |
Body | String | 是 | body |
发送的通知内容。 |
JobKey | String | 否 | 123 |
推送任务自定义标识,当JobKey不为空时,回执日志中会附带该字段。查看回执日志参见回执日志。 |
ExtParameters | String | 否 | {"key1":"value1","api_name":"PushNoticeToAndroidRequest"} |
自定义的KV结构,供开发者扩展使用,针对Android设备。该参数要以Json map的格式传入。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
MessageId | String | 501029 |
标志一次推送的消息ID。 |
RequestId | String | 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC |
请求ID。 |
示例
请求示例
http(s)://cloudpush.aliyuncs.com/?Action=PushNoticeToAndroid
&AppKey=23267207
&Body=body
&Target=ALL
&TargetValue=ALL
&Title=title
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<?xml version='1.0' encoding='UTF-8'?>
<PushNoticeToAndroidResponse>
<RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>
<MessageId>501029</MessageId>
</PushNoticeToAndroidResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC",
"MessageId" : "501029"
}
错误码
访问错误中心查看更多错误码。