Atmosphere® Messaging SMS Quick Start Guide

Overview

You can get started with the Atmosphere® Messaging APIs in just a few steps.

This guide will walk you through the process of:

  1. Logging in and accessing the SMS Application in the IntelePeer Customer Portal
  2. Enabling numbers for sending and receiving SMS messages through the Atmosphere® Messaging API
  3. Viewing message statistics through reports

Once you have enabled one or more numbers for SMS, you can use the Atmosphere® Messaging API to quickly send an SMS message.

Visit Sending Messages to learn how to send a message using the Atmosphere® Messaging API.

Be sure to visit Basic API Conventions to learn about basic requirements for using the Atmosphere® Messaging API.


 

Logging in and accessing the SMS Application in the IntelePeer Customer Portal

Log in to your IntelePeer account through the IntelePeer Customer Portal (https://customer.intelepeer.com). Click My Applications in the side bar to access the Marketplace.

 

Once you have received the Welcome email for SMS, you will see the SMS button in the Marketplace.

 

The first time you open the SMS Application, the IntelePeer Customer Portal will ask you to authorize the application to access and make changes to numbers in your account. Click Authorize to continue.


 

Enabling Numbers for SMS

Click the SMS button to launch the SMS Management application. It will open to the Provision Number page.

To get your Customer API Key, click the gear icon at the top right, then the Get Key button. Your API Key will then populate for use in your own code. Be sure to save your API Key in a safe place as it will become hidden after it is generated. You can set the expiry date (1 month, 6 months, or 1 year) by clicking the drop-down arrow next to the Get Key button. Secret Input lets you set a password for enhanced security on incoming messages from IntelePeer. Be sure to click the Save button after you have set your Secret Input.

 

On this screen, you will also see the current inventory of your IntelePeer numbers which may be enabled for SMS. You can search for numbers by using the Limit Search To drop down menu or typing in to the Filter By TNs search box.

 

To enable/disable numbers for SMS using the SMS Management Application, simply click the Enable/Disable slider next to the number. A blue spinner wheel with text will indicate that the system is enabling/disabling your number(s)—you are able to continue to work on other numbers while the system is processing. Icon will turn green once number is enabled.

 

If the number was unable to be enabled/disabled in the provisioning process, the slider will turn red and a popup will instruct you to contact our NOC for support – don’t worry, we have experts available 24x7x365!

 

Once Number is SMS-enabled, a gray webhook icon appears.

 

To set webhook, click the icon, enter URL endpoint, and click Save. The webhook will turn green after it has been set. You can also delete webhooks in this screen by clicking Delete webhook.

 

You can enable all numbers or set all webhooks by clicking the Manage TNs drop down and clicking Enable All or Set All Webhooks.

 

You can also enable numbers set webhooks for specific numbers by clicking the check box next to the number(s) you want and then clicking the Manage TNs drop down and clicking Enable Selected or Set Selected Webhooks. Click TN Reports to view reports for selected numbers.


 

Reporting

You can view reporting for all numbers in your account at once or sort first to see reporting on selected numbers only.
 
To view reports for all numbers in your inventory, click the blue Reports button in the top right corner of the screen.


 
You can filter by report period (1 day, 7 days, or 7 days summary) or date range (select using calendar).


 
Report example: Weekly Report – All Enabled


 
Report example: Inbound delivery turned off


 
Report example: Daily Report


 
Report example: Weekly Summary


 
To view details, select report period (1 day, 7 days, 7 days summary), then click bar/line/pie chart slice. You can also filter by “Inbound Processed,” “Inbound Errored,” “Outbound Processed,” or “Outbound Errored.”


 
Example: Hover over data point on May 19th to display Outbound Processed (3)

 
Pop-up with details will appear on the screen.

 
There is also a ? help button with a legend to explain the table results and next steps.


 
Another example: looking at Reports for all numbers in inventory and notice that there was an Inbound Errored, want to find out which number it was:


 
To view reports for specific numbers first, sort your number inventory by selecting the Limit Search To button or Filter by TNs button, or by clicking the checkbox next to the individual number(s), then click TN Reports button.

 

Example: hover over data point to see Outbound Processed (1).

 
Click data point for details.