Adapter: LINK Mobility SMS REST API
Adapter for applications that already support the LINK Mobility SMS REST API.
Provider API version: | 2.0 | October 2023 |
Adapter version: | 0.1 | |
Available as a source adapter: | Yes | Adapter can be used directly by application |
Available as a target adapter: | No | Cannot be used with LINK Mobility's SMS REST API endpoint |
Use adapter with your application
Change URL from https://eu.linkmobility.io (or similar) to:
https://api.onesmsapi.com/[bridge]
[bridge] is the identifier for the bridge that is created for your chosen source and target adapters (e.g. LINK Mobility SMS REST API as source, Twilio Messaging API as target).
Supported API calls (source adapter)
Authentication (OAuth 2.0)
Authentication either takes place using OAuth 2.0 or using basic authentication.
POST /auth/token
Original URL:
https://[your assigned URL]/auth/token
New URL:
https://api.onesmsapi.com/[bridge]/auth/token
Content type of payload:
application/x-www-form-urlencoded
Submit a message
POST /sms/send
Original URL:
https://[your assigned URL]/sms/send
New URL:
https://api.onesmsapi.com/[bridge]/sms/send
Header (OAuth 2.0)
Authorization: Bearer [token]
Header (basic authentication)
Authorization: Basic [username-password-base64]
Content type of payload:
application/json
Methods and parameters "supported as source" are those used by your application's code.
Parameter | Supported as source | Supported as target |
---|---|---|
source | Y | n/a |
sourceTON | Y | n/a |
destination | Y | n/a |
destinationTON | Y | n/a |
dcs | Y | n/a |
userDataHeader | Y | n/a |
userData | Y | n/a |
useDeliveryReport | Y | n/a |
relativeValidityTime | Y | n/a |
absoluteValidityTime | Y | n/a |
priority | Y | n/a |
platformId | Y | n/a |
platformPartnerId | Y | n/a |
refId | Y | n/a |
{
"source": "ABC",
"destination": "+4499999999",
"userData": "Hello world",
"platformId": "0",
"platformPartnerId": "0",
"useDeliveryReport": false
}
Responses
The adapter will return a response compatible with the LINK Mobility SMS REST API. The response is returned after the message is submitted via a target adapter. The messageId field returned by this adapter will be the message ID returned through the target provider adapter.
{
"messageId":"dCshUhod0PMAAAFQabPbnR3x",
"resultCode":1005,
"description":"Queued"
}
Reference
LINK Mobility SMS REST API:
https://a.storyblok.com/f/151608/x/d66a32ace9/sms_rest_api_mt_dlr_20.pdf via https://www.linkmobility.com/en-GB/developer
Updated 10 months ago