Atomic API

Mobile - Management

Service management and SIM operations

POST/api/atomic/customer/mobile/manage

Manage Mobile Service

Bar, unbar, cancel or query a service

Parameters

actionstringrequired

Action to perform

querysuspendactivecancel
msnstringrequired

Format: 04xxxxxxxx

Request

curl \
  -X POST \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/manage" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "query",
  "msn": "0412345678"
}'
Response
200 Success
[
  {
    "msn": "0412345678",
    "customer_id": 1111,
    "service_plan_id": 96,
    "plan_name": "My Mobile Service",
    "sim_number": "eSIM",
    "account": "M123456789",
    "status": "SUSPENDED",
    "notification_email": "user@acme.com",
    "excess_usage": 0,
    "created_date": "2025-04-30 07:17:56",
    "datapool": {
      "datapool_id": 1,
      "datapool_limit": 0
    }
  }
]
PATCH/api/atomic/customer/mobile/update

Update Mobile Service

Update a mobile service

Parameters

msnstringrequired

Mobile service number

excess_usageintegeroptional

Excess usage limit

010501002004001000
service_plan_idstringoptional

New service plan ID

Request

curl \
  -X PATCH \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/update" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "msn": "0412345678",
  "excess_usage": 50
}'
Response200 Success
{
  "status": "success"
}
POST/api/atomic/customer/mobile/replace_sim

Replace SIM

Replace SIM or eSIM

Parameters

msnstringrequired

Mobile service number

sim_card_numberstringoptional

Required for physical SIM

is_esimbooleanrequired

Whether replacement is eSIM

notification_emailstringoptional

Required if is_esim is true

Request

curl \
  -X POST \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/replace_sim" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "msn": "0412345678",
  "is_esim": true,
  "notification_email": "user@example.com"
}'
Response
200 Success
{
  "status": "success"
}
POST/api/atomic/customer/mobile/reset_esim

Reset eSIM

Reset eSIM profile status

Parameters

msnstringrequired

Mobile service number

iccidstringrequired

ICCID of the eSIM

Request

curl \
  -X POST \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/reset_esim" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "msn": "0412345678",
  "iccid": "8976543210"
}'
Response
200 Success
{
  "status": "success",
  "message": "eSIM status has been reset"
}
Back to API Documentation