Send/Receive SMS with AerFrame API

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 and SMPP are the only ways to send / receive SMS with Aeris devices outside of AerPort™, Aeris’ web-based device management portal. Please ensure your device is powered on prior to sending it an SMS.

Our API supports store and forward depending on how the device is provisioned or if the account is configured for store and forward.

  • MT-SM Store and Forward is supported for Dual Mode A-LH and Coverage SIM.
  • The AerFrame v2 API supports SMS for Dual-Mode A-LH, Global SIM, and City SIM.
  • The AerFrame v1.5 API supports CDMA and Coverage SIM.
  • There are two separate SMPP environments for SMS.
    • One supports CDMA and Coverage SIM.
    • The other supports the other device types (Dual-Mode A-LH, Global SIM, and City Sim).

Note:

Store-and-forward is not a function of the API, but of the device service and provisioning. CDMA devices are provisioned either for direct delivery or store-and-forward. Global SIM is only currently direct delivery. Dual-Mode A-LH is always store-and-forward.

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

Important Qualifiers

Placeholder 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 not available
  • AerFrame is available for devices using GSM technology only.

AerFrame Process Flow


aerframe_process_overview

Send/Receive SMS using AerFrame

1. Create SMS Application

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

  • Account ID: Displayed on the top-right corner of the AerPortTM portal with the account name. For example, if your account name is ABC Ltd and Account ID is 2XXXX then you will find the text ABC Ltd (2XXXX) at the top-right corner
  • Account API Key: Follow these steps to get your API Key:

The API key management screen allows you to view, create, edit, and delete your account's API keys. To access this screen, click Manage API keys under the Quicklinks menu.


Manage API Keys

AerPort will display the API key widget and all API keys already created on your account.


API Key Landing Page

For more information, refer to Manage API Keys article.

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 identifiers 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.

2. Create Notification Channel

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).

3. Create Inbound (MO) SMS Subscription

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_subscript

aerframe_create_mo_subscript

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.

4. Create Outbound (MT) SMS Subscription

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

5. Send SMS (MT)

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

6. Retrieve SMS / Notifications

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
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.