Quick start: send your first SMS
1. Get your API key
page. The key is shown there as General Key. A program that is already signed in can also read it with
Get the API key.
web page or a mobile app.
2. Check that the key works
{
"balanceAmount": 125.75,
"currenceCode": "USD"
}currenceCode is spelt this way in the API. Reference: Check balance.3. Send the message
sender_id is one of your approved sender names. List them with List sender names.phonenumber is in the international E.164 format: country code first, no 00, no spaces.sms_type chooses the price plan: T for one-time codes, P for promotional messages. Any other value istreated as transactional.
uid is your own reference. It comes back in the answer and in the delivery report.4. Read the answer
status.{
"message_id": 1284417,
"status": "S",
"remarks": "Message submitted successfully",
"uid": "order-1042",
"client_costs": [
{"phonenumber": "+37491234567", "cost": 0.021}
]
}{
"message_id": 0,
"status": "F",
"remarks": "SenderId is not found",
"uid": "order-1042",
"client_costs": null
}message_id. "Accepted" means we took the message, not that the phone received it. To learn whether itarrived, see Delivery reports.
Next
Check a verification code.
Send a WhatsApp campaign.
Modified at 2026-10-08 10:41:42