Before using SMS APIs, get SMS API credentials and learn about the common SMS API use cases listed below.
Common use cases for SMS APIs
|
I want to... |
See the following article(s) |
|
Send SMS messages to an external system |
Use the gateway API to send SMS messages from an external system |
|
Send a virtual MO to an SMS Program |
|
|
Export messages from the SMS Campaign Manager |
|
|
Get published messages from Acoustic Campaign |
|
|
Send messages to a contact source |
|
|
Send transactional SMS messages to input contacts having SMS consent managed in Acoustic Campaign |
|
|
Use transactional SMS messages to input contacts having SMS consent managed outside Acoustic Campaign |
|
|
Test REST API calls |
See Swagger. Paste the following URL in your browser. api-campaign-us-X.goacoustic.com, where x is your pod number. Click here for a complete updated URL list. |
|
Test SMS APIs that terminate at https://communicatepro.mgage.com |
See the Test your SMS API Call section at the bottom of the Get SMS programs REST API article. |
REST APIs for SMS messages
Go to the REST API methods topic to get a complete list of REST APIs, some of which can be used for SMS messages.
Here's a list of common SMS REST APIs:
- Get published messages: Get a list of published SMS/push notifications along with given attributes to use for further consumption.
- REST API to send SMS to contact source: Send an SMS message to an Acoustic Campaign contact source that is published, with the ability to pass in a message name.
- REST API Transactional SMS API - Use this REST API and OAuth credentials to send SMS to contacts already opted-in to an SMS program using RECIPIENT_ID, Mobile number or other lookup key values.