Introduction
Onextel’s SMS APIs offer robust, secure, and flexible integrations with your system, allowing seamless incorporation of SMS capabilities into your applications. With the Onextel SMS API, you can efficiently send messages, ensuring reliable communication with your users globally.
To start using the SMS API, you will need to obtain an API key. Click here to learn how to generate an API key on Aura. Once you have your key, you can begin making requests to our SMS endpoints to leverage our messaging services.
Domain #
https://api.onex-aura.com #
Send SMS APIs #
Mandatory parameters
Please note that these are mandatory and common parameters for all APIs (except XML).
| Parameter | Description | Mandatory |
| key | Your unique authentication key generated on AURA for accessing the Onextel SMS API | Yes |
| from | Add your Sender ID as registered under DLT | Yes |
| to | The recipient’s phone number | Yes |
| body | Content of the SMS message to be sent | Yes |
| templateid | The unique id registered for each of your Template under DLT | Yes |
| entityid | The unique id registered for your Entity under DLT | Yes |
Note – If Automatch is enabled for your account the system will match the body content with the templates added to your account, in this case entityid & templateid parameters are not required to be passed in the API Payload.
If you want to get Automatch enabled for your account kindly contact support@onextel.com
#
1. Send SMS GET API #
Endpoint: domain/api/sms
Sample Curl Request :
curl --location 'https://api.onex-aura.com/api/sms?key=xx&from=xx&to=xx&body=xx&templateid=xx&entityid=xx'Additional Parameters
| Parameter | Description | Mandatory |
| campaign_name | A descriptive name for the SMS campaign | No |
2. Send SMS POST API #
Endpoint: domain/api/sms
Sample Curl Request :
Sample Curl Request :
curl --location 'https://api.onex-aura.com/api/sms?key=xx&from=xx&body=xx&templateid=xx&entityid=xx' \
--header 'Content-Type: text/plain' \
--data '{{xx}},{{xx}}'
Additional Parameters
| Parameter | Description | Mandatory |
| campaign_name | A descriptive name for the SMS campaign | No |
3. Send SMS GET API with Multi-Part #
Endpoint: domain/api/sms2
Sample Curl Request :
curl --location 'https://api.onex-aura.com/api/sms?key=xx&from=xx&to=xx&body=xx&templateid=xx&entityid=xx'Additional Parameters
| Parameter | Description | Mandatory |
| sms_part | A true or false value to get number of message parts and unique SMS message ids for multi-part SMSs (e.g., true to enable, false to disable) | No |
4. Send SMS GET API with Custom Parameters #
Endpoint: domain/api/sms3
Sample Curl Request :
curl --location 'https://api.onex-aura.com/api/sms3?key=xx&from=xx&to=xx&body=xx&templateid=xx&entityid=xx&custref1=xx&custref2=xx'Additional Parameters
| Parameter | Description | Mandatory |
| custref1 | A custom parameter that you can assign any value as per the requirement. | No |
| custref2 | A custom parameter that you can assign any value as per the requirement. | No |
5. Send SMS POST API with Custom Parameters #
Endpoint: domain/api/sms3
Sample Curl Request :
curl --location 'https://api.onex-aura.com/api/sms3' \
--header 'Content-Type: application/json' \
--data '{
"key": "xx",
"from": "xx",
"to": [
"xx",
"xx"
],
"body": "xx",
"templateid": "xx",
"entityid": "xx",
"custref1": "xx",
"custref2": "xx"
}'Additional Parameters
| Parameter | Description | Mandatory |
| custref1 | A custom parameter that you can assign any value as per the requirement. | No |
| custref2 | A custom parameter that you can assign any value as per the requirement. | No |
6. Send SMS POST API with JSON body #
Endpoint: domain/api/jsms
Sample Curl Request :
curl --location 'https://api.onex-aura.com/api/jsms' \
--header 'Content-Type: application/json' \
--data '{
"key": "xx",
"from": "xx",
"to": [
"xx",
"xx"
],
"body": "xx",
"templateid": "xx",
"entityid": "xx",
"custref1": "xx",
"custref2": "xx"
}'
Additional Parameters
| Parameter | Description | Mandatory |
| custref1 | A custom parameter that you can assign any value as per the requirement. | No |
| custref2 | A custom parameter that you can assign any value as per the requirement. | No |
7. Send SMS POST API with JSON body for multiple templates (1 custom parameter) #
Endpoint: domain/api/jsmslist
Sample Curl Request :
curl --location 'https://api.onex-aura.com/api/jsmslist' \
--header 'Content-Type: application/json' \
--data '{
"key": "xx",
"listsms": [
{
"from": "xx",
"to": "xx",
"body": "xx",
"templateid": "xx",
"entityid": "xx",
"clientsmsid": "xx"
},
{
"from": "xx",
"to": "xx",
"body": "xx",
"templateid": "xx",
"entityid": "xx",
"clientsmsid": "xx"
}
]
}'Additional Parameters
| Parameter | Description | Mandatory |
| clientsmsid | A custom parameter that you can assign any value as per the requirement. | No |
8. Send SMS POST API with JSON body for multiple templates (2 custom parameter) #
Endpoint: domain/api/jsmslist2
Sample Curl Request :
curl --location 'https://api.onex-aura.com/api/jsmslist' \
--header 'Content-Type: application/json' \
--data '{
"key": "xx",
"listsms": [
{
"from": "xx",
"to": "xx",
"body": "xx",
"templateid": "xx",
"entityid": "xx",
"clientsmsid": "xx",
"campaignid": "xx"
},
{
"from": "xx",
"to": "xx",
"body": "xx",
"templateid": "xx",
"entityid": "xx",
"clientsmsid": "xx",
"campaignid": "xx"
}
]
}'
Additional Parameters
| Parameter | Description | Mandatory |
| clientsmsid | A custom parameter that you can assign any value as per the requirement. | No |
| campaignid | A custom parameter that you can assign any value as per the requirement. | No |
9. Send SMS POST API with JSON body for multiple templates (Single API-key for Service Implicit, Service Explicit and Promotional message type) #
Endpoint: domain/api/jsmslist3
Sample Curl Request :
curl --location 'https://api.onex-aura.com/api/jsmslist' \
--header 'Content-Type: application/json' \
--data '{
"key": "xx",
"listsms": [
{
"from": "xx",
"to": "xx",
"body": "xx",
"templateid": "xx",
"entityid": "xx",
"clientsmsid": "xx"
},
{
"from": "xx",
"to": "xx",
"body": "xx",
"templateid": "xx",
"entityid": "xx",
"clientsmsid": "xx"
}
]
}'Additional Parameters
| Parameter | Description | Mandatory |
| clientsmsid | A custom parameter that you can assign any value as per the requirement. | No |
10. Send SMS XML API #
Endpoint: domain/api/pushsmsxml
Sample Curl Request :
curl --location 'https://api.onex-aura.com/api/pushsmsxml' \
--header 'Content-Type: application/xml' \
--data '<API>
<Authentication>
<User>xx</User>
<Authkey>xx</Authkey>
</Authentication>
<Data>
<Sender>xx</Sender>
<MobileNum>
<Mobile>xx</Mobile>
</MobileNum>
<Message>xx</Message>
<TemplateId>xx</TemplateId>
<EntityId>xx</EntityId>
<ReferenceId>xx</ReferenceId>
</Data>
</API>'Parameters:
| Parameter | Description | Mandatory |
| Authkey | Your unique authentication key generated on AURA for accessing the Onextel SMS API | Yes |
| Sender | Add your Sender ID as registered under DLT | Yes |
| Mobile | The recipient’s phone number | Yes |
| Message | Content of the SMS message to be sent | Yes |
| TemplateId | The unique id registered for each of your Template under DLT | No |
| EntityId | The unique id registered for your Entity under DLT | No |
| ReferenceId | A custom parameter that you can assign any value as per the requirement. | No |
Reports API #
1. Message Report GET API #
Endpoint: domain/api/report
Sample Curl Request :
curl --location 'http://api.onex-aura.com/api/report?key=xx&uid=xx'
Parameters:
| Parameter | Description | Mandatory |
| key | Your unique authentication key generated on AURA for accessing the Onextel SMS API | Yes |
| uid | Unique Aura message ID | Yes |
2. Summary Report GET API #
Endpoint: domain/api/summary
Sample Curl Request :
curl --location 'http://api.onex-aura.com/api/summary?key=xx&todate=xx&fromdate=xx'
Parameters:
| Parameter | Description | Mandatory |
| key | Your unique authentication key generated on AURA for accessing the Onextel SMS API | Yes |
| fromdate | The date from which you require the account summary | Yes |
| todate | The date until which you require the account summary | Yes |
| campaign_name | The name of the SMS campaign you want to filter the sms summary for. | No |
Note – Date format should be YYYYMMDD
3. Balance Check GET API #
Endpoint: domain/api/bal
Sample Curl Request :
curl --location 'http://api.onex-aura.com/api/bal?key=xx'Parameters:
| Parameter | Description | Mandatory |
| key | Your unique authentication key generated on AURA for accessing the Onextel SMS API | Yes |
4. Balance Transfer GET API #
Endpoint: domain/api/transfer
Sample Curl Request :
curl --location 'https://api.onex-aura.com/api/transfer?key=xx&to=xx&amount=xx'Parameters:
| Parameter | Description | Mandatory |
| key | Your unique authentication key generated on AURA for accessing the Onextel SMS API | Yes |
| to | TUC ID: The unique identifier for the Aura account, located on the upper right side of your account. | Yes |
| amount | Amount of credits to be added to your child TUC accounts | Yes |