Используемые типы данных

Button

Используется в запросах для описания инлайн-кнопки под текстовым сообщением.

Имя параметра

Обязат.

Тип

Описание

Ограничения

text

Да

string

Текст на инлайн-кнопке

—

callback_data

Нет

json

Данные, которые будут отправлены на сервер при нажатии кнопки

—

Chat

Используется в ответах для описания чата (канала).

Имя параметра

Обязат.

Тип

Описание

Ограничения

type

Да

string

Тип чата

Возможные значения:

  • private — приватный чат;
  • group — групповой чат;
  • channel — канал.

id*

Нет

string

Идентификатор чата

У чата с типом private нет значимого идентификатора. В таком чате всегда два участника — бот и его собеседник. Собеседника нужно определять по объекту типа User, который обычно расположен рядом.

(*) Для группового чата (group) или канала (channel) идентификатор можно получить из адресной строки браузера:

  1. Откройте чат в веб-версии Мессенджера.
  2. Из адресной строки скопируйте набор символов после https://yandex.ru/chat/#/chats/.
  3. Если браузер применяет URL-кодирование в ссылке, замените %2F на слэш /.

File

Используется в ответах для описания файла.

Имя параметра

Обязат.

Тип

Описание

Ограничения

id

Да

string

Идентификатор файла для загрузки через API

—

name

Да

string

Имя файла

—

size

Да

integer

Размер файла в байтах

—

Image

Используется в ответах для описания изображения.

Имя параметра

Обязат.

Тип

Описание

Ограничения

file_id

Да

string

Идентификатор файла для загрузки через API

—

width

Да

integer

Ширина картинки

—

height

Да

integer

Высота картинки

—

size

Нет

integer

Размер файла в байтах

Указывается только для оригинала

name

Нет

string

Название файла (каким оно было при загрузке)

Указывается только для оригинала

Sender

Используется в ответах для описания отправителя сообщения.

Имя параметра

Обязат.

Тип

Описание

Ограничения

login

Да*

string

Логин пользователя, который отправил сообщение

Указывается для сообщений из чатов

ИЛИ id

Да*

string

id канала, администратор которого отправил сообщение

Указывается для сообщений в каналах

display_name

Нет

string

Отображаемое имя отправителя

—

robot

Нет

boolean

Признак, является ли отправитель ботом

—

(*) В ответе придет только один из параметров login или id в зависимости от того, куда было отправлено сообщение — в чат или канал.

Vote

Используется в ответах для описания проголосовавшего в опросе.

Имя параметра

Обязат.

Тип

Описание

Ограничения

timestamp

Да

integer

ID голоса

—

user

Да

Sender

Проголосовавший пользователь

—

Update

Используется в ответах для описания сообщения в обновлении.

Имя параметра

Обязат.

Тип

Описание

Ограничения

from

Да

Sender

Отправитель сообщения

—

chat

Да

Chat

Чат, в который было отправлено сообщение

—

text

Нет

string

Текст сообщения

—

timestamp

Да

integer

Время отправки сообщения по серверным часам: UNIX timestamp

—

message_id

Да

integer

Идентификатор сообщения в чате

—

update_id

Да

integer

Идентификатор обновления

—

file

Нет

File

Информация о вложенном в сообщение файле

—

images

Нет

Image[]

Информация о картинках

—

User

Используется в запросах для описания пользователя.

Имя параметра

Обязат.

Тип

Описание

Ограничения

login*

Да

string

Логин пользователя
  • Для аккаунтов на Яндексе (домен yandex.ru) логины могут использоваться без указания домена.
  • Для аккаунтов, созданных на других доменах, указывается полная форма логина <login>@<domain>.

(*) В качестве login может быть также указан адрес рассылки группы или подразделения, тогда в качестве User будет использоваться группа или подразделение.

Предыдущая
Получение обновлений: webhook