调用PushMessage推送消息到设备端,支持透传、通知两种消息类型。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Act | String | 是 | com.aliyun.iovcc.action |
广播侦听通道,为客户端与服务端约定配置。 |
Action | String | 是 | PushMessage |
系统规定参数。取值:PushMessage。 |
AppKey | String | 是 | com.aliyun.aicc.test |
cmns客户端应用appKey。 |
AppPackage | String | 是 | com.aliyun.iovcc.cmns.test |
消息归属客户端应用包名。 |
PkgContent | String | 是 | {"package":"com.aliyun.iovcc.cmns.test"} |
android intent属性值参数,为json字符串,用户可选择设置"component","uri","type","package","category"等5个intent属性key。 |
ProjectId | String | 是 | sfgsghd6 |
iovcc项目工程ID。 |
ReceiverType | String | 是 | uuid |
消息接收对象类型。取值:"uuid"、"imei"、"kp"、"terminal"。
|
ReceiverValues | String | 是 | b81d39b0252a4ffdb750360b262cb442, b81d39b0252a4ffdb750360b262cb411 |
消息接收对象值,多个接收对象通过英文逗号拼接。
|
Type | Integer | 是 | 1 |
消息类型。取值:1表示透传消息,2表示通知。 |
CustomContent | String | 否 | {"key1":"value1","key2":"value2"} |
用户自定义内容。 为json字符串,json字符串中不得使用关键字"cmns"作为字段,消息类型为透传(type=1)时必传。 |
Desc | String | 否 | this is desc test |
通知内容详情,消息类型为通知时必传。 |
ExpiredTime | Long | 否 | 7200 |
消息过期时间。 相对时间(即多少秒后过期,单发最多7天,群发消息最多不能超过30天),单位为S,默认1小时过期。 |
RegionId | String | 否 | cn-shanghai |
地域ID。 |
Title | String | 否 | this is test test |
通知标题,消息类型为通知时必传。 |
Uri | String | 否 | page://broadcast.alios.com |
alios4.0专用,alios设备通知和透传消息时必传。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Mid | Long | 354677 |
消息ID。 |
RequestId | String | 629586FE-CB2E-4742-995E-121F952CEB72 |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=PushMessage
&Act=com.aliyun.iovcc.action
&AppKey=com.aliyun.aicc.test
&AppPackage=com.aliyun.iovcc.cmns.test
&PkgContent={"package":"com.aliyun.iovcc.cmns.test"}
&ProjectId=sfgsghd6
&ReceiverType=uuid
&ReceiverValues=b81d39b0252a4ffdb750360b262cb442, b81d39b0252a4ffdb750360b262cb411
&Type=1
&<公共请求参数>
正常返回示例
XML
格式
<PushMessageResponse>
<Mid>354677</Mid>
<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>
</PushMessageResponse>
JSON
格式
{
"Mid":"354677",
"RequestId":"629586FE-CB2E-4742-995E-121F952CEB72"
}
错误码
访问错误中心查看更多错误码。