To learn more about our API, visit the API documentation
|API KEY||The API key used for authentication when making API requests. You can click the “generate new API Key” button to generate a new API key. Note that if you do generate a new API key, you will have to update your scripts with the new API key.|
|API URL||The URL used to send the API requests.|
|Limit||The set API limit for requests.|
|Whitelisted IP Addresses||IP addresses that are not inside the list will not be allowed to make API requests. If empty, then all IP addresses can make API requests. IP addresses with subnet range are supported. For example: 172.16.0.1/24|
Depending on your account, you will have access to either the HTTP API or the MM7 API.
There are four different categories for HTTP API: Messaging, Email, Wallet, and Account. Within each category, there are GET examples for each specific API at the bottom of the API settings page.
For more information on HTTP API, visit the HTTP API page on the API documentation.
|MM7 Throughput||The MM7 request throughput (per second).|
|Basic AUTH Username/Password||The username/password used for authentication when making a MM7 request.|
|MM7 Version||The MM7 version. Version 5.3.0 to 6.8.0 is supported.|
For more information on MM7 API, visit the MM7 API page on the API documentation.
Certain API will generate a PostBack notification that can be sent to your server if you provide a PostBack URL. Depending on your account, you will have access to either the HTTP API PostBack settings or the MM7 API PostBack settings.
|PostBack Type||The type of PostBack that will be submitted. For HTTP API, there are two types of PostBack: Simple HTTP POST (Content-type: application/x-www-form-urlencoded) and XML HTTP POST (Content-type: application/xml). For MM7 API, there is only one type of PostBack: mm7 SOAP.|
|Send PostBack error to email||Add an email here so that PostBack errors will be sent to it.|
HTTP API PostBack
Certain messaging, email, and wallet API will generate a PostBack notification. Here you can turn on or off certain PostBacks. If you turn a particular PostBack on, make sure to provide the appropriate PostBack URL for the PostBack and press the ‘Save’ button.
MM7 API PostBack
Turn on or off MM7 DLR notification sending to the MM7 DLR endpoint URL. If on, then provide the MM7 DLR endpoint URL and press the ‘Save’ button. You can also provide the MM7 MO endpoint URL to receive MM7 MO PostBacks.
Short Code Settings
Select the country and short code to view the settings for a particular short code for the account.
|Short Code Type||Specifies whether the short code is shared by multiple accounts or is dedicated for a single account.|
|MO HELP||Customize the HELP message text that users, subscribed or not, see when they text HELP to the short code. Check the tool tip for a list of variables that can be used in your text. If not configured, then the default generic HELP message text will be used.|
|MO STOP||Customize the STOP message text that users, subscribed or not, see when they text STOP to the short code. Check the tool tip for a list of variables that can be used in your text. If not configured, then the default generic STOP message text will be used.|
|Opt-in consent request by SMS||Customize the opt-in consent request text that users see when they opt-in to a campaign. Check the tool tip for a list of variables that can be used in your text. If not configured, then the default generic request message text will be used.|
|Opt-in consent confirmation SMS||Customize the opt-in consent confirmation text that users see when they confirm their opt-in to a campaign. Check the tool tip for a list of variables that can be used in your text. If not configured, then the default generic confirmation message text will be used.|
|Disable SMS Replies to Reserved Keywords||Check the checkbox to disable standard short code/campaign SMS replies to YES/NO/HELP/STOP messages. Only check this if you have another system replying to reserved keywords.|
|If invalid keyword provided||Enable or disable SMS error message text to users if they submit an invalid keyword via SMS MO. You can customize the SMS error message text. If not configured, then the default generic error message text will be used.|
|Forward to Keyword||If message keyword does not have a match, automatically forward the message to a keyword of your choice.|
|Content Storage||Store the contents submitted via MMS MO on public or private S3|
|If no keyword provided||Enable or disable SMS error message text to users if they submit no keyword via MMS MO. You can customize the SMS error message text.|
|If invalid keyword provided||Enable or disable SMS error message text to users if they submit an invalid keyword via MMS MO. You can customize the SMS error message text.|
|If no valid content attached||Enable or disable SMS error message text to users if they submit invalid content via MMS MO. You can customize the SMS error message text.|
In the Queue settings page, the status summary, carrier summary, and status details for the SMS and MMS queues are displayed as well as the SMS/MMS throughputs.
|Status summary||Check the status and count of SMS/MMS messages in their respective queues. All rows with “processed” status are removed from the queue after 24 hours. All other rows are removed after 3 days.|
|Carrier summary||Check the status and count of SMS/MMS messages based on the carrier in their respective queries.|
|Status details||Check the count of SMS/MMS messages based on the country/short code, user, carrier, and status in their respective queries.|
How can I get access to the API for my account?
Contact us to activate the API settings on your account.
What API requests can I make?
You can get more information on all the API in the API documentation.
How does the HTTP API work?
An HTTP request is sent either through a GET request or an XML POST request.
|GET||A GET request is in the form of a URL containing an action query string. The request is sent to our servers and our platform responds with a status. The typical structure of the request is|
|XML||Use POST to send an XML to the API url. Our server receives the XML and executes the action encoded. The typical structure of the XML is|
|action||The name of the API. For instance, if you want to send an SMS, you would use the sendSMS API and pass the value ‘sendSMS’ in the ‘action’ field.|
|api_key||The api_key is a unique string of characters that identifies the account using the API. All API requests require the api_key to be passed within the ‘api_key’ field. An API key is generated for each account and can be found in the API settings page.|
|data||Each API generally has optional or mandatory data that can be passed within each request. For instance, if you want to send an SMS, you would need to include the phone number to send the SMS to and thus pass the phone number in the ‘to’ field.|
Is HTTPS the only protocol I can use with the API?
No, you may use standard HTTP but we highly recommend that you use HTTPS.
Can I receive API notifications about account activity?
Yes, you can via PostBack notifications. You can receive notifications when someone subscribes or unsubscribes from a campaign. You can also receive notifications upon message receipts or delivery confirmations.
What is SMS/MMS MT DLR?
SMS/MMS MT DLR is for delivery receipts. If you turn these PostBacks on, we will notify you when a message is sent and delivered to an end user.
What are stuck messages?
Stuck MMS messages are messages that the system was unable to process and send. Stuck SMS messages are messages that the system was unable to process the first time and again after the retry period of 5 minutes. Stuck SMS messages may become unstuck during subsequent retries.
Stuck messages indicate there may be some issues such as unreachable gateway server, parse error/sending execution terminated, data missing, or missing/unreachable pass/dynamic image/custom content. The stuck message will be cleared after the queue is cleaned up in 3 days.