A comprehensive guide to the Aerialink Platform Portal v5 (Limited Launch).

The early release of the v5 portal enables users to view messages in the Activity Report and to send test SMS and MMS from the Send Message tool. These tools are meant for quick references with search criteria or troubleshooting purposes. More functionality is coming soon.

Account

Account hierarchy supports three (3) levels:

1. Parent
2. Subaccount 1 (child)
3. Subaccount 2 (grandchild)

Switch User

An account will display a left-hand navigation option named “Switch User” if the user profile belongs to a parent account with subaccounts. A parent account profile user may switch to any child or grandchild account, while a subaccount profile user has permission to switch to any of their own child (parent grandchild) accounts. When they add a new Subaccount 2, their account is inherently its parent. However, a subaccount profile user does not have permission to access their parent’s account, or any of that parent’s other child accounts.

User this feature to log into a sub account without the need for specific credentials.
NOTE: the account will take on the view and permissions of the user profile to which you switch.

Change Account

Please note that the ability to switch accounts will be visible to all Limited Launch v5 users, however the option will only be functional for parent accounts with active subaccounts. For other users, this feature will be non-functional.

Connections

Search Connections

Connections can be searched for by name or either unique system idenifier. A default one-hundred (100) count of webhook entries is displayed based on the default SortBy (“Last Updated - Descending”).

1. Navigate to the “Connections” page in the Configuration section.
2. Enter any identifying parameters in the search fields to specify one or more specific connections. To view all connections on the account, leave all entry fields blank.
3. Change the sorting method if desired.
4. Click “Search.”

View Connection Details

The “View Connection” page provides visibility to additional connection details not provided in the search results output. Here, you will be able to find the following read-only information:

• Connection GUID
• Connection ID
• Created date/time stamp
• Updated date/time stamp
• Connection’s “Active” status
• Account (the account or subaccount to which the connection belongs)
• Connection Name
• Code distribution method
• Default Code
• Destination number formatting configuration
• Connection-level system HELP & STOP keyword replies
• MMS S3 Configuration information
• Message segmentation options
• Message expiration hours
• Other message routing options

To access the “View Connection” page:

1. Locate the desired connection record within the search results.
2. Click the green, eye-shaped “View” icon on the right-hand side under “Actions.”

Create New Connection

1. On the “Connections” page, click the “+” button.
2. Select or deselect the “Connection is Active” checkbox to indicate whether the connection will be active upon creation.
3. Enter a “Name” for the connection. This should be distinct and unique from any other connection on the account.
4. Choose a code distribution method for outbound traffic
5. Indicate whether you wish to use “Destination Number Format” (if selected, Aerialink will process the number as-given without dynamically adding a country code)
6. Provide connection-level system HELP and STOP keyword auto-respones (if desired)
7. Note that opt-outs must always be honored. To have Aerialink enforce opt-outs on your behalf, click “Enforce Opt Out”
8. Enter the relevant AWS S3 information for your MMS configuration.
9. Indicate how you would like long, multi-segment messages to be handled.
10. Choose the number of hours a message will retry before expiring.
11. Check “MO HTTP TLVs” if you wish TLVs to be attached to inbound messages which will be forwarded to your endpoint.
12. Check “Registered Delviery Disable” to override transaction-level requests for DLR (delivery receipts)
13. Check “UTF16 Http Strip” to strip any emoji from inbound messsages and replace with a hyphen (“-“)
14. Click “Create Connection” to generate your new connection.

Edit Connection

The “Edit Connection” page provides access a version of the “View” page which permits adjustment of some connection details:

• Connection’s “Active” status
• Account (the account or subaccount to which the connection belongs)
• Connection Name
• Code distribution method
• Default Code
• Destination number formatting configuration
• Connection-level system HELP & STOP keyword replies
• MMS S3 Configuration information
• Message segmentation options
• Message expiration hours
• Other message routing options

The following information will remain read-only:

• Connection GUID
• Connection ID
• Created date/time stamp
• Updated date/time stamp

Webhooks

Search for Webhooks

