Documentation Connections & identifiers
DEVELOPER GUIDE

Connections & identifiers

A connection is one linked account. A channel type describes the provider behind it.

The shared contract

Each connection has a stable id, title, code, channel_type, account_id and status. Use its ID in API calls; display names can change.

Channel typeAccount / recipient identifierAuthentication
whatsappInternational phone, such as +971501234567WhatsApp linked-device QR
telegramBot identity / Telegram chat IDBotFather token · coming soon
emailSender / recipient email addressSMTP credentials · coming soon
baleProvider-specific chat IDPlanned

Phone numbers

Enter a country code and national phone number separately in the UI. Public API numbers use international format with +. The WhatsApp adapter resolves the provider ID internally. Do not replace +971 with 00971.

Connection lifecycle

Typical lifecycle
created → initializing → qr_ready → authenticated → ready

ready → disconnected → reconnecting → ready

Connection updates and QR rotations arrive over the authenticated event stream. Sessions are stored durably and restored after a normal restart. A provider logout or revoked device still requires relinking.

Multiple connections

Give each account a meaningful title, such as “Customer support” or “Sales”. The Normal tier allows one connection of each type. Paid tiers apply their connection limit across all types combined.

Available capabilities

WhatsApp supports private and group text, images, multiple images, group creation, incoming messages and callbacks. Other channel types appear as coming soon until their provider adapter is enabled.

Need help with an integration?Talk to support