Using the SMS API from the Atmosphere® Portal

Generate Authentication Token

To use any of the IntelePeer APIs, you will need to access the IntelePeer Authentication API to generate a token. This API requires your Atmosphere Portal credentials (the email address and password used to sign up for your Atmosphere account).

Send a POST request containing your username and password to this URL:

https://atmosphere.intelepeer.com/_rest/v4/authenticate

Here’s an example request:

{

     “username”: “sms_user@example.net”,

     “password”: “Password123”

}

A successful response will contain your authentication token. Once you have that, you’re ready to build!

Please note that all requests require the Accept header set to “application/json”, and all POST requests require the Content-Type header set to “application/json”.

Using the SMS APIs

To use the APIs, you must have an SMS-capable number associated with your Atmosphere Portal account. If you are on an Atmosphere Starter account, you will need to use your Starter number or contact us to order a new SMS-enabled number, short code, or alphanumeric sender ID.

The API URLs and their corresponding documentation are below. Please note that while the documentation is the same, the API URL is different for users in the Atmosphere Portal. Those URLs are referenced in the table below next to the corresponding API functionality. All API requests must contain the Authorization token that you retrieved using the Authenticate API above.

Functionality

API URL for European numbers

API URL for all other numbers 

More Information

Send SMS

POST https://eu.api.intelepeer.com

/_rest/v4/app/sms/send

POST              https://api.intelepeer.com
/_rest/v4/app/sms/send

Sending SMS Messages Documentation

Receive SMS

POST https://eu.api.intelepeer.com
/_rest/v4/my/did/sms/webhook

POST https://api.intelepeer.com
/_rest/v4/my/did/sms/webhook

Receiving SMS Messages Documentation

Check Message Status

GET https://eu.api.intelepeer.com
/_rest/v4/app/sms/mdr

GET https://api.intelepeer.com
/_rest/v4/app/sms/mdr

Checking Message Status Documentation