Publishing an Application Message (Deprecated)

project_id

Yes

String

Specifies the project ID.For details about how to obtain the project ID, see Obtaining the Project ID.

endpoint_urn

Yes

String

Specifies the unique resource identifier of the endpoint. To obtain it, see Querying the Endpoints of an Application.

X-Auth-Token

Yes

String

Specifies a user token.

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

message

No

String

Select either message or message_structure.

message: Publish an application message.

message_structure: Publish an application message using a message structure.

Specifies the message content. HMS, APNS, and APNS_SANDBOX are supported.

HMS is a platform for developers to push Android messages.

APNS and APNS_SANDBOX are platforms for pushing iOS messages.

Message content for HMS cannot exceed 2 KB.

Message content for APNS and APNS_SANDBOX cannot exceed 4 KB.

For details about the message content format requirements of the push platform, see the format of the application message body.

HMS transparent push message

{ "hps": { "msg": { "type": 1, "body": { "key": "value" } } } }

Huawei notification push message

{ "hps": { "msg": { "type": 3, "body": { "content": "Push message content", "title": "Push message content" }, "action": { "type": 1, "param": { "intent": "#Intent;compo=com.rvr/.Activity;S.W=U;end" } } }, "ext": { "biTag": "Trump", "icon": "http://upload.w.org/00/150pxsvg.png" } } }

Apple platform message { "aps": { "alert": "hello world" } }

message_structure

No

String

Specifies the message content. HMS, APNS, and APNS_SANDBOX are supported.

HMS is a platform for developers to push Android messages.

APNS and APNS_SANDBOX are platforms for pushing iOS messages.

Message content for HMS cannot exceed 2 KB.

Message content for APNS and APNS_SANDBOX cannot exceed 4 KB.

For details about the message content format requirements of the push platform, see the format of the application message body.

HMS transparent push message

{ "HMS": { "hps": { "msg": { "type": 1, "body": { "key": "value" } } } } }

Huawei notification push message

{ "HMS": { "hps": { "msg": { "type": 3, "body": { "content": "Push message content", "title": "Push message content" }, "action": { "type": 1, "param": { "intent": "#Intent;compo=com.rvr/.Activity;S.W=U;end" } } }, "ext": { "biTag": "Trump", "icon": "http://upload.w.org/00/150pxsvg.png" } } } }

Apple platform message

{ "APNS": { "aps": { "alert": "hello world" } } }

time_to_live

No

String

Specifies message TTL (counting from the time when you make the sending request).SMN will count the time a message already consumed in the SMN system before forwarding it to the mobile push platform. The message will be forwarded only when the time it consumed in SMN is less than the TTL, and the consumed time is deducted from the TTL. If the consumed time has exceeded the TTL, the message will be discarded.The time period is measured in seconds, and the default TTL is 3600s (one hour). The retention period must be a positive integer less than or equal to 86,400 (3600 x 24).

Default: 3600

message_id

String

Specifies the message ID, which is unique.

request_id

String

Specifies the request ID, which is unique.

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error