- API Reference
- Box API
- SMS & USSD
Read the latest SMS messages received by the SIM of one slot
Use this to fetch verification codes or carrier messages. Returns personal data: sender numbers and message text. Both parameters are required; a missing one, or a modem that cannot be read, returns status false with an empty list. The Hub never relays this route; call the box directly.
GET
/sms/readQuery parameters
positionintegerrequired
Slot number, starting at 1.
limitintegerrequired
Maximum number of messages.
Responses
Messages, or status false with an empty list.
statusbooleanoptional
dataobject | any[]optional
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.