- API Reference
- Box API
- SMS & USSD
Send a USSD code (for example a balance check) from the SIM of one slot
Use this to run a carrier USSD code. Needs the SMS/USSD licence feature. Some codes change the subscription or spend credit and cannot be undone. data is the modem's reply (returns personal data such as balance or number); read later replies with /ussd/read. The Hub never relays this route.
POST
/ussd/sendRequest body application/json · required
positionintegerrequired
commandstringrequired
Responses
Modem reply or failure.
statusbooleanoptional
msgstringoptional
dataoptional
The caller is not trusted (not loopback, LAN, whitelisted or allowed Tailscale) and sent no valid Basic credentials. The body depends on whether "Basic auth for all API" is on. Routes that also use the panel login can answer a plain-text 401 "Unauthorized Access" instead.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
need_upgrade | The licence has no SMS/USSD feature. | Upgrade the plan. |