Get SMS programs REST API

Use this API to get a list of all active SMS programs with program attributes for a given Org.

Requirements to use this API

  1. Your Acoustic Campaign org must have SMS enabled by provisioning.
  2. A database in your Acoustic Campaign org must have SMS enabled.
  3. 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

GET /channels/sms/programs

Request Parameter

Not required

SMS Program Attributes Returned in Response

AttributeDescriptionExample
idSMS program ID123456
programNameSMS program namePresidents Sale
campaignNameSMS campaign name (as specified in SMS Campaign Manager)Spring Promo 2018
codeShort/long code for the SMS program87767
senderIdSMS sender ID
Note: Not supported for all countries
FASHION4YOU
statusSMS program statusACTIVE
typeSMS program typeTEXT_TO_JOIN
countrySMS program countryUS

Sample Response Body – Success

{
“meta”: {
“attributes”: {},
“generalErrors”: [],
“fieldErrors”: {},
“links”: [],
“nextPageUrl”: null
},
“data”: [
{
“id”: 141528,
“programName”: “1019qa1”,
“campaignName”: “Default Event”,
“code”: “87767”,
“senderId”: “”,
“status”: “ACTIVE”,
“type”: “TEXT_TO_JOIN”,
“country”: “US”
},
{
“id”: 130366,
“programName”: “vh-nike2”,
“campaignName”: “ukcampaign”,
“code”: “87767”,
“senderId”: “UK-87767”,
“status”: “ACTIVE”,
“type”: “TEXT_TO_JOIN”,
“country”: “UK”
}
] }

Response Codes

ScenarioResponse codeMessage
Success200---
User is not on an SMS-enabled org403Forbidden

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/getSmsPrograms_get_4

For example, here’s the link to use if your Org is on Pod 1:
https://api1.silverpop.com/restdoc/#!/channels/getSmsPrograms_get_4