Send SMS

Sends one SMS to one phone number.

Authentication. Put your API key in the api_id field of the JSON body. No login token and no extra header are needed. If your account has a list of allowed IP addresses, the call must come from one of them.

Before you call. You need an approved sender name and enough balance.

Rules

phonenumber must be in international E.164 format. Send one number per call; for several numbers use the many-numbers call (/api/SendSMSMulti).

Send either textmessage or templateid.

Send either sms_type or rate_plan_id.

A local number such as 091234567 and the 00 prefix are refused.

The answer. The call answers HTTP 200 whether the message is accepted or refused, so read status.

status: "S": accepted. Keep message_id; you need it to look up the delivery result.

status: "F": refused. remarks says why, for example SenderId is not found.

Delivery result. Give a callback_url and we post the result to it, or ask later with the SMS status call (POST /api/partners/SmsDataRecords, filter campaignId = message_id).

Limits. Each API key may run a limited number of sends at the same time. Above the limit the call answers 429 with a Retry-After header: wait that many seconds and send again.

curl --location 'https://api.veloconnect.me/api/SendSMS' \ --header 'Content-Type: application/json' \ --data '{ "api_id": "API1234567890", "sender_id": "MyBrand", "phonenumber": "+37491234567", "textmessage": "Your verification code is 482913", "sms_type": "T", "uid": "order-1042" }'

{ "message_id": 1284417, "status": "S", "remarks": "Message submitted successfully", "uid": "order-1042", "client_costs": [ { "phonenumber": "+37491234567", "cost": 0.021 } ] }

Send SMS

Request

Responses