- API Reference
- Box API
- SMS & USSD
Delete SMS messages stored on the SIM or modem of one slot
Use this to clear the inbox. Needs the SMS/USSD licence feature. Without index the modem's messages are deleted; Android phones accept index to delete one message. Deleted messages cannot be recovered. A body without position fails with HTTP 500. The Hub never relays this route.
/sms/deleteRequest body application/json · required
Message index (Android phones).
Responses
Result.
True when the box accepted the request.
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.
Unhandled error, for example a non-integer position or a missing required parameter.
Error name, e.g. internal_server_error or bad_request.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
need_upgrade | The licence has no SMS/USSD feature. | Upgrade the plan. |
Deleted failed! | The modem refused the delete. | Retry; check the modem. |