Atmosphere® API: The Basics

 

Here are the basic items to keep in mind when utilizing the Atmosphere® API:

 

Authentication

All API calls require the use of an Authentication Token. Learn more about the Authentication token in Atmosphere® API Authentication

 

Content Type

All API POSTs require the Content-Type header to be set to application/json.

 

Protocol

All API requests need to be made using HTTPS

 

Long Code, Short Code and Alphanumeric Sender ID Formatting for API Use

 

Long Code Format for API use:

When supplying an API with a long code (or telephone number), the API expects the code to be in E.164 format. When this code is being supplied in the URL, the “+” of the E.164 format is expected to be url encoded as “%2B”.

 
Short Code and Alphanumeric Sender ID Format for API use:

When supplying an API with a short code or alphanumeric sender ID, the API expects the code to be in the following format:

 

{countrycode}-{code}

  • {countrycode} is the countrycode for which the shortcode or alphanumeric sender ID resides
  • {code} is the actual code

 

Examples:

 

  • A USA short code (88888) would be formatted as 1-88888
  • A Colombia shortcode (12345) would be formatted as 57-12345
  • A Spain Alphanumeric Sender ID (Hello8) would be 34-Hello8