/v2/platform/message/send

POST /v2/platform/message/send

This API is used by Mini Program Platform to send service notifications or marketing notifications from a merchant to the super app users.

The message structure of this API is defined by Mini Program Platform. Follow the specifications below when the super app develops this API.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

Request parameters

Field

Data type

Required

Description

Example

messages

Array<Message>

Yes

Indicates the notifications sent to the super app users.

  • Maximum size: 20 elements

See Request sample for details.

extendInfo

String

No

Indicates the extended information about this API.

  • Maximum length: 4096 characters
  • Characters not allowed: special characters such as @ # ?
  • Can be Null.

{

"key": "value"

}

Response parameters

Field

Data type

Required

Description

Example

result

Result

Yes

Indicates the request result such as status and error codes.

See Response sample for details.

messageSendResults

Array<MessageSendResult>

No

Indicates whether the super app successfully receives the notifications and whether a retry is allowed when the super app fails to receive the notifications.

  • Maximum size: 20 elements

Note: This parameter must be returned when the request is successful, that is, the value of result.resultStatus is S. The result of each notification must be returned to this parameter regardless of whether the super app successfully receives the notification.

[

{

"messageId": "2019112719074101000701321",

"success": false,

"retry": false

}

]

extendInfo

String 

No

Indicates the extended information about the response.

  • Maximum length: 4096 characters.
  • Characters not allowed: special characters such as @ # ?
  • Can be Null.

{

"key": "value"

}

How to return the result

Follow the instructions below to return the result (specified in the result parameter) according to your business processing results:

  • If the request is successful, set the value of result.resultStatus to S and the value of result.resultCode to SUCCESS. In this scenario, be sure to return messageSendResults with the following parameters and associated values:
    • messageId: Specify the unique ID generated by Mini Program Platform to identify a notification.
    • success: Specify the value of this parameter as true or false to indicate whether the super app receives a notification successfully.
    • (Optional) retry: When the super app fails to receive a notification, specify the value of this parameter as true or false to indicate whether the super app allows Mini Program Platform to try again.
  • If the status of the request is unknown, set the value of result.resultStatus to U and the value of result.resultCode to UNKNOWN_EXCEPTION.
  • If the request failed, set the value of result.resultStatus to F and specify the value of result.resultCode according to the failure reason.

For more information about how to define your result codes, see the Result codes section below.

Result codes

Check the table below for possible result codes:

Result code

Result status

Result message

SUCCESS

S

Success

PROCESS_FAIL

F

A general business failure occurred. Do not retry.

PARAM_ILLEGAL

F

Illegal parameters. For example, non-numeric input, invalid date.

INVALID_API

F

The called API is invalid or not active.

ACCESS_DENIED

F

Access is denied.

REQUEST_TRAFFIC_EXCEED_LIMIT

F

The request traffic exceeds the limit.

UNKNOWN_EXCEPTION

U

An API call failed, which is caused by unknown reasons.

Samples

The data flow below illustrates how Mini Program Platform sends notifications to the super app server:

/v2/platform/message/send

The steps in the diagram are described as follows:

  1. The merchant calls the /v2/miniprogram/message/send API to send notifications to Mini Program Platform.
  2. Mini Program Platform processes the request based on the channels.
  3. If the channel of notifications is Mini Program Inbox, Mini Program Platform stores the notifications in the mini program's inbox directly for users to access.
  4. If the channel of notifications is SMS, Push, or Super App Inbox, Mini Program Platform calls this API () to send notifications to the super app server.
  5. The super app server returns the result of each notification to Mini Program Platform.
  6. Mini Program Platform returns the result to the merchant.

Request

Reach one user via single channel

The following examples demonstrate the sample requests to reach one user via a single channel:

Push

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330622",
      "templateCode": "HK_PDS_NOTIFY"
    }
  ]
}

SMS

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330622",
      "templateCode": "HK_PDS_SMS"
    }
  ]
}

Inbox

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328230",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    }
  ]
}

Reach multiple users via single channel

