API Reference
Dashboard
  1. API Reference
  2. Box API
  3. SMS & USSD

Send an SMS from the SIM of one slot

Use this to send one text message. Needs the SMS/USSD licence feature. Sending costs carrier credit and cannot be undone. Returns Sent failed! when the modem refuses or a field is missing. The Hub never relays this route.

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

Request body application/json · required

positionintegerrequired
phonestringrequired
messagestringrequired

Responses

Result.

statusbooleanrequired

True when the box accepted the request.

msgstringrequired

Outcome code or message (see the operation's error table).

Errors returned in msg

msgMeaningWhat to do
need_upgradeThe licence has no SMS/USSD feature.Upgrade the plan.
Sent failed!The modem did not send or a field is missing.Check the SIM credit and the body; retry once.
Verified against XProxy v21.3.2 on Nov 17, 2026