Введение

Introduction

Создание бота

Creating a bot

Авторизация

Authorization

Запросы и ответы

Requests & responses

Успех:

Success:

{ "ok": true, "result": { ... } }

Ошибка:

Error:

{ "ok": false, "error_code": 400, "description": "chat_id is required" }

Methods

getMe

Базовая информация о боте. Без параметров.

Basic info about the bot. No parameters.

$ curl https://ix.x2chat.com/api/v1/bot123456789:AAEh…/getMe

{
  "ok": true,
  "result": {
    "id": "uuid",
    "is_bot": true,
    "username": "my_cool_bot",
    "first_name": "My Cool Bot",
    "can_join_groups": true,
    "can_read_all_group_messages": false,
    "supports_inline_queries": false
  }
}

sendMessage

Отправить текстовое сообщение в чат. Бот должен быть участником чата.

Send a text message to a chat. The bot must be a member of the chat.

$ curl -X POST https://ix.x2chat.com/api/v1/bot<TOKEN>/sendMessage \
    -H "Content-Type: application/json" \
    -d '{
      "chat_id": 488,
      "text": "Привет! Я бот.",
      "reply_markup": {
        "inline_keyboard": [[
          {"text": "Yes", "callback_data": "yes"},
          {"text": "No",  "callback_data": "no"}
        ]]
      }
    }'

editMessageText

Заменить текст уже отправленного сообщения.

Replace text of an already-sent message.

{ "chat_id": 488, "message_id": "<uuid>", "text": "Обновлённый текст" }

deleteMessage

{ "chat_id": 488, "message_id": "<uuid>" }

forwardMessage

Бот должен быть участником обоих чатов.

Bot must be a member of both chats.

{ "chat_id": 488, "from_chat_id": 476, "message_id": "<uuid>" }

getUpdates

Long-polling: получить новые updates. Используйте если не настроили webhook.

Long polling: receive new updates. Use this if no webhook is set.

{
  "ok": true,
  "result": [
    { "update_id": 1, "message": { ... } },
    { "update_id": 2, "callback_query": { ... } }
  ]
}

setWebhook

Зарегистрировать URL, на который X2Chat будет POST'ить updates. После регистрации webhook — getUpdates перестаёт получать новые updates.

Register a URL to which X2Chat will POST updates. Once a webhook is set, getUpdates will no longer return new updates.

{
  "url": "https://your-server.com/x2chat-webhook",
  "secret_token": "random_secret_for_x_telegram_header",
  "allowed_updates": ["message", "callback_query"],
  "max_connections": 40
}

setMyCommands

{
  "commands": [
    { "command": "start", "description": "Начать работу" },
    { "command": "help",  "description": "Справка" }
  ]
}

answerCallbackQuery

Подтвердить нажатие на InlineKeyboard-кнопку. text покажется как тост или alert у пользователя.

Acknowledge a tap on an InlineKeyboard button. text is shown as toast or alert to the user.

{
  "callback_query_id": "<id>",
  "text": "Спасибо за ответ!",
  "show_alert": false
}

Типы updates

Update types

Inline-клавиатура

Inline keyboard

{
  "inline_keyboard": [
    [
      { "text": "👍 Like",    "callback_data": "like" },
      { "text": "👎 Dislike", "callback_data": "dislike" }
    ],
    [
      { "text": "📝 Open page", "url": "https://example.com" }
    ]
  ]
}

Поля кнопки:

Button fields:

Команды

Commands

Examples

Node.js

import fetch from 'node-fetch';

const TOKEN = '123456789:AAEh…';
const BASE = `https://ix.x2chat.com/api/v1/bot${TOKEN}`;

async function sendMessage(chatId, text, replyMarkup) {
  const r = await fetch(`${BASE}/sendMessage`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ chat_id: chatId, text, reply_markup: replyMarkup }),
  });
  return r.json();
}

async function poll() {
  let offset = 0;
  while (true) {
    const resp = await fetch(`${BASE}/getUpdates?offset=${offset}&limit=100`);
    const { result } = await resp.json();
    for (const u of result) {
      offset = Math.max(offset, u.update_id);
      if (u.message?.text === '/start') {
        await sendMessage(u.message.chat.id, 'Hello!');
      }
    }
    if (result.length === 0) await new Promise(r => setTimeout(r, 1000));
  }
}
poll();

Python (requests)

import requests, time

TOKEN = '123456789:AAEh…'
BASE = f'https://ix.x2chat.com/api/v1/bot{TOKEN}'

def send_message(chat_id, text, reply_markup=None):
    return requests.post(f'{BASE}/sendMessage', json={
        'chat_id': chat_id, 'text': text,
        'reply_markup': reply_markup,
    }).json()

offset = 0
while True:
    r = requests.get(f'{BASE}/getUpdates', params={'offset': offset, 'limit': 100}).json()
    for u in r['result']:
        offset = max(offset, u['update_id'])
        if u.get('message', {}).get('text') == '/start':
            send_message(u['message']['chat']['id'], 'Привет!')
    if not r['result']: time.sleep(1)

Простой webhook (Express)

Simple webhook (Express)

import express from 'express';
const app = express();
app.use(express.json());

app.post('/x2chat-webhook', (req, res) => {
  const update = req.body;
  if (update.callback_query) {
    const { id, data } = update.callback_query;
    // answer back
    fetch(`https://ix.x2chat.com/api/v1/bot<TOKEN>/answerCallbackQuery`, {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ callback_query_id: id, text: `Получено: ${data}` }),
    });
  }
  res.json({ ok: true });
});
app.listen(3000);

Лимиты и особенности

Limits & specifics

© X2Chat · Поддержка: bots@x2chat.com

© X2Chat · Support: bots@x2chat.com