Atomic API

Mobile - SIM & Plans

Check SIM availability, browse service plans, and query service details

POST/api/atomic/customer/mobile/sim_status

Check SIM

Validate if a SIM card can be used

Parameters

sim_card_numberstringrequired

SIM card number printed on the physical SIM

Request

curl \
  -X POST \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/sim_status" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "sim_card_number": "1234567890"
}'
Response
200 Success
[
  {
    "status": "AVAILABLE",
    "type": "WME_SIM",
    "sim_card_number": "1234567890"
  }
]
GET/api/atomic/customer/mobile/service_plan

Mobile Plans

Return all mobile plans

No parameters required.

Request

curl \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/service_plan" \
  -H "Authorization: {{your_access_token}}"
Response
200 Success
[
  {
    "service_plan_name": "Supa Plan 1",
    "service_plan_id": 1,
    "service_plan_type": "Mobile Service Plan",
    "service_plan_currency": "AUD",
    "service_price": 39.99,
    "data_allowance_gb": "12"
  }
]
GET/api/atomic/customer/mobile/sim_details

SIM Details

Retrieve SIM/eSIM details

Parameters

account_numberstringqueryrequired

Account number

msnstringqueryrequired

Mobile service number

Request

curl \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/sim_details?account_number={account_number}&msn={msn}" \
  -H "Authorization: {{your_access_token}}"
Response200 Success
[
  {
    "account_number": "123456",
    "status": "IN_USE",
    "status_change_time": "2024-03-26T02:40:44.660Z",
    "provider_status": "A - Active",
    "type": "WME_ESIM",
    "activation_code": "1$sm-v4-023-a-gtm.pr.go-esim.com$1234567890",
    "iccid": "8976543210",
    "profile_state": "INSTALLED"
  }
]
GET/api/atomic/customer/mobile/balance

Mobile Balance

Get mobile data allowance balance

Parameters

account_numberstringqueryrequired

Account number

msnstringqueryrequired

e.g. 04xxxxxxxx

Request

curl \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/balance?account_number={account_number}&msn={msn}" \
  -H "Authorization: {{your_access_token}}"
Response
200 Success
[
  {
    "balance": [
      {
        "service": {
          "balance": 0,
          "description": "10GB - Pooling Plan Data Allowance",
          "allowance": 10,
          "used": 10
        }
      },
      {
        "databank": {
          "balance": null,
          "description": null,
          "allowance": null,
          "used": null
        }
      },
      {
        "pool": {
          "balance": 68.83,
          "description": "Postpaid SMB Pool Sharing",
          "allowance": 75,
          "used": 4.91
        }
      }
    ]
  }
]
GET/api/atomic/customer/mobile/esim/qr_code

eSIM QR Code

Get eSIM QR code

Parameters

account_numberstringqueryrequired

Account number

msnstringqueryrequired

Mobile service number

iccidstringqueryrequired

From Get SIM Details

Request

curl \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/esim/qr_code?account_number={account_number}&msn={msn}&iccid={iccid}" \
  -H "Authorization: {{your_access_token}}"
Response200 Success
[
  {
    "data": "iVBORw0KGgo...base64...",
    "type": "image/PNG"
  }
]
GET/api/atomic/customer/mobile/int_roaming

International Roaming

Check international roaming status

Parameters

mobile_numberstringqueryrequired

Mobile number

Request

curl \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/mobile/int_roaming?mobile_number={mobile_number}" \
  -H "Authorization: {{your_access_token}}"
Response
200 Success
[
  {
    "feature": "int_roaming",
    "active": false
  }
]
Back to API Documentation