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 username and password used to sign up for your Atmosphere® account).

For more information on receiving your token, check out Atmosphere® API Authentication.

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 /_rest/v4/app/sms/send POST /_rest/v4/app/sms/send Sending SMS Messages
Receive SMS POST /_rest/v4/my/did/sms/webhook POST /_rest/v4/my/did/sms/webhook Receiving SMS Messages
Check Message Status GET /_rest/v4/app/sms/mdr GET /_rest/v4/app/sms/mdr Checking Message Status