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

  • Read only
  • Basic auth
  • Public API · since v20.8.0
  • Hub: blocked by the Hub
  • readSms
GET/sms/read

Query 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
Verified against XProxy v21.3.2 on Nov 17, 2026