Skip to content
General Augment Docs

Connect Telegram

POST
/api/v1/channels/telegram/connect

Verify a bot token, configure Telegram webhooks, and store the token encrypted.

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Admin-Key
Any of:
string
X-Admin-API-Key
Any of:
string

Request Body required

Section titled “Request Body required ”
TelegramConnectRequest

Payload for connecting one project to a Telegram bot.

object
bot_token
required
Bot Token
string
>= 20 characters <= 200 characters
description
Any of:
string
<= 512 characters
project_id
required
Project Id
string format: uuid
webhook_base_url
Any of:
string
>= 1 characters <= 300 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

TelegramConnectResponse

Response returned after connecting Telegram.

object
bot_id
Any of:
string
bot_username
Any of:
string
connected
required
Connected
boolean
deep_link
Any of:
string
last_message_at
Any of:
string format: date-time
message_count_24h
Message Count 24H
integer
0
project_id
required
Project Id
string format: uuid
webhook_secret_preview
required
Webhook Secret Preview
string
webhook_status
Webhook Status
string
default: not_configured
webhook_url
Any of:
string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string