The following examples demonstrate the sample requests to reach multiple users via a single channel:

Push

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330622",
      "templateCode": "HK_PDS_NOTIFY"
    },
    {
      "customerId": "210922000023",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330623",
      "templateCode": "HK_PDS_NOTIFY"
    },
    {
      "customerId": "216022004227",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330624",
      "templateCode": "HK_PDS_NOTIFY"
    }
  ]
}

SMS

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330622",
      "templateCode": "HK_PDS_SMS"
    },
    {
      "customerId": "210922000023",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330623",
      "templateCode": "HK_PDS_SMS"
    },
    {
      "customerId": "216022004227",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330624",
      "templateCode": "HK_PDS_SMS"
    }
  ]
}

Inbox

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328230",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "210922000023",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328231",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "216022004227",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328232",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    }
  ]
}

Reach one user via multiple channels

The following examples demonstrate the sample requests to reach one user via multiple channels:

Push & SMS

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330622",
      "templateCode": "HK_PDS_NOTIFY"
    },
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330623",
      "templateCode": "HK_PDS_SMS"
    }
  ]
}

Push & Inbox

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328230",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330622",
      "templateCode": "HK_PDS_NOTIFY"
    }
  ]
}

SMS & Inbox

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328230",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330622",
      "templateCode": "HK_PDS_SMS"
    }
  ]
}

Push & SMS & Inbox

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328230",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330622",
      "templateCode": "HK_PDS_NOTIFY"
    },
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330623",
      "templateCode": "HK_PDS_SMS"
    }
  ]
}

Reach multiple users via multiple channels

The following examples demonstrate the sample requests to reach multiple users via multiple channels:

Push & SMS

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK16673075572644033062",
      "templateCode": "HK_PDS_NOTIFY"
    },
    {
      "customerId": "210922000023",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330622",
      "templateCode": "HK_PDS_NOTIFY"
    },
    {
      "customerId": "216022004227",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330623",
      "templateCode": "HK_PDS_NOTIFY"
    },
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330624",
      "templateCode": "HK_PDS_SMS"
    },
    {
      "customerId": "210922000023",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330625",
      "templateCode": "HK_PDS_SMS"
    },
    {
      "customerId": "216022004227",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330626",
      "templateCode": "HK_PDS_SMS"
    }
  ]
}

Push & Inbox

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://exampled.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328230",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "210922000023",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328231",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "216022004227",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328232",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330622",
      "templateCode": "HK_PDS_NOTIFY"
    },
    {
      "customerId": "210922000023",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330623",
      "templateCode": "HK_PDS_NOTIFY"
    },
    {
      "customerId": "216022004227",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330624",
      "templateCode": "HK_PDS_NOTIFY"
    }
  ]
}

SMS & Inbox

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328230",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "210922000023",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328231",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "216022004227",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328232",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330622",
      "templateCode": "HK_PDS_SMS"
    },
    {
      "customerId": "210922000023",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330623",
      "templateCode": "HK_PDS_SMS"
    },
    {
      "customerId": "216022004227",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330624",
      "templateCode": "HK_PDS_SMS"
    }
  ]
}

Push & SMS & Inbox

