- API Reference
- Box API
- 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.
POST
/sms/sendRequest 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).
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. |
Sent failed! | The modem did not send or a field is missing. | Check the SIM credit and the body; retry once. |