Retrieve SMS Campaign Properties
Use this interface to retrieve a SMS Campaign’s properties. A successful response returns the campaign object properties.
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 fetched.
Request Method:
GET
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body - Required Properties:
Not applicable
Sample Request Body
Not applicable
Sample Response Body - Success
{
"generalInfo": {
"id": <smsCampaignId>,
"folderName": "Folder_Name",
"purpose": "Promotional",
"description": "<description>",
"marketingStrategy": "<strategy>",
"marketingProgram": "<marketingProgram>",
"template": "Custom",
"assignedOrganizations": null
},
"dataSources": [
{
"id": "<dataSourceID>",
"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": ""
}
}
Note: See SMS Campaigns Object Properties Reference for a full list of properties.
Sample Response Body - Failure
400 Bad Request
Invalid campaign type: Requests fail if the campaign specified in the request is not a SMS campaign. The error resembles:
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "Invalid Campaign Type.",
"errorDetails": []
}
404 Not Found
Campaign not found: If the campaign name specified cannot be found or is invalid, the error will resemble the following:
{
"type": "",
"title": "Campaign not found",
"errorCode": "CAMPAIGN_NOT_FOUND",
"detail": "Campaign not found",
"errorDetails": []
}