APIchat overview

What APIchat is, when to use it, its base URL, authentication and response codes.

APIchat is a Landbot channel for connecting a bot to a messaging service Landbot doesn't support natively: Telegram, Slack, SMS, your own app, anything you can reach over HTTP.

You build the flow in Landbot, and a middleware service you run translates between Landbot and the other service.

External channel (Telegram, Slack, SMS, your app)
        ⇅
Your middleware
        ⇅
Landbot APIchat (this API + your webhook)

Your middleware pushes the customer's messages into Landbot with POST /send/{customer_token}/. Landbot posts the bot's replies, and messages from human agents, to the webhook URL you set on the channel. See Webhooks.

Tip Bridge a channel to Landbot is a complete, runnable recipe for this two-way relay, with Telegram as the example.

APIchat is a separate API from the Platform API, on a different host and with a different token. You create an APIchat channel, and get its token, in the dashboard. The Help Center's API Chat section covers the setup.

Base URL

https://chat.landbot.io/v1/

Every path in this reference is relative to this URL and ends with /.

Authentication

Send the channel token in the Authorization header:

Authorization: Token YOUR_CHANNEL_TOKEN
Content-Type: application/json

The channel token comes from your APIchat channel's settings in the dashboard. It isn't the agent token the Platform API uses. A missing or wrong channel token answers 403. See Authentication.

Warning Treat your channel token like a password. It can send messages to every customer on the channel and change their data.

Response codes

Error bodies and every error status are in Errors. Request limits are in Rate limiting.