API Settings

API Settings

To learn more about our API, visit the API documentation

API Settings

SettingDescription
API KEYThe 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 URLThe URL used to send the API requests.
LimitThe set API limit for requests.
Whitelisted IP AddressesIP 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.

HTTP 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.

HTTP API - Messaging, Email, Wallet, and Account

For more information on HTTP API, visit the HTTP API page on the API documentation.

MM7 API

MM7 API

SettingDescription
MM7 ThroughputThe MM7 request throughput (per second).
Basic AUTH Username/PasswordThe username/password used for authentication when making a MM7 request.
MM7 VersionThe 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.

Settings FAQs

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.

RequestDescription
GETA 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

$api_url/api?action=$action&api_key=$api_key&data1=$data1&data2=$data2…

XMLUse 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
$api_key
$data1
$data2

API varsDescription
actionThe 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.

in Accounts