Webhooks (referred to in v4 as “Endpoints”) can be searched by name or GUID. A default one-hundred (100) count of webhook entries is displayed based on the default SortBy (“Last Updated - Descending”). However, if you wish to seek out a specific webhook or series of webhooks:

1. Enter the name and/or GUID of the desired webhook you wish to view.
2. Choose the output method.
3. Adjust the sorting if desired.
4. Click “Submit.”

View Webhook Details

The “View Webhook” page provides visibility to additional webhook details not provided in the search results output. Here, you will be able to find the following read-only information:

• Webhook GUID
• Created date/time stamp
• Updated date/time stamp
• Webhook’s “Active” status
• Account (the account or subaccount to which the webhook is configured)
• Name (a friendly name for the webhook)
• URL
• API Method
• Username and password (if applicable)

Create a New Webhook

Note to Resellers: to create webhooks for a specific subaccount, you must switch into that subaccount.

1. On the Configuration > Webhooks page, select the “+”
2. On the “New Webhook” page, click “webhook Active” to enable immediate live functionality.
3. Name the webhook something descriptive which will help you identify it from other webhooks.
4. Enter the destination URL for the webhook request.
5. Enter the API method used by the webhook
6. For webhooks requiring authentication, enter the username and password. (Optional)
7. Select the “Create Webhook” button.

Edit Webhook

The “Edit Webhook” page provides access a version of the “View” page which permits adjustment of some webhook details:

• Webhook’s “Active” status
• Account (the account or subaccount to which the webhook is configured)
• Name (a friendly name for the webhook)
• URL
• API Method
• Username
• Password

The following information will remain read-only:

• Webhook GUID
• Created date/time stamp
• Updated date/time stamp

Routes

Routes enable Aerialink users to customize the flow of traffic for their account based on the configuration of routes and their actions.

Search Routes

A default of one-hundred (100) routes is displayed based on the default SortBy (“Last Updated - Descending”). To search for a specific route:

1. Enter an identifier of the route, or of the connection or account whose routes you wish to view.
2. Adjust sorting method (if desired)
3. Submit.

View Route Detials

The “View Route” page provides visibility to additional route details not provided in the search results output. Here, you will be able to find the following read-only information:

• Route GUID
• Route ID
• Created date/time stamp
• Updated date/time stamp
• Account (the account or subaccount to which the route is configured)
• Connection (the connection to which the route is configured)
• Route Sequence (Indicates the order in which a route is executed in the event multiple routes are utilized)

Create a New Route

Note to Resellers: to create routes for a specific subaccount, you must switch into that subaccount.

1. On the Configuration > Routes page, select the “New” button to create a new route.
2. Choose a connection for the route. Note that the route will only be accessible to the connection chosen here.
3. “Route Sequence” is applicable for those utilizing multiple routes. In that case, the “Route Sequence” will determine the order in which the routes are applied.
4. Click “Create Route”

Edit Route

The “Edit Route” page provides access a version of the “View” page which permits adjustment of some webhook details:

• Account (the account or subaccount to which the route is configured)
• Connection (the connection to which the route is configured)
• Route Sequence (Indicates the order in which a route is executed in the event multiple routes are utilized)

The following information will remain read-only:

• Route GUID
• Route ID
• Created date/time stamp
• Updated date/time stamp

Route Actions

To view and/or edit a route’s Actions, click the yellow, list-like “Actions” icon on the right-hand side of a route entry. This will enable you to adjust actions for inbound and outbound messaging, auto-replies and forwarding for provider proxy services.

1. To alter any forwarding information, click the “edit” button to the right of the ghosted drop-down menu.
2. If any changes are made, ensure that you click “Save Route Actions.”

Keywords

Search Keywords

A default of one-hundred (100) keywords is displayed based on the default SortBy (“Last Updated - Descending”). To search for one or more specific keywords:

1. Enter the keyword or partial keyword or keyword ID if you wish to view a single keyword, OR
2. If you wish to view all keywords on a connection, enter the Connection Name, OR
3. if you wish to view all keywords on a single code, enter the code
4. Choose your output method.
5. Adjust the sorting method (if desired)
6. Choose whether you wish to view only inactive, only active, or all codes by adjusting the “status”
7. Click “Submit.”

View Keyword Details

