Using SMS API
Before using SMS APIs, first obtain SMS API credentials and get familiar with common SMS API use cases. You can also view common REST APIs used for SMS messages.
About this task
Common use cases for SMS APIs
| I want to... | Reference 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 | Use the WebMO API to send a virtual MO to an SMS Program |
| Export messages from the SMS Campaign Manager | Export SMS Messages API from the SMS Campaign Manager |
| Get published messages from Acoustic Campaign | REST API to get published messages from Acoustic Campaign |
| Send messages to a contact source | REST API to send SMS to Contact Source |
| Send transactional SMS messages to input contacts having SMS consent managed in Acoustic Campaign | REST API Transactional SMS API |
| Use transactional SMS messages to input contacts having SMS consent managed outside Acoustic Campaign | REST API SMS External Consent |
| Test REST API calls | See Swagger. Paste the following URL in your
browser.
|
| Test SMS APIs that terminate at https://communicatepro.mgage.com | See Test your SMS API Call |
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:
- REST API to get published messages from the IBM® Acoustic Campaign - Use this REST API to get a list of Published SMS / Push messages along with given attributes so that it can be used for further consumption.
- REST API to send SMS to contact source - Use this REST API to send an SMS message to an IBM® 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 perform an SMS send to contacts already opted-in to an SMS program using RECIPIENT_ID, Mobile number or other lookup key values.