Vendor Emulators

As a value-add, Aerialink supports formats for other aggregators in order to make customer migration to Aerialink as smooth as possible. The articles on this page provide documentation dedicated to specified vendors.

Vonage Emulator (SMS-Only)

Endpoint: apix5.aerialink.net/v5/messages/v/

Supported Vonage-to-Aerialink Parameters

The following table depicts the Aerialink parameter on the left and the equivalent Vonage parameter on the right.

Aerialink Field	Vonage Field
source	from
destination	to
messageText	text
registeredDelivery	status-report-req
dcs	message-class

Unsupported Vonage Parameters

The following Vonage parameters are not supported by Aerialink:

ttl
callback
type
body
udh
protocol-id
client-ref
account-ref
entity-id
content-id

Vonage Emulator Connection Configuration

Customers who wish their inbound messages (MOs) and delivery receipts (DLR) to be forwarded to them in the Vonage format should configure their connection with the following route actions

routeActionTypeID	routeActionTypeGUID	name
30	41FFFCB2-80EE-4CBC-AE44-B7A9277F0CF9	SMS Inbound (MO) HTTP Forward Vonage
31	6F5E4522-53CF-4165-924D-E881DA9E2933	SMS Inbound (MO-DLR) HTTP Vonage

Vonage Emulator Response Samples

Outbound (MT) Samples

Sample MT Success

{
   "message-count": "1",
   "messages": [
      {
         "to": "12345678910",
                 "message-id": "f99d106a-9d3b-4b37-9278-b491f719c3a7",
       "status": "0",
       "remaining-balance": "1.97015000",
       "message-price": "0.00995000",
       "network": "310090"
         "client-ref": "my-personal-reference",
         "account-ref": "customer1234"
      }
   ]
}

Sample MT Error
{
“message-count”: “1”,
“messages”: [
{
“status”: “2”,
“error-text”: “Missing from param”
}
]
}

Inbound (MO & DLR) Samples

Sample MO
{
“api-key”: “abcd1234”,
“msisdn”: “447700900001”,
“to”: “447700900000”,
“messageId”: “aaaaaaaa-bbbb-cccc-dddd-0123456789ab”,
“text”: “Hello world”,
“type”: “text”,
“keyword”: “HELLO”,
“message-timestamp”: {},
“timestamp”: “1578787200”,
“nonce”: “aaaaaaaa-bbbb-cccc-dddd-0123456789ab”,
“concat”: “true”,
“concat-ref”: “1”,
“concat-total”: “3”,
“concat-part”: “2”,
“data”: “string”,
“udh”: “string”
}
Aerialink Emulated MO
/?connectionGUID=C8CE34EF-8768-465F-B0B3-1A2650DDAEC7&sourceCountry=United%20States%20of%20America%20or%20Canada&sourceCountryCode=1&sourceCountryAbbreviation=US&sourceNational=5635083351&concatenatedMessageSegmentHash=0a97beccb248bf5ab4ff978fa687d2fd3f68b03758d0053d61dba7457aec6865&apiKey=secure&msisdn=N%2FA&to=13192195227&from=15635083351&messageID=ffa06d43-7a12-4395-802d-1f4319116697&text=y%20to%20central%20Georgia%2C%20subfreezing%20overnight%20temperatures%20could%20create%20icy%20patches%20in%20places%20where%20winter%20storms%20occurred.&type=text&keyword=N%2FA&timestamp=1738183883112&nonce=N%2FA&concat=true&concatRef=bd&concatTotal=02&concatPart=02&data=7920746f2063656e7472616c2047656f726769612c20737562667265657a696e67206f7665726e696768742074656d70657261747572657320636f756c642063726561746520696379207061746368657320696e20706c616365732077686572652077696e7465722073746f726d73206f636375727265642e&udh=050003bd0202

{
connectionGUID: "C8CE34EF-8768-465F-B0B3-1A2650DDAEC7",
sourceCountry: "United%20States%20of%20America%20or%20Canada",
sourceCountryCode: 1,
sourceCountryAbbreviation: "US",
sourceNational: "5635083351",
apiKey: "secure",
msisdn: "N/A",
to: "13192195227",
from: "15635083351",
messageID: "7f9ad4da-3d0f-4373-8204-c98c1d10ae85",
text: "test text",
type: "text",
keyword: "N/A",
timestamp: 1738183429056,
nonce: "N/A",
concat: "true",
concatRef: "26",
concatTotal: "2",
concatPart: "2",
data: "0x7920746f2063656e7472616c2047656f726769612c20737562667265657a696e67206f7665726e696768742074656d70657261747572657320636f756c642063726561746520696379207061746368657320696e20706c616365732077686572652077696e7465722073746f726d73206f636375727265642e",
udh: "0x050003bd0202"
}