The “View Keyword” page provides visibility to additional keyword details not provided in the search results output. Here, you will be able to find the following read-only information:

• Keyword GUID
• Keyword ID
• Created date/time stamp
• Updated date/time stamp
• Keyword “Active” status
• Code (the Aerialink code to which the keyword belongs)
• Connection (the connection to which the code belongs)
• Keyword
• Keyword Reply

Create a New Keyword

1. On the Configuration > Keywords page, select the “New” button located below the search entry fields and above the search results output.
2. On the “New Keyword” page, choose whether you wish the keyword to be active by checking the box (for active) or leaving it unchecked (for inactive).
3. In the “Code” field, enter the Aerialink number you wish to respond to the keyword. Note you should only do this if you wish to limit the keyword’s application to a single code.
4. If you wish to associate the keyword to all codes on a connection, choose a connection from the dropdown and leave the “Code” field empty.
5. Enter the keyword. Note that this should be a word or phrase without spaces.
6. Enter the keyword’s reply. Remember to maintain compliance principles in your responses. For more information about compliance, please refer to Aerialink Documentation.
7. Click “Create Keyword.”

Edit Keyword

The “Edit Keyword” page provides access a version of the “View” page which permits adjustment of some keyword details:

• Keyword “Active” status
• Code (the Aerialink code to which the keyword belongs)
• Connection (the connection to which the code belongs)
• Keyword
• Keyword Reply

The following information will remain read-only:

• Keyword GUID
• Keyword ID
• Created date/time stamp
• Updated date/time stamp

Code Management

Search Your Codes

Codes can be searched either directly (by entering one or more known codes in the “Codes” field on the left side) or by applying one or more other criteria to narrow down the results.

The search functionality on the Code Management page may look intimidating on first glance, but it is designed to allow a user to filter by all relevant criteria. A default of one-hundred (100) codes is displayed based on the default SortBy (“Last Updated - Descending”).

Here are some helpful definitions to assist you in using the Code Management search function and interpreting the results:

Search Criteria	Definition
Codes	One or more specific codes you wish to view in your results. If you do not know the specific code(s), leave this blank.
Campaign ID	The 10DLC campaign ID. Please note this only applies to long code numbers.
Connection ID / GUID	These are identifiers for an Aerialink connection on your account. Entering either of these will return all codes on the specified connections (unless additional criteria further narrow the field)
Email-to-SMS Name	This is the name of the user associated with an email2SMS address for codes to which that service is applicable.
Email Address	The email address associated with an email2SMS configuration on codes to which that service is applicable.
Code Type	Indicates long code, toll-free, short code or international sender ID, as well as whether the number was leased from Aerialink or was a BYON.
Active	Codes which are “active” are currently provisioned to the Aerialink account.

Credentials

Search Credentials

A default of one-hundred (100) credentials records is displayed based on the default SortBy (“Last Updated - Descending”). To narrow down the scope of the results:

1. Enter the Credential Name OR credential ID for a specific, singular set of credentials, OR
2. Enter the Connection ID to return all records of credentials associated with the specified connection, OR
3. Enter the Account ID to return all records of credentials associated with the specified account or subaccount.
4. Choose your output method.
5. Choose your sorting method. The default is “Last Updated Descending.”
6. Click “Submit.”

View Credential Details

To enter a specific credential set’s individual record, click the green, eye-shaped “View” icon. This will provide visibility to the following details:

• Credential GUID
• Credential ID
• Created date/time stamp
• Updated date/time stamp
• “Active” status
• Connection (the connection to which these credentnials are tied)
• Name (a friendly name for the credential set)
• API KEY
• API Secret
• System ID
• Password
• The status of whether the credentials are set to reset upon update
• The status of whether the credentials are enabled for use with firewall(s)

Create New Credentials

1. On Security > Credentials, click the “+” icon to create new credentials.
2. On the “New Credential” page, check the box (or leave it unchecked) to determine whether the credentials will be active at the time of their creation.
3. Choose an existing connection from the “Connection” dropdown. Note that the connection must be created before the credentials can be tied to it.
4. Enter a friendly name for the credential set.
5. Determine whether the credentials can be used with firewall(s) by checking (or leaving unchecked) the box.
6. Click “Create Credential.”

