SMS API Banner

Getting Started

To integrate your platform or services with our Application Programming Interface (API), you’ll need to begin with these three simple steps:

  1. 1. Create an account. You must establish an account which will be linked to your API key.
  2. 2. Get an API key. After creating your account, login and contact us for an API key through the Support Request Page. You will then be given an API contract regarding our opt-in and anti-spam policies. Once you’ve reviewed and signed the contract, submit it to our Support team. After your request has been approved, you will be issued a unique API key.
  3. 3. Choose an API protocol. Our API can be accessed through two different protocols: REST and HTTP. Review our REST and HTTP features pages as well as our handy Comparison Guide, to choose the programming style that best fits your needs.
top

Setting Up the REST API

Once you have your API key, you can begin coding. Each type of call made through the REST API is a uniform resource identifier (URI) that identifies a resource and a method. Methods are defined explicitly with one-to-one mapping between create, read, update, and delete (CRUD) operations and the following four HTTP-based methods.

HTTP Method CRUD Operation Change Resource
PUT Create resources Change
GET Read, or retrieve, resources Does not change
POST Update resources Change
DELETE Delete resources Change

Sending a message through our API, for example, requires the following logical steps:

  1. 1. Create your contact database. Before you can start sending messages to your existing contacts, you need to set up at least one distribution list to add the contacts to. You can do this with the PUT List resource call. A response will be returned with the request ID and list ID for your reference.
  2. 2. Add contacts. Then, you can add contacts (i.e., subscriptions) to your list with PUT Subscription. You must indicate the list ID of the distribution list the contact(s) will be added to. Then you can provide such optional parameters as the contact’s first name, last name, phone numbers (mobile and/or landline), and email address. A request ID will be returned which can be used to retrieve the results through the GET Status Report call.
  3. 3. Send a message. Now that you have your list and subscriptions stored on our system, you can begin sending messages. To send a message, you use the PUT Message resource call and provide the relevant parameters. For an SMS message, that would simply be the message itself and the recipients’ subscription IDs. An email message, on the other hand, requires a subject line in addition to message content. A reply to address is optional. You can even schedule precisely timed delivery of your message through the send date parameter.

* New contacts can join your distribution lists on their own by sending a text message that includes your mobile keyword, which is a unique one-word phrase that you create, to your assigned shortcode. You can create a mobile keyword through the API with the PUT Keyword resource call.

For complete information about all the available resource calls as well as coding parameters, templates, and examples, see the REST API Guidelines. Also, if you’re stuck or have a question, feel free to contact us through the Support Request page.

top

Setting Up the HTTP API

The HTTP version of our API has similar functionality and logic. Like the REST API, each type of call made through the HTTP API is a uniform resource identifier (URI) that identifies a resource and the POST method.

Using our API requires the following logical steps:

  1. 1. Create your contact database. Before you can start sending messages to your existing contacts, you need to set up at least one distribution list to add the contacts to. You can do this with the Create List resource call. A response will be returned with the list name for your reference.
  2. 2. Add contacts. Then, you can add contacts (i.e., subscriptions) to your list with the Add Contact to List call. You must indicate the list name of the distribution list the contact(s) will be added to. Then you can provide such optional parameters as the contact’s first name, last name, phone numbers (mobile and/or landline), and email address. A request ID will be returned which can be used to retrieve the results through the Check Response call.
  3. 3. Send a message. Now that you have your list and subscriptions stored on our system, you can begin sending messages. To send a message to a list of contacts, you use the Send to List resource call and provide the relevant parameters. For an SMS message, that would simply be the message itself and the recipients’ subscription IDs. An email message, on the other hand, requires a subject line in addition to message content. A reply to address is optional. You can even schedule precisely timed delivery of your message through the later time parameter.

* New contacts can join your distribution lists on their own by sending a text message that includes your mobile keyword, which is a unique one-word phrase that you create, to your assigned shortcode. You can create a mobile keyword through the API with the PUT Keyword resource call.

For complete information about all the available resource calls as well as coding parameters, templates, and examples, see the HTTP API Guidelines. Also, if you’re stuck or have a question, feel free to contact us through the Support Request page.

top