Vonage DLR
{
“msisdn”: “447700900000”,
“to”: “AcmeInc”,
“network-code”: “12345”,
“messageId”: “0A0000001234567B”,
“price”: “0.03330000”,
“status”: “delivered”,
“scts”: “2001011400”,
“err-code”: “0”,
“api-key”: “abcd1234”,
“message-timestamp”: “2020-01-01 12:00:00”
}
Aerialink Emulated DLR
{
“connectionGUID”: “62eba45f-cc04-4fa3-8e96-96c0978e4576”,
“source”: “13097212689”,
“sourceCountry”: “United States of America or Canada”,
“sourceCountryCode”: “1”,
“sourceCountryAbbreviation”: “US”,
“sourceNational”: “3097212689”,
“concatenatedMessage”: false,
“messageText”: “id:3b1f9be7-2dce-49ad-b179-7b6e357e78ce sub:000 dlvrd:000 submit date:2502101612 done date:2502101612 stat:DELIVRD err:000 text:rk jk ext sahljdhasl”,
“msisdn”: “N/A”,
“to”: “13192195227”,
“from”: “13097212689”,
“networkCode”: “N/A”,
“messageID”: “0e9baa51-7007-46d7-8585-285f60a4a2da”,
“price”: “N/A”,
“status”: “delivered”,
“scts”: “N/A”,
“errCode”: “N/A”
}

Vonage Emulator Error Codes

The following is a non-exhaustive list of error codes which may be encountered when using the Vonage-to-Aerialink emulator API.

Check parameters and retryThe value of one or more parameters is invalid

Code	Definition	Description	Remediation
1	Throttled	SMS send rate exceeds account limits	Refer to Vonage Documentation.
2	Missing Parameters	Request missing one or more of the following required parameters: - ‘from’ - ‘to’ - ‘api_key’ - ‘api_secret’ - ‘text’
3	Invalid Parameters	Check parameters and retry.
4	Invalid Credentials	API key and/or secret incorrect, invalid or disabled	Check credentials on Vonage Dashboard
5	Internal Error	An error occurred in the Vonage platform during message processing	Contact Vonage Support
6	Invalid Message	Vonage platform unable to process message.	This may be due to - for example - an un-recognized number prefix. Please ensure all data is correct and retry, otherwise, contact Vonage Support
7	Number Barred	The destination number is blacklisted and may not receive them.	N/A
8	Partner Account Barred	The associated Vonage account has been suspended	Contact Vonage Support
9	Partner Quota Violation	Account credits insufficient to send message.	Add more credits and retry
10	Too Many Existing Binds	Number of simultaneous connections to the Vonage platform exceeds account allocation.	Back-off and retry
11	Account Not Enabled for HTTP	The Vonage account is not provisioned for the SMS API	Try SMPP, or contact Vonage Support
12	Message Too Long	Permitted message length exceeded	Shorten the message and retry.
14	Invalid Signature	Signature could not be verified	Consult Vonage Documentation or use an SDK to handle message signing.
15	Invalid Sender Address	“from” field contains unauthorized sender ID	Note: Vonage long virtual numbers or short codes are required to send to North American destinations.
17	Message Blocked by Provider	The destination messaging provider has blocked the message.	This may ne due to content restrictions imposed y the provider. Ensure you are following all anti-spam guidelines.
22	Invalid Network Code	Network code provided was not recognized or does not match the destination country	Check network code or remove it from the request
23	Invalid Callback URL	Callback URL contains illegal characters and/or exceeds length restrictions	Supply a valid URL
29	Non-Whitelisted Destination	Vonage accounts in Demo mode must add target numbers the “Whitelisted Destinations” list.	Whitelist the destination or add funds to the account
32	Signature and API Secret Disallowed	Signed requests may not also present an ‘api_secret’	Remove eotjer api_secret or signature from request.
33	Number Deactivated	Destination number is deactivated and cannot receive messages	Remove destination number from all lists to maintain FCC TCPA compliance.

Search Results