Merge members into a profile list & trigger SMS messages to them (HA Merge Trigger SMS)
Use this interface to merge members into a profile list and trigger SMS messages to them.
Service URL:
/rest/haApi/v1.3/campaigns/{campaignName}/sms
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 SMS 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 Merge Trigger SMS 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:
{
"mergeTriggerRecordData": {
"mergeTriggerRecords": [
{
"fieldValues": ["1001", "foo.bar@oracle.com", "6505551212", "US"],
"optionalData": [
{ "name": "CITY_", "value": "San Bruno" }
]
},
{
"fieldValues": ["1002", "baz.foo@oracle.com", "6505551212", "US"],
"optionalData": [
{ "name": "CITY_", "value": "San Francisco" }
]
}
],
"fieldNames": [
"CUSTOMER_ID_",
"EMAIL_ADDRESS_",
"MOBILE_NUMBER_",
"MOBILE_COUNTRY_"
]
},
"mergeRule": {
"htmlValue": "H",
"matchColumnName1": "CUSTOMER_ID_",
"matchColumnName2": null,
"optoutValue": "O",
"optinValue": "I",
"insertOnNoMatch": true,
"defaultPermissionStatus": "OPTIN",
"rejectRecordIfChannelEmpty": "E",
"updateOnMatch": " NO_UPDATE ",
"textValue": "T",
"matchOperator": "NONE"
}
}
Response Body Properties
Same as the standard Merge Trigger SMS response.
Sample Response:
[
{
"errorMessage" : null,
"success" : true,
"recipientId" : 72067
},
{
"errorMessage" :” RECIPIENT_STATUS_UNDELIVERABLE: Recipient deliverability status is undeliverable ”,
"success" : false,
"recipientId" : -1
}
]
Merge members into a profile list & trigger SMS messages to them (HA Async Merge Trigger SMS)