调用DescribeMessage根据消息ID查询消息详情。详情包括消息体内容、消息到达情况。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeMessage |
系统规定参数。取值:DescribeMessage。 |
MessageId | Long | 是 | 455888 |
消息ID |
ProjectId | String | 是 | fsgtd5y5r |
iovcc项目工程ID |
RegionId | String | 否 | cn-shanghai |
地域ID |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Message |
消息详情 |
||
AckCnt | Integer | 1 |
消息到达设备数量。 |
Action | String | com.aliyun.iovcc.test |
消息侦听通道。 |
AppKey | String | wTiRKC9m |
客户端应用标识,项目工程下自定义应用appKey。 |
AppName | String | pushdemo |
客户端应用名称。 |
Desc | String | this is desc test |
通知内容描述。 |
ExipiredTime | Long | 1525684245000 |
失效时间,精确到毫秒。 |
GmtCreateTime | Long | 1525681245000 |
消息创建时间,精确到毫秒。 |
Id | Long | 2231942 |
消息ID。 |
Parameter | String | {\"package\":\"com.aliyun.iovcc.test\",\"key1\":\"value1\"}" |
消息参数。 为pkgContent与customCent合并后的json字符串。 |
PredictSendCnt | Integer | 3 |
预期消息到达设备数。 |
ProjectId | String | ssgdghww |
iovcc项目工程ID。 |
SendStatus | Integer | 0 |
消息状态。 0表示发送中;1表示消息发送完成;2表示消息已失效。 |
Title | String | this is a title test |
通知标题。 |
Type | Integer | 2 |
消息类型。 1表示透传;2表示通知。 |
Uri | String | page://broadcast.alios.com |
alios系统专用,用于定位接收消息应用。 |
RequestId | String | sfsgghdhh56666 |
请求ID |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeMessage
&MessageId=455888
&ProjectId=fsgtd5y5r
&<公共请求参数>
正常返回示例
XML
格式
<DescribeMessageResponse>
<Message>
<Id>2231942</Id>
<AppName>ALIOS_JARVIS</AppName>
<AppKey>WS2MptYY</AppKey>
<ProjectId>ssgdghww</ProjectId>
<Type>1</Type>
<SendStatus>1</SendStatus>
<Title></Title>
<Desc></Desc>
<Action>test.action.alios.com</Action>
<Uri>page://broadcast.alios.com</Uri>
<Parameter>{"package":"com.aliyun.iovcc.test","key1":"value1"}</Parameter>
<PredictSendCnt>1</PredictSendCnt>
<AckCnt>1</AckCnt>
<GmtCreateTime>1525256539000</GmtCreateTime>
<ExipiredTime>1525260138000</ExipiredTime>
</Message>
<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>
</DescribeMessageResponse>
JSON
格式
{
"Message":{
"ExipiredTime":1525260138000,
"Type":1,
"Title":"",
"PredictSendCnt":1,
"Action":"test.action.alios.com",
"SendStatus":1,
"Uri":"page://broadcast.alios.com",
"Id":2231942,
"AppName":"ALIOS_JARVIS",
"GmtCreateTime":1525256539000,
"AppKey":"WS2MptYY",
"Parameter":"{\"package\":\"com.aliyun.iovcc.test\",\"key1\":\"value1\"}",
"AckCnt":1,
"ProjectId":"ssgdghww",
"Desc":""
},
"RequestId":"629586FE-CB2E-4742-995E-121F952CEB72"
}
错误码
访问错误中心查看更多错误码。