Edit Credentials

By clicking the blue “edit” icon on the right side of the credentials record, you will enter that specific record’s page which will provide visibility to the same data available in the “View” page, but will also allow the adjustment of the following details:

• Connection (the connection to which these credentials are tied)
• Name (a friendly name for the credential set)
• Enable for use with firewall(s)

You will also have the ability to reset the credentials. This will generate a new apiKey, apiSecret, SystemID and Password when you click “Update Credential.”

The following information will remain read-only:

• Credential GUID
• Credential ID
• Created date/time stamp
• Updated date/time stamp

Firewalls

Search Firewalls

A default of one-hundred (100) firewall entries is displayed based on the default SortBy (“Last Updated - Descending”). To narrow down the scope of the results:

1. Enter the Firewall Name OR Firewall ID for a specific, singular set of firewalls, OR
2. Enter the Connection ID to return all records of firewalls associated with the specified connection, OR
3. Enter the Account ID to return all records of firewalls associated with the specified account or subaccount.
4. Choose your output method.
5. Choose your sorting method. The default is “Last Updated Descending.”
6. Click “Submit.”

View Firewalls

To view a firewall’s individual record, locate the desired firewall in the search results and click the green, eye-shaped “View” icon. This will provide read-only visibility to the following details:

• Firewall GUID
• Firewall ID
• Created date/time stamp
• Updated date/time stamp
• “Active” status
• Account (the account or subaccount to which the firewall belongs)
• Connection (specific connection(s) to which this firewall is set)
• A friendly “Name” for the firewall
• IP Address
• IP Subnet

Create New Firewalls

1. On Security > Firewalls, click the “+”
2. On the “New Firewall” page, indicate whether the firewall should become active upon creation by checking (or leaving uncheckeD) the “Active” box.
3. Choose the account to which the firewall will be tied.
4. Choose an existing connection from the “Connection” dropdown. Note that the connection must be created before the firewalls can be tied to it.
5. Enter a friendly name for the firewall.
6. Enter the IP address and subnet for the firewall.
7. Click “Create Firewall.”

Edit Firewalls

To edit a firewall’s configuration, locate the desired firewall in the search results and click the blue, pen-shaped “Edit” icon. The “Edit Firewalls” page provides access a version of the “View” page which permits adjustment of some firewall details:

• “Active” status
• Account (the account or subaccount to which the firewall belongs)
• Connection (specific connection(s) to which this firewall is set)
• A friendly “Name” for the firewall
• IP Address
• IP Subnet

The following information will remain read-only:

• Firewall GUID
• Firewall ID
• Created date/time stamp
• Updated date/time stamp

Activity Report Search

The Activity Report allows users to view and filter message activity online with a limited set of properties, or download results in .csv format to view an expanded set of properties. Search timeframes have a maximum of up to ninety (90) days of transaction history within the v5 environment - meaning that accounts who migrated from v4 to v5 in the last ninety days will not have ninety days’ worth of history visible in the Activity Report.

The “Default Filter” will be applied automatically if no other filters are adjusted and the user simply presses “Search.” By this default, the following filters will be set:

• Message Types: “All Transaction Types”
• Connections: “All”
• Time Zone: “UTC”
• Start Date: Previous day beginning 00:00:00 UTC
• End Date: Current day ending 23:59:59
• Output Type: Screen

Beyond the default filter, users can adjust the filters to their specifications. Generally speaking, users can search the data by two methods:

Search by GUID

A “GUID” is a unique identifier for the transaction which is provided at the time the Aerialink gateway first processes the request. If you do not have a GUID, the transaction was not created on the Aerialink network. To search by GUID:

1. Enter the message GUID.
2. Select desired output. (“Screen” will display the results in the portal, while “Download” will trigger a CSV download.)
3. Click the “Search” button.

Search by Message Type

“Message Type” refers to whether a message is SMS, MMS, outbound or inbound, or is an inbound delivery receipt (i.e. SMS MT, SMS MO, MMS MT, MMS MO, SMS DLR, MMS DLR respectively). To search by Message Type:

