API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Modems

Read the phone number of a modem's SIM

Use this to find the SIM's phone number. Asks the modem for its own number (AT+CNUM or the modem API) and returns the request body with phone_number filled in. Many SIMs do not store their number, which gives the failure message. phone_number must be present and truthy in the request; without it the box answers HTTP 500.

  • Action · reversible
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: needs owner approval
  • getDongleInfo
POST/v2/get_dongle_info

Request body application/json · required

positionintegerrequired
phone_numberbooleanrequired

Must be true.

Authentication

Needs dashboard Basic credentials when dashboard authentication is enabled; trusted callers (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) pass without them.

Responses

Number found or not.

statusbooleanoptional
msgstringoptional
dataobjectoptional
data.positionintegeroptional
data.phone_numberstringoptional

Errors returned in msg

msgMeaningWhat to do
Read dongle information Failed try againThe SIM does not store its number or the modem did not answer.Get the number by USSD or from the carrier.
Verified against XProxy v21.3.2 on Nov 17, 2026