The shape of it
Predictable JSON over HTTPS
Requests and responses are JSON over HTTPS. Most of the API is at https://api.veloconnect.me; short links and their webhooks are at https://link-shortener-api.veloconnect.me, and numbers at https://connector-api.veloconnect.me.
The programmatic endpoints take your API ID: as api_id in the body or query string for SMS and verification, and in an apiId header for WhatsApp and Viber. The rest of the API — the same one the dashboard uses — takes a JWT from the login endpoint.
- Your API ID readable and regenerable from the dashboard or the API
- An IP allowlist on the API ID, so a leaked ID is not usable from anywhere else
- Idempotency keys where a retry could otherwise duplicate — link creation takes one
- Delivery reports posted to your callback URL, per SMS
What you can call
The API, area by area
Real paths from each part of the API, and for most of them a cURL request further down to copy.
-
Messaging
SMS to one number or many, and WhatsApp from approved templates.
-
POST /api/SendSMS -
POST /api/SendSMSMulti -
POST /api/partners/ whatsapp-campaigns
-
-
Verification
SMS codes we generate and check for you, or your own code over Viber.
-
POST /api/Verify -
POST /api/VerifyStatus -
POST /api/partners/ viber-otp
-
-
Contacts and segments
One record per person with every way to reach them, grouped into segments.
-
POST /api/v2/ contacts -
POST /api/v2/ contacts/ import-csv -
POST /api/v2/ segments
-
-
Campaigns
One send across several channels, each person tried in the order you set.
-
POST /api/v2/ campaigns -
POST /api/v2/ campaigns/ calculate-price -
POST /api/v2/ campaigns/ {id}/ preview-recipients
-
-
Short links
Tracked links with an expiry and a click cap, and the clicks behind them.
-
link-shortener-api.
veloconnect. me POST /api/links -
GET /api/analytics/ links/ {id} -
DELETE /api/links/ {id}
-
link-shortener-api.
-
Webhooks
Short-link events posted to your endpoint, with every delivery attempt kept.
-
link.created -
link.clicked -
link.updated -
link.deleted
-
-
Conversations
Read WhatsApp, Viber and SMS threads; reply on WhatsApp and Viber.
-
GET /api/partners/ whatsapp-conversations -
GET /api/partners/ whatsapp-conversations/ {id}/ messages -
POST /api/partners/ whatsapp-messages
-
-
Voice and numbers
Find a phone number in the country you need, and buy it.
-
connector-api.
veloconnect. me GET /api/did/ countries -
POST /api/did/ search -
POST /api/did/ purchase
-
connector-api.
-
Reporting
Sent, delivered, spend and balance for any date range, overall or by channel.
-
GET /api/v2/ dashboard/ kpis -
GET /api/v2/ dashboard/ channel-breakdown -
GET /api/v2/ dashboard/ trends
-
Examples
One call from every area
Real paths and field names, in cURL. Messaging, verification and conversations take your API ID; everything else takes a JWT, and the last tab shows how to get one. The values are placeholders.
curl -X POST https://api.veloconnect.me/api/SendSMS \
-H "Content-Type: application/json" \
-d '{
"api_id": "YOUR_API_ID",
"phonenumber": "+37491000000",
"sender_id": "YOUR_SENDER_ID",
"sms_type": "T",
"textmessage": "Your verification code is 482913",
"callback_url": "https://example.com/hooks/dlr"
}'
# 200 → { "message_id": …, "status": "S",
# "client_costs": [ { "phonenumber": …,
# "cost": … } ] }
# S = submitted, F = failed to submit. sms_type T is a
# one-time code, P promotional, anything else
# transactional. Delivery reports are POSTed to
# callback_url: answer 200, and expect the same
# status more than once.
# 1. Send a code. VeloConnect generates and keeps it.
curl -X POST https://api.veloconnect.me/api/Verify \
-H "Content-Type: application/json" \
-d '{ "api_id": "YOUR_API_ID",
"phonenumber": "+37491000000",
"sender_id": "YOUR_SENDER_ID" }'
# → { "verification_id": 123456, "status": …, … }
# 2. Check the code your user typed in.
curl -X POST https://api.veloconnect.me/api/VerifyStatus \
-H "Content-Type: application/json" \
-d '{ "api_id": "YOUR_API_ID",
"verfication_id": 123456,
"verfication_code": 4829 }'
# → { "verfication_id": 123456, "status": "V", … }
# V = verified, F = failed. "verfication" is the
# API's own spelling.
# Create a contact. Returns its id.
curl -X POST https://api.veloconnect.me/api/v2/contacts \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"firstName": "Anna",
"lastName": "Petrosyan",
"phoneNumber": "+37491000000",
"details": [
{ "type": "Email", "value": "[email protected]" }
]
}'
# → { "data": [ 1042 ] }
# Put contacts into a segment.
curl -X POST https://api.veloconnect.me/api/v2/segments \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "name": "October leads", "contactIds": [ 1042 ] }'
# → { "data": [ 77 ] }
curl -X POST https://api.veloconnect.me/api/v2/campaigns \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "October restock",
"segmentIds": [ 77 ],
"channels": [
{ "providerType": "Whatsapp", "priorityOrder": 1,
"templateId": 15, "senderId": 7 },
{ "providerType": "SMS", "priorityOrder": 2,
"message": "Back in stock today.",
"senderId": 3, "customerTrunkId": 5 }
]
}'
# → { "data": [ "CAMPAIGN_ID" ] } (a GUID)
# Template, sender and trunk ids are your account's.
# Add scheduleDate and timezone to send later.
# A recipient gets the SMS only if WhatsApp fails or
# cannot be used, never because of a delivery report.
LS=https://link-shortener-api.veloconnect.me
curl -X POST "$LS/api/links" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Idempotency-Key: order-8821-followup" \
-H "Content-Type: application/json" \
-d '{
"destinationUrl": "https://example.com/orders/8821",
"isActive": true,
"maxClicks": 500,
"expiresAtUtc": "2030-12-31T23:59:59Z"
}'
# 201 → { "id": "…", "code": "…", "isActive": true, … }
# Retrying with the same Idempotency-Key does not
# create a second link.
API=https://api.veloconnect.me
# WhatsApp conversations. API ID in the apiId header.
curl "$API/api/partners/whatsapp-conversations" \
-H "apiId: YOUR_API_ID"
# → { "data": [ { "items": [ { "id": 311,
# "chatId": "…", "fromPhoneNumber": "…",
# "unreadMessagesCount": 2, … } ], … } ] }
# Read one. This also marks its messages as read.
curl "$API/api/partners/whatsapp-conversations/311/messages" \
-H "apiId: YOUR_API_ID"
# Reply in the same chat.
curl -X POST "$API/api/partners/whatsapp-messages" \
-H "apiId: YOUR_API_ID" \
-H "Content-Type: application/json" \
-d '{ "chatId": "CHAT_ID",
"toPhoneNumber": "+37491000000",
"message": "Thanks, it ships today." }'
# WhatsApp takes free text only inside its
# 24-hour customer-service window.
CON=https://connector-api.veloconnect.me
# Country ids come from the numbers inventory.
curl "$CON/api/did/countries?Iso=US" \
-H "Authorization: Bearer YOUR_TOKEN"
# → { "data": [ { "id": "…", "name": "United States",
# "prefix": "1", "iso": "US" } ] }
# Numbers available in that country.
curl -X POST "$CON/api/did/search" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "countryId": "COUNTRY_ID" }'
# → { "data": [ { "numberE164": "…", "skuId": "…",
# "requiresCompliance": false, … } ] }
# Then /api/did/reservations and /api/did/purchase.
API=https://api.veloconnect.me
curl -G "$API/api/v2/dashboard/kpis" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d From=2026-10-01 -d To=2026-10-31
# → { "messagesSent": …, "messagesDelivered": …,
# "deliveryRate": …, "totalSpend": …,
# "balance": …, "currency": … }
# The same range per channel: targeted, sent,
# delivered, failed and skipped.
curl -G "$API/api/v2/dashboard/channel-breakdown" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d From=2026-10-01 -d To=2026-10-31
# Sign in. Your API ID's IP allowlist applies here.
curl -X POST \
https://api.veloconnect.me/api/customer-users/partner-login \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]",
"password": "YOUR_PASSWORD",
"api_id": "YOUR_API_ID"
}'
# → { "data": [ { "requiresTwoFactor": false,
# "token": { "token": "…",
# "refreshToken": "…" } } ] }
# With two-factor sign-in on, a challenge comes back
# instead of a token.
# Then, on every Bearer call:
# -H "Authorization: Bearer YOUR_TOKEN"
Conventions
Parameters and response shapes are in the API reference. If this page and the live API ever disagree, tell us — we would rather fix the page than have you debug it.
- Base URLs
https://api.veloconnect.me; short links and webhooks athttps://link-shortener-api.veloconnect.me; numbers athttps://connector-api.veloconnect.me- Programmatic auth
- API ID —
api_idin the body or query (SMS, Verify);apiIdheader (WhatsApp, Viber) - JWT auth
- Bearer token from
POST /api/customer-users/partner-login, refreshable - Key restrictions
- IP allowlist on the API ID, managed from the dashboard
- Format
- JSON request and response bodies
- Idempotency
Idempotency-Keyheader on link creation- Delivery reports
callback_urlon SendSMS, plus stored records- Events
- Webhook subscriptions for short-link events, with recorded delivery attempts
- Exports
- CSV on contacts, segments, campaigns, messages and payments
Developer questions
How do I get an API ID?
Create an account; your API ID is in the dashboard, and can be regenerated there or through the API. There is no sales call in the way of a test send — the thing you usually wait for is sender ID registration, not the ID.
Can I restrict where my API ID works from?
Yes. Set an IP allowlist and calls from any other address are refused. Until you set one, any address is accepted — so set it before the ID goes anywhere near a deployment.
What happens if my endpoint is down?
Webhook deliveries are recorded with their attempts and last error and retried with growing delays. Delivery reports to your callback_url are a notification, not the record: answer HTTP 200 once you have stored one, and expect the same status more than once. The status is always in the stored message records, which you can look up, so a missed report is never a lost one.
Is there an SDK?
The API is plain JSON over HTTPS and works with whatever HTTP client you already use. If a maintained SDK for your language would change your decision, tell us — that is useful for us to know.
Get an API ID and send something
An account, an API ID, and a message on the channel of your choice.