SMS API (api.onex-aura.com)

Archived documentation, retained for existing integrations. For current SMS APIs, see the API Reference. See Archived APIs overview for context.

Platform overview

Aura was OneXtel’s SMS platform for sending messages via the web interface or API, checking message status, and generating reports.

Terminology

TUC (Tenant User Customer): A primary account that manages SMS delivery independently.
Child TUC (Child Tenant User Customer): A secondary account that operates under a primary TUC account.
Reseller / Sub-account module: Multi-account management for SMS services.
Credits: Messaging capacity where one credit equals one 160-character message. Unicode or longer content consumes more than one credit.
UU ID: A unique identifier assigned to each individual message transmission.

Generating an API key

Open the API section

Use the left sidebar to navigate to the API section.

Choose Generate API

Two options appear: Show API (view existing keys) and + Generate API (create a new key).

Configure the key

In the popup, select the account type from the dropdown.

Optional: Scrub DND

Check Scrub DND to exclude Do Not Disturb numbers from SMS sent via this API key.

Optional: label

Provide a descriptive label for the key for organizational reference.

Optional: enable Automatch

Click Match Template to allow automatic template matching without passing templateid/entityid on each request, then email support@onextel.com with account credentials to complete backend activation.

Submit

Click Submit. The system confirms “Your API key is now successfully generated.”

Authentication

All endpoints below use API-key authentication, passed as the key parameter in the query string or JSON payload. Base domain: https://api.onex-aura.com.

Mandatory parameters

These parameters apply to all send-SMS endpoints except the XML API:

string

required

Authentication token generated in Aura.

string

required

Registered sender identifier per DLT.

string

required

Recipient phone number.

string

required

Message content.

string

required

Unique template ID registered under DLT.

string

required

Unique entity ID registered under DLT.

With Automatch enabled, entityid and templateid become optional — the system auto-matches message content to registered templates. Contact support@onextel.com to enable.

Send SMS APIs

GET — basic

GET /api/sms

curl "https://api.onex-aura.com/api/sms?key=YOUR_API_KEY&from=SENDERID&to=919999999999&body=Hello&templateid=xx&entityid=xx"

Optional: campaign_name.

POST — basic

POST /api/sms Header: Content-Type: text/plain Body: {{xx}},{{xx}} Optional: campaign_name.

GET — multi-part

GET /api/sms2 Optional parameter: sms_part (true/false) — returns message part count and unique IDs.

GET — custom parameters

GET /api/sms3 Optional parameters: custref1, custref2.

POST — custom parameters (JSON)

POST /api/sms3 Header: Content-Type: application/json

{
    "key": "xx",
    "from": "xx",
    "to": ["xx", "xx"],
    "body": "xx",
    "templateid": "xx",
    "entityid": "xx",
    "custref1": "xx",
    "custref2": "xx"
}

POST — JSON body

POST /api/jsms Header: Content-Type: application/json

{
    "key": "xx",
    "from": "xx",
    "to": ["xx", "xx"],
    "body": "xx",
    "templateid": "xx",
    "entityid": "xx",
    "custref1": "xx",
    "custref2": "xx"
}

POST — multiple templates, 1 custom parameter

POST /api/jsmslist Header: Content-Type: application/json

{
    "key": "xx",
    "listsms": [
        {
            "from": "xx",
            "to": "xx",
            "body": "xx",
            "templateid": "xx",
            "entityid": "xx",
            "clientsmsid": "xx"
        }
    ]
}

POST — multiple templates, 2 custom parameters

POST /api/jsmslist2 Header: Content-Type: application/json

{
    "key": "xx",
    "listsms": [
        {
            "from": "xx",
            "to": "xx",
            "body": "xx",
            "templateid": "xx",
            "entityid": "xx",
            "clientsmsid": "xx",
            "campaignid": "xx"
        }
    ]
}

POST — multiple message types, single key

POST /api/jsmslist3 Header: Content-Type: application/json Supports Service Implicit, Service Explicit, and Promotional message types in one request.

{
    "key": "xx",
    "listsms": [
        {
            "from": "xx",
            "to": "xx",
            "body": "xx",
            "templateid": "xx",
            "entityid": "xx",
            "clientsmsid": "xx"
        }
    ]
}

XML API

POST /api/pushsmsxml Header: Content-Type: application/xml

<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>

XML element	Required
`Authkey`	Yes
`Sender`	Yes
`Mobile`	Yes
`Message`	Yes
`TemplateId`	No
`EntityId`	No
`ReferenceId`	No

Reports APIs

Message report

GET /api/report

curl "http://api.onex-aura.com/api/report?key=YOUR_API_KEY&uid=UUID"

string

required

API key.

string

required

Unique Aura message ID.

Summary report

GET /api/summary

curl "http://api.onex-aura.com/api/summary?key=YOUR_API_KEY&fromdate=20240101&todate=20240131"

string

required

API key.

string

required

Start date, YYYYMMDD format.

string

required

End date, YYYYMMDD format.

string

Filter by campaign name.

Balance check

GET /api/bal

curl "http://api.onex-aura.com/api/bal?key=YOUR_API_KEY"

string

required

API key.

Balance transfer

GET /api/transfer

curl "https://api.onex-aura.com/api/transfer?key=YOUR_API_KEY&to=CHILD_TUC_ID&amount=100"

string

required

API key.

string

required

Child TUC ID.

string

required

Credit amount to transfer.

These archived endpoints use the base domain https://api.onex-aura.com, with a hyphen. The current platform uses https://api.onexaura.com.

​Platform overview

​Terminology

​Generating an API key

​Authentication

​Mandatory parameters

​Send SMS APIs

​GET — basic

​POST — basic

​GET — multi-part

​GET — custom parameters

​POST — custom parameters (JSON)

​POST — JSON body

​POST — multiple templates, 1 custom parameter

​POST — multiple templates, 2 custom parameters

​POST — multiple message types, single key

​XML API

​Reports APIs

​Message report

​Summary report

​Balance check

​Balance transfer

Platform overview

Terminology

Generating an API key

Authentication

Mandatory parameters

Send SMS APIs

GET — basic

POST — basic

GET — multi-part

GET — custom parameters

POST — custom parameters (JSON)

POST — JSON body

POST — multiple templates, 1 custom parameter

POST — multiple templates, 2 custom parameters

POST — multiple message types, single key

XML API

Reports APIs

Message report

Summary report

Balance check

Balance transfer