Skip to main content
POST
Connect Telegram Bot

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Path Parameters

id
string
required

The agent's id (ag_…).

Body

application/json
token
string
required

The bot token @BotFather sent you. Stored encrypted; never returned.

Response

Connected. The agent's channels, naming the bot by its username.

Where an agent answers. A channel never set up has id: null.

agent
string
required

The agent's id.

Example:

"ag_5c4a5f93-2b1e-4d7a-9f60-8e2d1c3b4a71"

web
object
required

The website chat widget.

whatsapp
object
required

The WhatsApp Business number. Connected in the console.

telegram
object
required

The Telegram bot.

voice
object
required

Calls.