Skip to content
General Augment Docs

Test Telegram

POST
/api/v1/channels/telegram/test

Send a Telegram test message to a known chat id.

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 ”
TelegramTestRequest

Payload for sending a Telegram test message.

object
chat_id
required
Chat Id
string
>= 1 characters <= 100 characters
message
Message
string
default: Hello from your agent. >= 1 characters <= 4000 characters
project_id
required
Project Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

TelegramTestResponse

Telegram test-message send response.

object
ok
required
Ok
boolean
provider_response
required
Provider Response
object
key
additional properties
any

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