copy
{
  "messages": [
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328230",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "210922000023",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328231",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "216022004227",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000060176\"}",
      "messageChannel": "INBOX",
      "messageContent": "{\"zh-HK\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"點擊查看詳情\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\",\"en-US\":\"{\\\"header\\\":{\\\"appIcon\\\":\\\"https://example.com/storage/gmpop/2022/08/12/634db75863eb4f5aa73f02956feded61/20cf7dbded356bcca3862cb5ce24d559.jpeg\\\",\\\"appName\\\":\\\"测试商户\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"body\\\":{\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed.\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}},\\\"footer\\\":[{\\\"linkName\\\":\\\"Click to see details\\\",\\\"target\\\":{\\\"path\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DpTmwpy\\\"}}]}\"}",
      "messageId": "000ALIPW3HK166730755727530328232",
      "templateCode": "TC_NOTIFICATION_MINIAPP"
    },
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330622",
      "templateCode": "HK_PDS_NOTIFY"
    },
    {
      "customerId": "210922000023",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330623",
      "templateCode": "HK_PDS_NOTIFY"
    },
    {
      "customerId": "216022004227",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "PUSH",
      "messageContent": "{\"zh-HK\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"您的訂單已完成。\\\",\\\"content\\\":\\\"测试商户 - 訂單 #123456 已完成。 點擊查看詳情。\\\"}\",\"en-US\":\"{\\\"linkUrl\\\":\\\"testsuperapp://platformapi/startapp?appId=2102020131906591&page=%2Fpages%2Fsecond%2Fsecond&sourceInfo=trackingCode%3DzzCMso\\\",\\\"title\\\":\\\"Your order is completed.\\\",\\\"content\\\":\\\"Testing merchant - Order #123456 is completed. Click to see details.\\\"}\"}",
      "messageId": "000ALIPW3HK166730755726440330624",
      "templateCode": "HK_PDS_NOTIFY"
    },
    {
      "customerId": "216022004226",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330625",
      "templateCode": "HK_PDS_SMS"
    },
    {
      "customerId": "210922000023",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330626",
      "templateCode": "HK_PDS_SMS"
    },
    {
      "customerId": "216022004227",
      "extendInfo": "{\"platformTemplateCode\":\"2022081611151188061000930176\"}",
      "messageChannel": "SMS",
      "messageContent": "{\"en-US\":{\"content\":\"Your order is completed.\"},\"zh-HK\":{\"content\":\"您的訂單已完成。\"}}",
      "messageId": "000ALIPW3HK166730755726440330627",
      "templateCode": "HK_PDS_SMS"
    }
  ]
}

Response

The following sample codes demonstrate the possible responses:

Successful

One notification

When the request to send a notification is successful, specify the result parameter and return the result as follows:

  • If the super app receives a notification successfully, specify the value of success as true:
copy
{
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "Success.",
    "resultStatus": "S"
  },
  "messageSendResults": [
    {
      "messageId": "000ALIPW3HK166730755727530328230",
      "success": true,
      "retry": false
    }
  ]
}
  • If the super app fails to receive a notification and does not allow for a retry, specify the value of success as false and the value of retry as false:
copy
{
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "Success.",
    "resultStatus": "S"
  },
  "messageSendResults": [
    {
      "messageId": "000ALIPW3HK166730755727530328230",
      "success": false,
      "retry": false
    }
  ]
}
  • If the super app fails to receive a notification and allows for a retry, specify the value of success as false and the value of retry as true:
copy
{
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "Success.",
    "resultStatus": "S"
  },
  "messageSendResults": [
    {
      "messageId": "000ALIPW3HK166730755727530328230",
      "success": false,
      "retry": true
    }
  ]
}

Multiple notifications

When the request to send multiple notifications is successful, specify the result parameter and return the result of each notification as follows:

  • When the super app receives a notification successfully, specify the value of success as true.
  • When the super app fails to receive a notification and does not allow for a retry, specify the value of success as false and the value of retry as false.
  • When the super app fails to receive a notification and allows for a retry, specify the value of success as false and the value of retry as true.

See the following sample code:

copy
{
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "Success.",
    "resultStatus": "S"
  },
  "messageSendResults": [
    {
      "messageId": "000ALIPW3HK166730755727530328230",
      "success": true,
      "retry": false
    },
    {
      "messageId": "000ALIPW3HK166730755727530328231",
      "success": false,
      "retry": false
    },
    {
      "messageId": "000ALIPW3HK166730755727530328232",
      "success": false,
      "retry": true
    }
  ]
}

Failed or unknown

copy
{
    "result": {
        "resultCode": "<A result code defined in Result codes section>",
        "resultStatus": "<A result status: F or U>",
        "resultMessage": "<A result message defined in Result codes section>"
    }
}
  • result.resultStatus is F or U, which shows the request to send the notifications is failed or unknown.
  • Return the result as defined in the Result codes section.