SMS API
Send a transactional SMS from your wallet, read its delivery status, the SMS overview and figures, and set the one-time code template.
- POSTSend an SMS
/v1/smsSend one transactional SMS.
- GETList SMS messages
/v1/smsList the team's SMS messages, newest first, with a cursor for the next page.
- GETGet an SMS message
/v1/sms/{id}Retrieve one SMS message by id, with its current delivery status and reason.
- GETGet the wallet balance
/v1/walletThe team's wallet balance, which SMS and SMS one-time codes are paid from, in minor units and as a decimal string.
- GETGet the SMS overview
/v1/sms/overviewWhat the SMS page shows: whether SMS is switched on, the sender ID texts to the signup country go out as, the team's sender ID requests and the paperwork…
- GETGet SMS figures
/v1/sms/statsThe team's texts over range (24h, 7d, 30d or 90d; 7d by default), counted as the SMS page counts them, test sends left out: sent (accepted for sending),…
- GETGet the code template
/v1/sms/templateThe text SMS one-time codes are sent with: template is the one in use, custom the team's own (null while the default is used).
- PUTChange the code template
/v1/sms/templateSet the team's own template for SMS one-time codes, or send null to go back to the default.