What’s here?

This tutorial demonstrates how to use the Chrome REST client to send and receive SMS using AerFrame™.

AerFrame API – REST interface

Aeris supports communication with your devices via mobile-originated (MO) and mobile-terminated (MT) SMS, using a set of APIs called AerFrame. Because AerFrame is available over the public internet, no VPN is required.

AerFrame can be accessed with any client that supports RESTful APIs, such as Google Chrome’s Advanced Rest Client.

Security benefits

AerFrame is the only way to send / receive SMS with Aeris devices outside of AerPort™, Aeris’ web-based device management portal.

Our API does not support store and forward. Please ensure your device is powered on prior to sending it an SMS.

After a message has been retrieved (step 6 in this tutorial) it is purged from the system and no longer available.

Important Qualifiers

Placeholders for identifiers you enter in the REST client are denoted with open and close brackets ({…}). These brackets must be removed for your requests to be accepted by the API (i.e. the identifiers you provide must not be surrounded by the brackets).

Sending SMS to an external number is only available with pre-approval from Aeris.

AerFrame is available for devices using GSM technology only.


AerFrame Process Flow

aerframe_process_overview

Send / receive SMS using AerFrame

Create SMS Applicationsteps

The first step to access the AerFrame API is creating an SMS application. You’ll need these identifiers to do that:

  • Account ID
  • Account API Key

Navigate to your account profile by clicking the User icon on the upper right portion of the AerPort screen:

update_acct_settings

You’ll find both values under API Access near the bottom of the screen:

api_access_keys

With this information you’re ready to create your application using the REST interface.


From the drop-down menu in the Advanced Rest Client, select Creating SMS Application:

aerframe_create_app_2

Here is an example with the identfiers filled in. Note that the identifiers you provide (Account API key, Account ID, Application name, etc.) cannot be enclosed in braces. When you’ve entered your identifiers click Send in the lower right of the screen.

aerframe_create_app_filled_2

Create SMS Application results displayed here:

aerframe_create_app_status201_1 aerframe_create_app_success_code_2

Now you have a valid AerFrame application. With that in place you’re ready to create the other components of your AerFrame interface.

Create Notification Channelsteps

A Notification Channel is a container that stores information related to activity generated by your API application. In this step you’ll create the channel and in a separate step you will subscribe to it.

Select Create Notification Channel from the drop-down:

aerframe_create_notification_channel_1

Enter your application information as shown here:

aerframe_create_notification_channel_2

Create Notification Channel results displayed here:

aerframe_create_notification_status200 aerframe_create_notification_channel_3

You now have a Notification Channel for your API application. In order to access it you’ll need to create subscriptions, one for inbound SMS (MO) and one for outbound SMS (MT).

Create Inbound (MO) SMS Subscriptionsteps

An Inbound SMS Subscription allows you to access your API application’s Notification Channel. This section demonstrates how to set it up.

Select Create Inbound (MO) SMS Subscription from the drop-down:

aerframe_create_mo_subscription_1 aerframe_create_mo_subscription_2

Create Inbound SMS Subscription results displayed here:

aerframe_create_mo_subscription_4 aerframe_create_mo_subscription_3

You now have a subscription to access inbound SMS (MO) information generated by your API application.

Create Outbound (MT) SMS Subscriptionsteps

An Outbound SMS Subscription allows you to access your API application’s Notification Channel. This section demonstrates how to set it up.

Select Create Outbound (MO) SMS Subscription from the drop-down:

aerframe_create_mt_subscription_1 aerframe_create_mt_subscription_2

Create Outbound SMS Subscription results displayed here:

aerframe_create_mt_subscription_3 aerframe_create_mt_subscription_4

Send SMS (MT)steps

This section demonstrates the process for sending SMS to a device on the Aeris network through the AerFrame API.

Enter your SMS information as shown here:

aerframe_send_sms_1 aerframe_send_sms_2

Send SMS (MT) results displayed here:

aerframe_send_sms_3 aerframe_send_sms_4

Retrieve SMS / Notificationssteps

This step demonstrates how to retrieve SMS your devices send, as well as retrieve delivery notifications for inbound (MT) SMS.

Select Application will consume MO SMS and MT SMS Delivery Info from the drop-down:

retrieve-notifications-1

Enter your account information as shown here:

retrieve-notifications-2

Results are displayed here:

aerframe_retrieve_status201_1 aerframe_retrieve_status201_2