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

Read the last USSD reply of one slot

Use this after /ussd/send when the reply arrives later. Returns personal data (balance, number). A missing or non-numeric position returns status false. The Hub never relays this route.

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

Query parameters

positionintegerrequired

Slot number, starting at 1.

Responses

Reply or failure.

statusbooleanoptional
dataobject | stringoptional
Verified against XProxy v21.3.2 on Nov 17, 2026