Get SMS Deployment API

This API is used to get all the Purposes that are available in the tenant.

📘
Know your endpoint
Based on the domain you use to log in to Webex Campaign, the endpoint domain for your API varies. For more information, refer to the Know Your API Endpoints section.

Headers

The following table describes the request headers:

Request Header	Description
content-type	application/json
authorization	Access token or API Secret Key in Bearer format Example: `Bearer $(key)`

Request Parameters

Parameter	Type	Mandatory	Description
name	String	Yes	Specifies the name of the purpose.
group	String	No	Specifies the group of the purpose. If the group is not specified, then the purpose will be created under "Default" group.
description	String	No	Specifies the description of the purpose.

Request Example

https://yourapihubdomain.io/v1/campaigns/16552021700017/deployments/SMS_1673354051193000121

Response Parameters

This API will return the following response parameters:

Parameter	Type
prepareTGEnabled	Returns if the prepare TG feature is enabled or not.
campaignInfo	Returns the campaign info object. The parameters are: campaignId: businessStakeHolder:
deploymentInfo	Returns the deployment info object. The parameters are: deploymentName contentType deploymentType promotionType channel senderId scheduleMode instantType * milestone
targetGroup	Returns the target group object. targetGroupIds: Returns an array of target group ids. _policyConfigurationEnabled: Returns if the policy configuration is enabled. globalExclusionEnabled: Returns if the global exclusion is enabled. exclusionOptionnEnabled": Returns if the exclusion option is enabled. removeDuplicates: Returns if the duplicates have to be removed. controlGroupEnabled: Returns if the control group is enabled. controlType: Returns the control type. limitContactsEnabled: Returns if the limit contacts is enabled. limitContactsCondition: Returns the limit contacts condition. seedlistEnabled: Returns if the seed list is enabled. addNoteToSeedMessage: Returns if the note to seed message. _ waitInterval**: Returns the wait interval in minutes.
reportTags	Returns the reporting tags object. pandls: Returns the P and L object. id: Returns the id of the P and L. name: Returns the name of P and L. purposes: Returns the purposes object. categoryId: Returns the category id. categoryGroup: Returns the category group. The default option is DEFAULT. _ categoryName: Returns the category name. _ segment code: Returns the segment code": * optOutCategory: Returns the opt out category.
router	Returns the router object. routerId: Returns the router id. tps: Returns the TPS (transactions per second) for the router. * isAutoTps: Returns if the auto TPS is enabled.
schedule	Returns the schedule object. * immediateCalendar: Returns the calendar.
advancedOptions	Returns the advanced options object. retryNeeded: Returns if retry is needed or not, drRequired: Returns if the delivery receipt is need or not. messageValidityEnabled: Returns if the message validity is enabled. messageValidity: Returns the message validity in numbers. messageValidityFormat: Returns the message validity format. offerValidityEnabled: Returns if the offer validity is enabled or not. isRetryNeeded: Returns if the retry is needed or not. maximumAttempts: Returns the maximum attempts.
smsDeploymentInfo	Returns the SMS deployment details. _ smscontent: Returns the SMS content object. senderId: Returns the sender id. content: Returns the content in base 64 format. messageType: Returns the message type. linkTrackInfo: Returns the link tracking information. linkId: Returns the link id. shortLinkSendingOption: Returns the short link sending option. The options are 0 - common 1 - unique expectedCtr: Returns the expected click to ratio. linkName: Returns the link name. linkTracking: Returns if the link tracking is enabled. mainUrl: Returns the main URL in base 64 encoded format. _ shortUrl: Returns the short URL in base 64 encoded format.
reserveDaysType	Returns exclusion days.
reserveTimingsType	Returns exclusion timings.
ruleBasedSuppressionIds	Returns the rule based suppression ids.

Response Example

{
    "prepareTGEnabled": true,
    "campaignInfo": {
        "campaignId": "16717064610166",
        "businessStakeHolder": "sales"
    },
    "deploymentInfo": {
        "deploymentName": "FROM_API_CHECK_1",
        "contentType": 1,
        "deploymentType": 1,
        "promotionType": 1,
        "channel": 0,
        "senderId": "CONNCT",
        "scheduleMode": 1,
        "instantType": 0,
        "milestone": 11
    },
    "targetGroup": {
        "targetGroupIds": [
            "16618489060004"
        ],
        "policyConfigurationEnabled": true,
        "globalExclusionEnabled": true,
        "exclusionOptionnEnabled": false,
        "removeDuplicates": true,
        "controlGroupEnabled": false,
        "controlType": 0,
        "limitContactsEnabled": false,
        "limitContactsCondition": 0,
        "seedlistEnabled": false,
        "addNoteToSeedMessage": false,
        "waitInterval": 0
    },
    "reportTags": {
        "pandls": {
            "id": 562,
            "name": "QA_API_3008202212"
        },
        "purposes": [
            {
                "categoryId": 724,
                "categoryGroup": "DEFAULT",
                "categoryName": "QA_Purpose_06102022"
            },
            {
                "categoryId": 725,
                "categoryGroup": "DEFAULT",
                "categoryName": "AT_PURPOSE10Nov2022"
            }
        ],
        "segmentCode": "2112",
        "optOutCategory": "-1"
    },
    "router": {
        "routerId": "NGMP_SMS_LIVEQ",
        "tps": 1,
        "isAutoTps": false
    },
    "schedule": {
        "immediateCalendar": true,
        "calendarId": "Default",
        "waitPeriod": 0,
        "scheduleType": 7,
        "runPeriod": 0,
        "runScheduleType": 0
    },
    "advancedOptions": {
        "retryNeeded": false,
        "drRequired": 1,
        "messageValidityEnabled": true,
        "messageValidity": 0,
        "messageValidityFormat": "D",
        "offerValidityEnabled": false,
        "isRetryNeeded": false,
        "maximumAttempts": 0
    },
    "smsDeploymentInfo": {
        "smscontent": [
            {
                "senderId": "CONNCT",
                "content": "£$@& €лва ¢ ¥  % &( ) * + , - . / : ; < = > ?\n{asset_links_16648741360002}",
                "messageType": "normal",
                "linkTrackInfo": [
                    {
                        "linkId": "16648741360002",
                        "shortLinkSendingOption": 1,
                        "expectedCtr": 0,
                        "linkName": "QA_Test_Link_04102022",
                        "linkTracking": true,
                        "mainUrl": "https://www.google.com/",
                        "shortUrl": "https://dev1.qa.imicampaign.io/dsltrack/w3d3U6",
                        "expectedClicks": 0,
                        "revenue": 0,
                        "actualCost": 0,
                        "deviceBasedRouting": false,
                        "netRevenue": 0,
                        "autoLinkTracked": false,
                        "trackingEnabled": true
                    }
                ],
                "traiTemplateId": "16582198681091"
            }
        ]
    },
    "reserveDaysType": "1",
    "reserveTimingsType": "1",
    "stakeholders": [],
    "notifications": [],
    "isPrepareTGEnabled": true
}

Failure Response Codes

The API will return code within the response as per the following table in case of failure scenarios.

HTTP Status Code	Code within API Response	Description
400	400	I/O error on post request. Cannot retry due to server authentication, in streaming mode.
401	430	Authorization failed. This resource is not allowed to access using this TOKEN or KEY
401	498	Invalid token or Access token expired
404	404	Not found
405	405	Method not supported
500	500	Internal server error

📘Know your endpoint

Headers

Request Parameters

Request Example

Response Parameters

Response Example

Failure Response Codes

📘
Know your endpoint