API Overview

The AerFrame 2.1 API includes the following set of APIs:

  • SMS Messaging API

Derived from OMA Restful Short Messaging API. The outbound SMS (mobile-terminated, or “MT”) delivery info and inbound SMS (mobile-originated, or “MO”) are delivered to applications over Notification Channels.

  • Notification Channel Management API

Derived from OMA Notification Channel API. To receive MO-SMS and delivery info for the MT-SMS, applications must register themselves and setup a notification channel. All messages are delivered over Notification Channel. This version of AerFrame supports only the LongPoll Notification Channel.

  • Network Service API

Provides access to operations like Clear Registration and Get Local Dialable Number.

The following diagram describes the API structure.

API-Structure_4

Code Samples

Step 1 – Create SMS Application

Request

    Response

    {"applicationName":"Test Application1","applicationShortName":"testApp1","applicationTag":"test1","description":"A sample AerFrame application","apiKey":"22222222-2222-2222-2222-222222222222","resourceURL":"https://api.aerframe.aeris.com/registration/v2/1234/applications/00000413-9d3d-be61-6232-99c5d661e0d9"}
    Step 2 - Create Notification Channel

    Request

      Response

      {"clientCorrelator":"4321","applicationTag":"test","channelType":"LongPolling","channelData":{"channelURL":"https://longpoll.aerframe.aeris.com/notificationchannel/v2/1234/longpoll/00000f98-83fa-2f2a-3952-04114b6bbbb1","maxNotifications":15},"channelLifetime":7200,"callbackURL":"https://api.aerframe.aeris.com/notificationchannel/v2/1234/channels/00000f98-83fa-2f2a-3952-04114b6bbbb1/callback","resourceURL":"https://api.aerframe.aeris.com/notificationchannel/v2/1234/channels/00000f98-83fa-2f2a-3952-04114b6bbbb1"}
      Step 3 - Create Outbound (MT) SMS Delivery Info Subscription

      Request

        Response

        {"callbackReference":{"notifyURL":"https://api.aerframe.aeris.com/notificationchannel/v2/1234/channels/00169bb3-e0d5-e906-331e-9f50dda27cfb/callback","callbackData":"testApp1-mt-delivery","notificationFormat":"JSON"},"filterCriteria":"SP:*","resourceURL":"https://api.aerframe.aeris.com/smsmessaging/v2/1234/outbound/testApp1/subscriptions/002e20a5-85ab-3f2b-227e-e41a10fea20d","link":[]}
        Step 4 - Create Inbound (MO) SMS Delivery Info Subscription

        Request

          Response

          {"callbackReference":{"notifyURL":"https://api.aerframe.aeris.com/notificationchannel/v2/1234/channels/00169bb3-e0d5-e906-331e-9f50dda27cfb/callback","callbackData":"testApp1-mo","notificationFormat":"JSON"},"destinationAddress":["testApp1"],"criteria":"SP:*","resourceURL":"https://api.aerframe.aeris.com/smsmessaging/v2/1234/inbound/subscriptions/002e2068-786d-7be4-18c5-57a2a46e3afa","link":[]}
          Step 5 - Send MT-SMS

          Request

            Response

            {"address":["204041234567890"],"senderAddress":"testApp1","senderName":"AFTestClient","outboundSMSTextMessage":{"message":"Hello! This is a test message."},"clientCorrelator":"654321","resourceURL":"https://api.aerframe.aeris.com/smsmessaging/v2/1234/outbound/testApp1/requests/00003558-a8b7-7c4d-48d4-d213d08ddd63"}
            Step 6A - Check delivery status of a message sent to your device

            Request

              Response

              'DeliveredToTerminal'
              Step 6B- Read message delivery status

              Request

                Response

                'Message is: Test Message'