SMS
Send messages from an approved sender ID and read delivery results. Messages are billed in SMS credits: one credit per 160 characters per recipient.
- GETList sender IDs
/sms-api/senderIdsAll sender IDs on your account with their approval status. Use the id of an approved sender when sending messages or OTPs.
- POSTRequest a sender ID
/sms-api/requestSenderIdSubmit a new sender ID for approval. Approval is manual and usually completes within one business day; poll the list endpoint for the status.
- POSTSend SMS
/sms-api/sendSend one message to a list of recipients, to whole contact groups, or both. Recipients are de-duplicated and normalised to the 233 format. The response returns a campaign id you can use to fetch per-recipient delivery status.
- GETSend SMS (GET)
/sms-api/sendThe same operation as Send SMS for platforms that can only make GET requests, such as USSD gateways and legacy PBX systems. Pass the fields in the query string; repeat recipients[] for each number.
- GETCampaign delivery report
/sms-api/campaignMessages/{campaignId}Per-recipient messages for a campaign returned by Send SMS, with the current delivery status of each. Paginated.