Trigger mobile push messages (HA Trigger Push Message)

Use the following API to trigger push messages to existing members of a Profile List and its corresponding App Channel List.

NOTES:

  • The system only replicates the Profile List and App Channel List to the AFTM secondary account. No App Channel Profile Extension Tables (PETs) will be replicated. If the push message needs data from an App Channel List PET, there will be problems triggering it from a secondary account.
  • Trigger Push Message will only work for recipients who are using the mobile app associated with the campaign. For example, if you use listType=Profile and the Profile List member does not have a device registered, the list member will not receive the message. The response payload for the recipient in this situation is NO_RECIPIENT_FOUND.
  • See the Trigger Push Message topic in the REST API for Oracle Responsys Marketing Cloud Service guide for more important information about using this API.

Service URL:

/rest/haApi/v1.3/campaigns/{campaignName}/push

NOTE: For this request, ensure that your path uses haApi instead of api. The haApi part of the path is case sensitive.

Required Path Parameters:

campaignName - Name of the push campaign to be sent to the recipients.

Request Method:

POST

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Request Body Properties:

Same as the standard Trigger Push Message request.

NOTE:Using this API requires adhering to several constraints and guidelines, which are described in the standard Responsys REST API reference guide.

Sample Request Body:

{
    "recipientData": [
        {
            "customerId": null,
            "emailAddress": null,
            "recipientId": null,
            "mobileNumber": null,
            "emailSHA256Hash": null,
            "emailMD5Hash": null,
            "deviceId": "device_Id_value",
            "apiKey": "API_Key_value",
            "listType": "PUSH",
            "optionalData": [
                {
                    "name": "CUSTOM1",
                    "value": "c1a_value_new"
                },
                {
                    "name": "CUSTOM2",
                    "value": "c2a_value_new"
                }
            ]
        },
        {
            "customerId": null,
            "emailAddress": "foo.bar@oracle.com",
            "recipientId": null,
            "mobileNumber": null,
            "emailSHA256Hash": null,
            "emailMD5Hash": null,
            "deviceId": null,
            "apiKey": "API_Key_value",
            "listType": "PROFILE",
            "optionalData": [
                {
                    "name": "CUSTOM1",
                    "value": "c1a_value_new"
                },
                {
                    "name": "CUSTOM2",
                    "value": "c2a_value_new"
                }
            ]
        }
    ]
}

Response Body Properties

Same as the standard Trigger Push Message response. See the Response Notes paragraphs in the Examples section for an explanation of how the response may vary based on the CHANNEL_DELIVERABILITY_STATUS and the CHANNEL_PERMISSION_STATUS settings in the App Channel List.

Sample Response:

The response returns information about each record sent in the request. In this example, the mobile push message was sent successfully to the recipient device whose App Channel List RIID is 72067. (Unlike the responses for Email and SMS, the recipientId in a Trigger Push Message response is always the App Channel List RIID.) For the second record, the trigger push message action was not successful, because listType was set to PROFILE, a record was present in the Profile List, CHANNEL_DELIVERABILITY_STATUS_ is D (Deliverable) in the App Channel List, but the recipient's CHANNEL_PERMISSION_STATUS_ in the App Channel List was set to "O" (OptOut).

[
   {
      "errorMessage" : null,
      "success" : true,
      "recipientId" : 72067
   },
   {
      "errorMessage" :” RECIPIENT_STATUS_UNDELIVERABLE: Recipient deliverability status is undeliverable ”,
      "success" : false,
      "recipientId" : -1
   }
]

Learn more

Merge members into a profile list & trigger email messages to them (HA Merge Trigger Email)

Handling errors and exceptions