Introduction

Send SMS, Viber and WhatsApp messages, check one-time codes, run campaigns, keep contacts, shorten links and
read your social inbox from your own software.

Start here

Quick start

Your first SMS, step by step.

Authentication

The API key and the login token, and which calls take which.

Code samples

Send an SMS and receive a delivery report in Python, Node.js, PHP, Go and C#.

Addresses and formats

Server addresses, phone numbers, dates, lists.

Recipes

One-time code by SMS

Confirm a phone number with a code.

One-time code by Viber

Send the code in Viber and fall back to SMS.

A campaign, from contacts to result

Contacts, a segment, a campaign on several channels, the result.

Connect a CRM

Build messaging into Pipedrive, Bitrix24 or your own system.

When something goes wrong, and what comes back

Errors

Every status code and error body you can meet.

Refusal reasons

Every text the SMS calls answer when they refuse, and what to do.

Limits

What happens when you send too fast, and how to back off.

Delivery reports

How to learn whether an SMS arrived.

Viber and WhatsApp push reports

Status changes and incoming messages, sent to your server.

Changelog

What changed in the API, and when.

Two ways to sign your calls

API key. One key per company. The messaging calls take it: SMS, one-time codes, Viber and WhatsApp.
Nothing else is needed, so this is the short way to send a message from a server.

Login token. A short-lived token you get by signing in. Every other call takes it: campaigns, contacts,
segments, templates, sender names, statistics, payments, short links and the social inbox.

Authentication shows both in detail.

What you can do

Task	Section of the reference	Signed with
Send one SMS or the same SMS to many numbers	Messaging API → Send SMS	API key
Send a one-time code by SMS and check it	Messaging API → SMS Verification Codes	API key
Look up what happened to an SMS	Messaging API → SMS Delivery Status	API key
Send Viber messages and one-time codes	Messaging API → Viber	API key
Send WhatsApp campaigns, manage WhatsApp templates	Messaging API → WhatsApp	API key
Send one message over WhatsApp, Viber and SMS in turn	Messaging API → Channel Fallback	API key
Check your balance, prices and sender names	Messaging API → Balance & Prices, Sender Names	API key
Sign in, renew the token, sign out	Sign-In & Account	none (this is where you get the token)
Read or replace the API key, set allowed IP addresses	API Key & Allowed IPs	Login token
Create and run campaigns on any channel	Campaigns (v2)	Login token
Keep contacts and group them	Contacts (v2), Segments (v2)	Login token
Read statistics	Dashboard (v2), Notifications & Statistics	Login token
Manage message templates and sender names	Templates & Content, Sender Names & Rates	Login token
Create short links and read their clicks	Link Shortener	Login token
Read and answer social conversations	Social Platform	Login token

Before you start

You need a VeloConnect account. Sign in to the dashboard at
dashboard.veloconnect.me to top up the balance and to request a sender
name. Your API key is on the API page of the dashboard, shown as General Key.

Introduction

Start here#

Recipes#

When something goes wrong, and what comes back#

Two ways to sign your calls#