Telegram

Telegram status

Return the current Telegram bot connection status for a brain, including the connected bot's username when one is linked.

Authentication

x-api-keystring

Your Living Brain API key. Create one from the dashboard; keys are scoped to an organization and carry the role of the member they were issued to.

Path parameters

brainIdstringRequired
Brain id

Headers

x-subject-idstringRequired
Identifies the end user the request is made on behalf of. Brains are owned by a subject, so this determines which brains the caller can see.

Response

Null body when no bot was ever connected
idstring
Connection row id
brainIdstring
Owning brain id
botUsernamestring

Bot username (without @)

botFirstNamestring or null
Display name of the connected Telegram bot.
statusenum
Lifecycle state. Deprecated and archived items are hidden from listings by default.
connectedAtdatetime
ISO 8601 timestamp of when the bot was linked.
lastCaptureAtdatetime or null
ISO 8601 timestamp of the most recent message captured via Telegram.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error