Atomic API

SMS Services

Register SMS brands, retrieve incoming messages and call records

POST/api/atomic/customer/sms/register_brand_name

Register Brand Name

Register an SMS brand name. [Coming Soon] Support for international locations.

⚠

Currently supports Australia. For international locations like US and UK, please raise a support ticket with our team.

Parameters

sms_account_idintegerrequired

SMS account ID

brand_namestringrequired

Brand name to register

brand_urlstringrequired

Brand URL

descriptionstringrequired

Description

Request

curl \
  -X POST \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/sms/register_brand_name" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "sms_account_id": 2124,
  "brand_name": "BRAND",
  "brand_url": "https://example.com",
  "description": "Brand registration for SMS campaigns"
}'
Response
200 Success
{
  "result": "success",
  "brand_name": "BRAND",
  "registration_id": "12345"
}
GET/api/atomic/customer/sms/status_brand_name

Brand Name Status

Check brand name registration status

Parameters

registration_idstringqueryrequired

Registration ID

Request

curl \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/sms/status_brand_name?registration_id={registration_id}" \
  -H "Authorization: {{your_access_token}}"
Response
200 Success
{
  "registration_id": "12345",
  "brand_name": "BRAND NAME",
  "brand_name_url": "https://mytest.com",
  "description": "Brand name validation",
  "status": "approved"
}
GET/api/atomic/customer/sms/incoming_sms

Incoming SMS

Retrieve incoming SMS messages

⚠

Limited to 100 results

Parameters

senderstringqueryoptional

E.164 format

receiverstringqueryoptional

VMN in E.164

from_datestringqueryrequired

UTC yyyy-MM-dd hh:mm:ss

to_datestringqueryrequired

UTC yyyy-MM-dd hh:mm:ss

Request

curl \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/sms/incoming_sms?sender={sender}&receiver={receiver}&from_date={from_date}&to_date={to_date}" \
  -H "Authorization: {{your_access_token}}"
Response200 Success
[
  {
    "response": {
      "body": [
        {
          "message_id": 152176,
          "receiver": "61488899999",
          "sender": "61499999888",
          "receive_message": "Hello",
          "receive_datetime": "2025-05-28 02:08:25"
        }
      ],
      "statusCode": 200
    }
  }
]
POST/api/atomic/customer/sms/cdrs

SMS CDRs

Retrieve SMS CDRs

⚠

Limited to 250 results

⚠

Only SMS sent through web portal or API, not SMPP

Parameters

account_idintegerrequired

Account ID

start_datestringrequired

UTC yyyy-MM-dd hh:mm:ss

end_datestringrequired

UTC yyyy-MM-dd hh:mm:ss

Request

curl \
  -X POST \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/sms/cdrs" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "account_id": 100,
  "start_date": "2024-04-01 00:00:00",
  "end_date": "2024-04-03 23:59:59"
}'
Response
200 Success
{}
Back to API Documentation