1. Choose the desired type from the “Message Type” dropdown. Note that “All Types” is the default option and will return all traffic types within any other specified parameters.
2. If you wish to return data related to only one source number, enter a “Source Number.” Note that if the message type is “MO,” the “source number” will be the end-user, not your Aerialink number.
3. If you wish to return data related to only one destination number, enter a “Destination Number,” bearing in mind that if this an MO or DLR, your Aerialink number will be the destination.
4. Select the desired date range. The default will be one day (the previous twenty-four hours).
5. Select desired output. (“Screen” will display the results in the portal, while “Download” will trigger a CSV download which supports a maximum of 80k records. For larger transaction history records, please submit a ticket to the Aerialink Help Desk.)
6. If you wish to start over and reset the search criteria, click “Reset,” otherwise, click the “Search” button to execute the search.

Activity Report Results

Screen Output

The Activity Report is a wealth of information. Each record in the screen results displays a limited set of properties, and can be expanded on-click to reveal additional data. The up/down arrows at the top-left of hte results will expand or collapse all record on the page simultaneously.

If the chosen output is “screen,” the results will be returned online in the portal itself, and will display the following information:

Parameter	Definition
Message GUID	messageGUID The Globally Unique Identifier for a specific message
Message Type	Indicates whether a message is SMS, MMS or DLR, as well as directionality (inbound or outbound)
Message	The text body of the message. Note that DCS value may impact maximum character limit. Messages exceeding the carrier limit will be concatenated.
Account GUID	The globally unique identifier for the account (or subaccount) to which the record is tied
Connection ID	The sequential identifier for a connection
Campaign ID	Only relevant to long codes, this reflects the 10DLC campaignID registered with the mobile carriers and the Campaign Registry.
Source	The originating number for a message
Destination	The intended recipient of a message
Status	SUCCESS - Appears under one of the following conditions: (1) MT (w DLR requested) received by upstream provider for processing. Expect status change when DLR received. (2) MT (w no DLR requested) received by upstream provider for processing. Final Status. (3) MO or DLR successfully forwarded to customer endpoint. Final Status. DELIVRD - Appears under one of the following conditions: (1) toll-free or short code MT received by handset (2) 10DLC MT received by network [e.g. 3EC, 000] INCOMPLETE - Transaction processing did not complete [e.g. 100, 999] UNDELIV - 10DLC MT failure, no retry. [e.g. 00B] FAILED - toll-free MT failure, no retry [e.g. 3ED, 44F, 45C, 456, 4B6] REJECTED - Appears under one of the following conditions: (1) 10DLC MT rejection. [e.g. 00B, 068, 504, 045, 015] (2) toll-free MT rejection [e.g. 3F5, 3F7]* EXPIRED - MT expired toward internal routing endpoint [e.g. 999]
Submitted	completed A timestamp indicating that a message has completed its initial journey on the Aerialink side and has been forwarded to the delivery hub.

* or any number type toward internal routing endpoint [999]

CSV Output

Here are some helpful definitions which should assist you in deciphering the full wealth of parameters visible in the .csv version of the Activity Report. Note that any parameters included in the metadata are marked with “*.”

