Get SMS programs REST API

Requirements to use this API

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

Attribute	Description	Example
id	SMS program ID	123456
programName	SMS program name	Presidents Sale
campaignName	SMS campaign name (as specified in SMS Campaign Manager)	Spring Promo 2018
code	Short/long code for the SMS program	87767
senderId	SMS sender ID Note: Not supported for all countries	FASHION4YOU
status	SMS program status	ACTIVE
type	SMS program type	TEXT_TO_JOIN
country	SMS program country	US

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

Scenario	Response code	Message
Success	200	---
User is not on an SMS-enabled org	403	Forbidden

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