Atomic API

Mobile - Orders

New activations, porting, and order tracking

POST/api/atomic/customer/mobile/number_reservation

Reserve Mobile Number

Reserve mobile numbers

Parameters

qtyintegerrequired

Maximum 5

Request

curl \
  -X POST \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/number_reservation" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "qty": 5
}'
Response
200 Success
[
  {
    "msn": "0491762973"
  },
  {
    "msn": "0491762975"
  },
  {
    "msn": "0491762977"
  }
]
POST/api/atomic/customer/mobile/new

New Mobile Service

You can use this API endpoint to create a new mobile service. For Service Plan, please ensure you run the Service Plan (/api/atomic/customer/mobile/service_plan) query to ensure you are using updated rate card information.

Parameters

msnstringrequired

From Reserve Mobile Number

customer_details
customer_idintegerrequired

Customer ID

notification_emailstringoptional

Required if is_esim is true

address_1stringrequired

Address line 1

address_2stringoptional

Address line 2

postal_codeintegerrequired

Postal code

citystringrequired

City

regionstringrequired

e.g. New South Wales

service_details
is_esimbooleanrequired

Whether to use eSIM

sim_numberstringoptional

Required if is_esim is false

service_namestringrequired

Service name

is_datapoolbooleanrequired

Whether to use data pool

datapool_idstringoptional

Required if is_datapool is true

service_plan_idstringrequired

Service plan ID

excess_usageintegeroptional

Excess usage limit

010501002004001000

Request

curl \
  -X POST \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/new" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "msn": "0444455555",
  "customer_details": {
    "customer_id": 5,
    "address_1": "123 Some Street",
    "postal_code": 4000,
    "city": "Brisbane",
    "region": "Queensland"
  },
  "service_details": {
    "is_esim": false,
    "sim_number": "89610000001234567890",
    "service_name": "My New Mobile Service",
    "is_datapool": false,
    "service_plan_id": "96",
    "excess_usage": 0
  }
}'
Response
200 Success
{
  "status": "submitted",
  "customer_id": 5,
  "service_plan": 96,
  "service_name": "My New Mobile Service",
  "msn": "0444455555",
  "order_id": "1234567"
}
POST/api/atomic/customer/mobile/port_request

Port Mobile Service

Port a mobile service

Parameters

customer_details
customer_idintegerrequired

Customer ID

notification_emailstringoptional

Notification email

address_1stringrequired

Address line 1

address_2stringoptional

Address line 2

postal_codeintegerrequired

Postal code

citystringrequired

City

regionstringrequired

Region

service_details
is_esimbooleanrequired

Whether to use eSIM

sim_numberstringoptional

Required for physical SIM

service_namestringrequired

Service name

is_datapoolbooleanoptional

Whether to use data pool

datapool_idstringoptional

Data pool ID

service_plan_idstringrequired

Service plan ID

excess_usageintegeroptional

Excess usage limit

010501002004001000
porting_details
porting_numberstringrequired

MSN being ported

account_typestringrequired

Account type

postpaidprepaid
mobile_acct_numberstringoptional

Required if postpaid

dobstringoptional

Required if prepaid, YYYY-MM-DD

Request

curl \
  -X POST \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/port_request" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "customer_details": {
    "customer_id": 5,
    "address_1": "123 Some Street",
    "postal_code": 4000,
    "city": "Brisbane",
    "region": "Queensland"
  },
  "service_details": {
    "is_esim": false,
    "sim_number": "89610000001234567890",
    "service_name": "Port Request",
    "is_datapool": false,
    "service_plan_id": "96",
    "excess_usage": 0
  },
  "porting_details": {
    "porting_number": "0412345678",
    "account_type": "postpaid",
    "mobile_acct_number": "ACC123456"
  }
}'
Response200 Success
{}
GET/api/atomic/customer/mobile/query_mobile_order

Check Mobile Order

Check order status

⚠

Wait several minutes after submitting before checking

Parameters

order_idstringqueryoptional

Order ID

Request

curl \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/query_mobile_order?order_id={order_id}" \
  -H "Authorization: {{your_access_token}}"
Response200 Success
[
  {
    "order_id": "4052619",
    "status": "REJECTED",
    "created_on": "2025-05-07 14:39:36",
    "updated_on": "2025-05-07 14:41:00",
    "order_history": [
      {
        "action": "CREATED",
        "internalStatus": "PENDING",
        "occured": "2025-05-07 14:39:36"
      }
    ]
  }
]
Back to API Documentation