Create SMS Campaign
Use this interface to create an SMS campaign object. When using the Advanced API to create an SMS Campaign you can specify the following:
- SMS campaign message details resembling the options available in the Responsys interface including outbound and response message options
- General SMS campaign details and launch information
A successful response returns the campaign object and other campaign properties (echoing the request format).
Note: The Responsys Advanced API is generally available for all Responsys customers.
Service URL:
/rest/api/sms/v1.3/campaigns/{campaignName}
Required Path Parameters:
-
campaignName- Name of the SMS campaign to be created.
Request Method:
POST
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body - Required Properties:
-
generalInfo – General information about the new campaign such as the folder where the campaign will be created.
-
dataSource – Details about the Data Sources for the campaign including Profile List. The properties path, fields, and type must be specified.
-
messageInfo – The SMS campaign message details, including messages and message codes for the SMS campaign.
-
additionalInfo – Additional information about the campaign. Specifying initiationType is required.
Sample Request Body
{
"generalInfo": {
"folderName": "Folder_Name",
"purpose": "Promotional",
"description": "<description>",
"marketingStrategy": "<strategy>",
"marketingProgram": "<marketingProgram>",
"template": "Custom",
"assignedOrganizations": null
},
"dataSources": [
{
"folder": "Folder_Name",
"type": "PROFILE_LIST",
"alias": "<profile_list_alias_name>",
"name": "<list_name>",
"columns": [
{
"alias": "<column_alias_name>",
"name": "<column_name>",
"type": "<column_type>",
"defaultValue": "<column_default_value>",
"lookupKey": true
}
],
"lookupTable": true
},
{
"folder": "Folder_Name",
"type": "PROFILE_EXTENSION",
"alias": "<profile_extension_alias_name>",
"name": "<pet_name>",
"columns": [
{
"alias": "<column_alias_name>",
"name": "<column_name>",
"type": "<column_type>",
"defaultValue": "<column_default_value>",
"lookupKey": true
}
],
"lookupTable": true
}
],
"messageInfo": {
"codeCountries": [
{
"code": "<country_code>",
"country": "<country_name>"
}
],
"outboundMessage": "<sample_outbound_message>",
"resposeMessages": [
{
"keywords": [
"<response_message_keywords>"
],
"keywordType": "<keyword_type>",
"message": "<keyword_message>"
},
{
"keywords": [
"<response_message_keywords>"
],
"keywordType": "<keyword_type>",
"message": "<keyword_message>"
},
{
"keywords": [
"<response_message_keywords>"
],
"keywordType": "<keyword_type>",
"message": "<keyword_message>"
},
{
"keywords": [
"<response_message_keywords>"
],
"keywordType": "<keyword_type>",
"message": "<keyword_message>"
}
],
"enableLinkTracking": false,
"linkTablePath": "<link_table_path>"
},
"additionalInfo": {
"externalTrackingParams": null,
"campaignVariables": null,
"initiationType": "Y",
"externalTracking": "",
"externalTrackingEnabled": false,
"honorPermission": "false",
"emailOptIn": true,
"smsOptIn": false,
"smsOptOutFromAllLists": false,
"active": false
},
"launchOptions": {
"progressAddress": "<progress_notification_email_address>",
"skipAlertEnabled": false,
"skipAlertPercent": 50,
"sentAlertEnabled": false,
"sentAlertPercent": 20,
"startAlertEnabled": "false",
"emptyAlertEnabled": "true",
"failureAddress": "<failure_notification_email_address>",
"withdrawnAddress": "<skipped_launch_notification_email_address>",
"launchRate": ""
}
}
Sample Response Body
{
"generalInfo": {
"id": <smsCampaignId>,
"folderName": "Folder_Name",
"purpose": "Promotional",
"description": "<description>",
"marketingStrategy": "<strategy>",
"marketingProgram": "<marketingProgram>",
"template": "Custom",
"assignedOrganizations": null
},
"dataSources": [
{
"folder": "Folder_Name",
"type": "PROFILE_LIST",
"alias": "<profile_list_alias_name>",
"name": "<list_name>",
"columns": [
{
"alias": "<column_alias_name>",
"name": "<column_name>",
"type": "<column_type>",
"defaultValue": "<column_default_value>",
"lookupKey": true
}
],
"lookupTable": true
},
{
"folder": "Folder_Name",
"type": "PROFILE_EXTENSION",
"alias": "<profile_extension_alias_name>",
"name": "<pet_name>",
"columns": [
{
"alias": "<column_alias_name>",
"name": "<column_name>",
"type": "<column_type>",
"defaultValue": "<column_default_value>",
"lookupKey": true
}
],
"lookupTable": true
}
],
"messageInfo": {
"codeCountries": [
{
"code": "<country_code>",
"country": "<country_name>"
}
],
"outboundMessage": "<sample_outbound_message>",
"resposeMessages": [
{
"keywords": [
"<response_message_keywords>"
],
"keywordType": "<keyword_type>",
"message": "<keyword_message>"
},
{
"keywords": [
"<response_message_keywords>"
],
"keywordType": "<keyword_type>",
"message": "<keyword_message>"
},
{
"keywords": [
"<response_message_keywords>"
],
"keywordType": "<keyword_type>",
"message": "<keyword_message>"
},
{
"keywords": [
"<response_message_keywords>"
],
"keywordType": "<keyword_type>",
"message": "<keyword_message>"
}
],
"enableLinkTracking": false,
"linkTablePath": "<link_table_path>"
},
"additionalInfo": {
"externalTrackingParams": null,
"campaignVariables": null,
"initiationType": "Y",
"externalTracking": "",
"externalTrackingEnabled": false,
"honorPermission": "false",
"emailOptIn": true,
"smsOptIn": false,
"smsOptOutFromAllLists": false,
"active": false
},
"launchOptions": {
"progressAddress": "<progress_notification_email_address>",
"skipAlertEnabled": false,
"skipAlertPercent": 50,
"sentAlertEnabled": false,
"sentAlertPercent": 20,
"startAlertEnabled": "false",
"emptyAlertEnabled": "true",
"failureAddress": "<failure_notification_email_address>",
"withdrawnAddress": "<skipped_launch_notification_email_address>",
"launchRate": ""
}
}