How it Works

If you have the SMS UBX Sender feature enabled for your Org you will need to use this API to create SMS Text to Join Programs instead of SMS Campaign Manager.

Note:  This API is only available for Orgs that have SMS UBX Sender feature enabled.

Use Case

Use this REST API to create an SMS program when you have the SMS UBX Sender feature enabled for your SMS Org.

Requirements to use this API

  1. Your Watson Campaign Automation org must have SMS enabled by provisioning and be provisioned to send SMS messages through the UBX Sender feature.
  2. A database in your Watson Campaign Automation org must have SMS enabled.
  3. The user making the API call must be enabled for SMS.
  4. The user making the API call must have valid Oauth credentials.

Note: Up to 10 concurrent requests are allowed to our API servers at any given time when using the OAuth method for authentication.

Endpoint

POST /channels/sms/program

Parameters

Attribute: programName

Description: Name of the SMS Program, required, string

Example: Black Friday

Notes: Program Name must be unique and contain between 1 and 50 characters.

Attribute: campaignName

Description: SMS Campaign Name, required, string

Example: 2017 Holiday Sales

Notes: An SMS Campaign may contain one or more programs. Campaign name must be between 1 and 50 characters.

Attribute: code

Description: SMS Program Long/Short Code, required, string

Example: 87767

Notes: SMS code must be numeric. Code will not be used in case of 1-way messaging but is required for the program to be displayed in the user interface.

Attribute: senderId

Description: Sender ID for the SMS Program, optional, string

Example: WATSON

Notes: Not supported in some countries. In case of 1-way messaging, this is required field.

Attribute: status

Description: Status of the SMS Program, required, string

Example:  ACTIVE

Note: API call will fail if status is not ACTIVE

Attribute: type

Description: SMS Program type, required, string

Example: TEXT_TO_JOIN

Note: API call will fail if type is not TEXT_TO_JOIN (not case sensitive).

Attribute: country

Description: SMS program country represented by two alpha characters, required, string

Example: US

Notes: Country will not be used in case of 1-way messaging but is required for the program to be displayed in the user interface.

 

Sample Payload

{

 “programName”: “Black Friday”

 “campaignName”: “2017 Holiday Sales”,

 “code”: “87767”,

 “senderId”: “WATSON”,

 “status”: “active”,

 “type”: “Text_to_Join”,

 “country”: “UK”

}

Response Codes

Scenario

Code

Message

Success

200

 

SMS program name is blank or greater than 50 characters.

400

SMS program name must be between 1 and 50 characters.

SMS campaign name is blank or greater than 50 characters.

400

SMS campaign name must be between 1 and 50 characters.

SMS code contains non-numeric characters.

400

SMS code must be numeric.

SMS program senderId is greater than 11 characters.

400

SMS program senderId must be between 1 and 11 characters.

SMS program status is not ACTIVE.

400

SMS status must be set to ACTIVE.

SMS program type is not TEXT_TO_JOIN or Text_to_Join.

400

SMS program type must be TEXT_TO_JOIN or Text_to_Join.

SMS country code entered is something other than two alpha characters

400

SMS program Country must be valid two character country code.

User is not on an SMS-enabled Org

403

Forbidden

User calling the API is not SMS enabled

403

Forbidden

UBX Sender feature is not enabled for the Org

405

Unsupported Operation

 

Test Your API Call

Use Swagger to test your API call. To access the Swagger environment for your Org, replace {POD#} with the Pod where your Org exists:

https://api{POD#}.silverpop.com/restdoc/#!/channels/sms_to_contacts_post_6

For example, here’s the link to use if your Org is on Pod 1:

https://api1.silverpop.com/restdoc/#!/channels/sms_to_contacts_post_6

Join The Discussion

Your email address will not be published. Required fields are marked *