API Reference
Dashboard
  1. API Reference
  2. Box API
  3. 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.

  • Destructive · confirm first
  • Basic auth
  • Public API · since v20.8.0
  • Hub: blocked by the Hub
  • sendUssd
POST/ussd/send

Request body application/json · required

positionintegerrequired
commandstringrequired

Responses

Modem reply or failure.

statusbooleanoptional
msgstringoptional
dataoptional

Errors returned in msg

msgMeaningWhat to do
need_upgradeThe licence has no SMS/USSD feature.Upgrade the plan.
Verified against XProxy v21.3.2 on Nov 17, 2026