> ## Documentation Index > Fetch the complete documentation index at: https://docs.shortext.ny-corp.io/llms.txt > Use this file to discover all available pages before exploring further. # Connect a Telegram bot > The token is checked with Telegram and the bot starts receiving at once. A bot can be connected once only. Your customers write to `https://t.me/` and tap Start; add `?start=` (64 characters at most, letters, digits, _ and -) to know where they come from. ## OpenAPI ````yaml /api-reference/v2.0/openapi.json post /channels/telegram openapi: 3.1.0 info: title: Shortext API description: >- **Versioning**: every version is a frozen contract. A released version only receives additive changes (new endpoints, new optional fields, new response fields); anything breaking ships in a new version. Responses carry `X-Shortext-Api-Version`. When a version is scheduled for removal, responses also carry `Deprecation` and `Sunset` headers; after the sunset date the version answers HTTP 410. The list of versions and their status is available at `GET /api/versions`. **Responses**: always HTTP 200. Check `success` and `code` (`1000` = success), see `ApiEnvelope`. On failure, `trace_id` identifies the request for support. **Rate limit**: 300 requests per minute per company, shared by all its keys and by every API version. Responses carry `X-RateLimit-Limit` and `X-RateLimit-Remaining`; beyond the limit the API answers HTTP 429 with `Retry-After` (seconds) and the usual envelope. Prefer webhooks to polling. version: '2.0' servers: - url: https://shortext.ny-corp.io/api/v2.0 security: [] tags: - name: Agents description: Agents - name: Knowledge description: Knowledge - name: Dynamic links description: Dynamic links - name: Billing description: Billing - name: Campaigns description: Campaigns - name: Channels description: Channels - name: Conversations description: Conversations - name: Follow-ups description: Follow-ups - name: Account description: Account - name: Tickets description: Tickets - name: Templates description: Templates - name: Hosted sessions description: Hosted sessions - name: Webhooks description: Webhooks paths: /channels/telegram: post: tags: - Channels summary: Connect a Telegram bot description: >- The token is checked with Telegram and the bot starts receiving at once. A bot can be connected once only. Your customers write to `https://t.me/` and tap Start; add `?start=` (64 characters at most, letters, digits, _ and -) to know where they come from. operationId: createTelegramBot requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TelegramBotInput' responses: '200': description: >- Always HTTP 200: the outcome is in `success` and `code` (absolute value of the response code). content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiEnvelope' - properties: body: $ref: '#/components/schemas/Channel' type: object security: - bearerAuth: [] components: schemas: TelegramBotInput: properties: bot_token: description: >- Token given by @BotFather (/newbot). Required on creation; on update only to replace a regenerated token of the same bot. Never returned. type: string example: 123456789:AAH... name: description: Internal name, the name of the bot by default type: string maxLength: 255 agent_id: description: Agent answering on the bot; null detaches it type: - string - 'null' example: AGI-XXXXX enabled: description: Disabled, the bot no longer receives messages type: boolean default: true type: object ApiEnvelope: properties: success: type: boolean example: true code: type: integer example: 1000 message: type: string example: Request success. body: description: Endpoint payload, null when there is none token: description: Present only on authentication routes type: - string - 'null' trace_id: description: Present only when success is false type: - string - 'null' type: object Channel: properties: type: description: >- Public representation of a channel (API v2.0 and webhooks). The id is the one webhooks use as channel_id. type: string enum: - whatsapp - mail - shortext - telegram example: whatsapp id: description: >- Channel id (the channel_id of the webhooks): WhatsApp phone number id, mailbox id (mbx_...), Shortext endpoint id (ste_...) or Telegram bot id (tga_...) type: string example: '532867649916076' name: type: string example: +237 6 99 99 99 99 (Acme) enabled: type: boolean agent: description: >- null when the channel is detached: messages are stored, nobody answers automatically properties: id: type: string example: AGI-XXXXX name: type: string type: - object - 'null' settings: description: >- Shortext: endpoint settings. Telegram: username, bot_url, receiving, last_error. Null for the other channels properties: client_type: type: string example: server inbound_url: description: Where your server posts the messages of your users type: string reply_mode: description: >- `async`: replies pushed to webhook_url; `sync`: replies in the inbound response type: string enum: - async - sync sync_timeout: description: Seconds the sync mode waits for the replies type: integer webhook_url: type: - string - 'null' username: description: 'Telegram: the @username of the bot, without @' type: string bot_url: description: >- Telegram: link your customers open (add ?start= to know where they come from) type: string example: https://t.me/AcmeBot receiving: description: 'Telegram: the bot is enabled and Telegram delivers its messages' type: boolean last_error: description: 'Telegram: last refusal of Telegram, null when all is well' type: - string - 'null' type: - object - 'null' created_at: type: string format: date-time type: object securitySchemes: bearerAuth: type: http description: >- Company API key, sent as `Authorization: Bearer `. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs. scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.