Parameter	Definition
addr_npi*	“Numbering Plan Indicator” specifies the numbering standard a code is following.
addr_ton*	“Type of Numbering” indicates how a code’s prefix is formatted for international messaging.
audit	The timestamp at which the transaction creation request is first logged in the Aerialink database and the moment the “audit” of message creation begins.
auditRecordResult	The timestamp at which the “audit” For the message’s creation is closed after it reaches the “completed” state.
campaignID*	Only relevant to long codes, this reflects the 10DLC campaignID registered with the mobile carriers and the Campaign Registry. completed A timestamp indicating that a message has completed its initial journey on the Aerialink side and has been forwarded to the delivery hub.
connectionGUID	The Globally Unique Identifier for a connection
connectionName	The friendly name for a connection
countryCode	+1 indicates the North American Numbering Plan (U.S., Canada and associated territories). Long number s not starting with 1 are international.
countryName	The name of the country in which the destination number is registered.
created	A timestamp indicating a message has been created within the Aerialink database and assigned a messageGUID.
dcs*	The Data Coding Scheme indicates which character set encoding is used for the message.
destination	The intended recipient of a message
dlrs	The number of DLRs returned for a message record. Note that multi-part messages may return one DLR per segment, but it is not guaranteed.
dlrErrCode	A numerical error code which, in conjunction with the dlrStatus, describes the ultimate results of the message send attempt for which the DLR has been provided.
dlrStatus	The status title associated with the provided dlrErrCode, which describes the ultimate results of the message send attempt for which the DLR has been returned.
esmClass*	The esmClass has some overlap with DCS in meaning, but most commonly indicates Message Type, and whether a message is concatenated.
failures	A count of any failure statuses tied to the message’s record.
latency	Indicates any latency in message creation in milliseconds
latencySend	Indicates any latency in message processing in milliseconds
latencySuccess	Indicates any latency in message completion in milliseconds
latencyDLRForward	Indicates any latency in DLR forwarding in milliseconds
messageGUID	The Globally Unique Identifier for a specific message
messageMetadata	Contains additional details such as campaignID, DCS value, esmClass, mode, MMS information and more. Metadata parameters are included in this table and are indicated with an asterisk.
messageText	The text body of the message. Note that DCS value may impact maximum character limit. Messages exceeding the carrier limit will be concatenated.
messageType	Indicates whether a message is SMS, MMS or DLR, as well as directionality (inbound or outbound)
mmsURL*	The URL address for a multimedia (MMS) attachment
mnoStatus*	Indicates the status of the code with AT&T and T-Mobile’s 10DLC publishing systems
numberOperatorID	The industry identifier for the destination number’s service provider
optionalParams*	Parameters located in the metadata which are associated with some – but not all – use cases, such as those specific to MMS.
processed	A timestamp indicating a message has moved from creation and has also completed processing.
redeliver	Indicates whether a message was rejected by the carrier and redelivered
registeredDelivery	Defaults to “0,” meaning that a DLR is not requested automatically. If set to “1,” a DLR is requested.
remoteIP*	The source IP for an API request made to Aerialink v5
result	Provides an integer associated with an overall result status.
resultHuman	Provides the English label tied to the “result” integer.
retries	The number of retry attempts (if applicable)
routed	Indicates success (1) or failure (0) of the routing attempt for the message.
segmentNumber*	Indicates the position of a segment within a concatenated, multipart message sequence, with “1” being the first segment and each other following sequentially. Note that for single-part messages with only 1 segment in total, the segmentNumber will the “0.”
source	The originating number for a message
status	Indicates the current status of the message as one of the following: -6 (“Blocked”) -7 (“Unhandled”) -8 (“Invalid”) -10 (“Too Long”) -14 (“Rejected”) -17 (“Spam Blocked”) -18 (“Spam Error”) 1 (“Delivered”) 2 (“DLR Forwarded”) 3 (“Delivered”) Other (“Undelivered”)
statusHuman	Gives the label associated with the numerical “status.”
systemID*	Username for SMPP connection
successes	A count of how many success statuses are tied to the message’s record.
totalSegments*	Defaults to “1” for single-segment messages. For concatenated (multi-segment) messages, this will assist in stitching messages back together in the correct order.
type	As mentioned in the “Search by Message Type” instructions, this indicates whether a message is inbound or outbound SMS, MMS or DLR.

Send Message

The “Send Message” tool allows users to send an outbound SMS or MMS from an Aerialink number provisioned to their account to a valid destination number.
Note: Including the word “Test” or the name of a Mobile Network Operator (e.g. “AT&T,” “T-Mobile,” etc) in your message content is not advised and is likely to result in blocking by the carriers.

To send a test message:

1. Enter an Aerialink number on your account in the “From” field.
2. In the “To” field, enter a valid destination number.
3. If you wish to request DLR (delivery receipt), check the “Request delivery receipt” box. Note that these are given by carriers as a courtesy and, while often returned, are not guaranteed.
4. The “Message” field should contain the SMS or MMS text content.
5. Click “Send.”
6. If sent successfully, the result indicator, “Message Sent” will appear, along with a direct GUID link to the message-in-progress, which you can view in the Activity Report.