RetailCRM
API docs by Redocly

MG Node Bot API (1.0.0)

Download OpenAPI specification:Download

MG Node Bot API

Bot

Получить список ботов

Получает список всех доступных ботов с необязательной фильтрацией

Authorizations:
bot_token
query Parameters
id
integer <int> >= 1

Уникальный идентификатор объекта

self
string (Boolean)
Enum: "1" "0" "true" "false"

Фильтр для включения только текущего бота

active
string (Boolean)
Enum: "1" "0" "true" "false"

Фильтрует ботов по статусу активности

role
Array of strings (Role)
Items Enum: "responsible" "distributor" "hidden"
Example: role=responsible

Фильтрует ботов по одной или нескольким назначенным ролям

since
string <date-time>

Нижняя граница даты последнего обновления объекта

since_id
integer <int64> >= 1

Нижняя граница идентификаторов объектов

until
string <date-time>

Верхняя граница даты последнего обновления объекта

until_id
integer <int64> >= 1

Верхняя граница идентификаторов объектов

limit
integer <int> [ 1 .. 1000 ]

Количество элементов в ответе (по умолчанию 100)

Responses

Response Schema: application/json
Array
id
required
integer <int64>

Уникальный идентификатор бота

name
required
string

Читаемое имя бота

client_id
required
string

Уникальный внешний идентификатор клиента бота

roles
required
Array of strings (Role)
Items Enum: "responsible" "distributor" "hidden"

Список ролей, назначенных боту

created_at
required
string <date-time>

Дата и время в формате RFC 3339 с микросекундами

is_active
required
boolean

Показывает, активен ли бот

is_self
required
boolean

Показывает, является ли этот бот текущим аутентифицированным

is_system
required
boolean

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

avatar_url
string <uri>

Публичный URL аватара бота

deactivated_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

updated_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

Response samples

Content type
application/json
[
  • {
    • "avatar_url": "https://avatar.demo/avatar-url",
    • "client_id": "demo-bot-id",
    • "created_at": "2006-01-02T15:04:05.999999Z07:00",
    • "deactivated_at": "2006-01-02T15:04:05.999999Z07:00",
    • "id": 1,
    • "is_active": true,
    • "is_self": true,
    • "is_system": false,
    • "name": "demo-bot",
    • "roles": [
      ],
    • "updated_at": "2006-01-02T15:04:05.999999Z07:00"
    }
]

Обновить текущий профиль бота

Обновляет сведения о текущем аутентифицированном боте

Authorizations:
bot_token
Request Body schema: application/json

Запрос на обновление бота

name
string <= 255 characters

Имя бота

avatar_url
string <uri>

URL аватара бота

roles
Array of strings (Roles)
Items Enum: "responsible" "distributor" "hidden"

Массив типов ролей бота

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{ }

Удалить команду бота

Удаляет команду, связанную с указанным именем

Authorizations:
bot_token
path Parameters
command_name
required
string <= 32 characters

Уникальный идентификатор команды бота для ссылки на конкретную команду

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Channel

Получить доступные каналы

Возвращает список каналов с необязательными фильтрами

Authorizations:
bot_token
query Parameters
id
integer <int> >= 1

Уникальный идентификатор объекта

types
Array of strings (ChannelType)
Items Enum: "telegram" "tiktok" "fbmessenger" "viber" "whatsapp" "skype" "vk" "instagram" "consultant" "yandex_chat" "odnoklassniki" "max" "ozon" "wildberries" "yandex_market" "mega_market" "avito" "drom" "youla" "custom"
Example: types=telegram

Фильтрует каналы по указанным типам

active
string (Boolean)
Enum: "1" "0" "true" "false"

Фильтрует каналы по статусу активности

since
string <date-time>

Нижняя граница даты последнего обновления объекта

since_id
integer <int64> >= 1

Нижняя граница идентификаторов объектов

until
string <date-time>

Верхняя граница даты последнего обновления объекта

until_id
integer <int64> >= 1

Верхняя граница идентификаторов объектов

limit
integer <int> [ 1 .. 1000 ]

Количество элементов в ответе (по умолчанию 100)

Responses

Response Schema: application/json
Array
id
required
integer <int64>

Уникальный идентификатор канала

type
required
string
Enum: "telegram" "tiktok" "fbmessenger" "viber" "whatsapp" "skype" "vk" "instagram" "consultant" "yandex_chat" "odnoklassniki" "max" "ozon" "wildberries" "yandex_market" "mega_market" "avito" "drom" "youla" "custom"

Тип канала связи

created_at
required
string <date-time>

Дата и время в формате RFC 3339 с микросекундами

activated_at
required
string <date-time>

Дата и время в формате RFC 3339 с микросекундами

is_active
required
boolean

Показывает, активен ли канал

required
object

Конфигурационные настройки, специфичные для типа канала

deactivated_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

name
string or null

Необязательное читаемое имя канала

updated_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

Response samples

Content type
application/json
[
  • {
    • "activated_at": "2006-01-02T15:04:05.999999Z07:00",
    • "created_at": "2006-01-02T15:04:05.999999Z07:00",
    • "deactivated_at": "2006-01-02T15:04:05.999999Z07:00",
    • "id": 1,
    • "is_active": true,
    • "name": "Example Channel",
    • "settings": {
      },
    • "type": "telegram",
    • "updated_at": "2006-01-02T15:04:05.999999Z07:00"
    }
]

Chat

Получить список чатов

Возвращает отфильтрованный список чатов, доступных боту

Authorizations:
bot_token
query Parameters
id
integer <int> >= 1

Уникальный идентификатор объекта

since
string <date-time>

Нижняя граница даты последнего обновления объекта

until
string <date-time>

Верхняя граница даты последнего обновления объекта

limit
integer <int> [ 1 .. 1000 ]

Количество элементов в ответе (по умолчанию 100)

since_id
integer <int64> >= 1

Нижняя граница идентификаторов объектов

until_id
integer <int64> >= 1

Верхняя граница идентификаторов объектов

channel_id
integer >= 1

Фильтр по ID канала

channel_type
string (ChannelType)
Enum: "telegram" "tiktok" "fbmessenger" "viber" "whatsapp" "skype" "vk" "instagram" "consultant" "yandex_chat" "odnoklassniki" "max" "ozon" "wildberries" "yandex_market" "mega_market" "avito" "drom" "youla" "custom"
Example: channel_type=telegram

Фильтр по типу канала

customer_id
integer >= 1

Фильтр по ID клиента

customer_external_id
string non-empty

Фильтр по внешнему ID клиента

include_mass_communication
string (Boolean)
Enum: "1" "0" "true" "false"

Включать ли чаты/сообщения массовых коммуникаций

Responses

Response Schema: application/json
Array
id
required
integer <int64>

Уникальный идентификатор чата

not_read_messages
required
integer <int64>

Количество непрочитанных сообщений в чате

unread
required
boolean

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

author_id
integer <int64>
Deprecated

ID пользователя, инициировавшего чат

avatar
string

URL аватара чата

object or null

Канал связи (например, Telegram, Viber), связанный с чатом

object or null

Клиент, участвующий в чате (если есть)

last_activity
string <date-time>

Дата и время в формате RFC 3339

object

Последний диалог в чате

object or null

Последнее сообщение в чате (включая системные/служебные)

object or null

Последнее пользовательское сообщение в чате

name
string

Отображаемое имя чата

reply_deadline
string <date-time>

Дата и время в формате RFC 3339

waiting_level
string or null
Enum: "warning" "danger" "none"

Текущий уровень срочности чата на основе бизнес‑логики (например, нарушения SLA)

waiting_level_transition_time
string or null <date-time>

Дата и время в формате RFC 3339

created_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

updated_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

Response samples

Content type
application/json
[
  • {
    • "author_id": 100,
    • "avatar": "https://avatar.demo/chat-avatar",
    • "channel": {
      },
    • "customer": {
      },
    • "id": 1,
    • "last_activity": "2006-01-02T15:04:05Z07:00",
    • "last_dialog": {
      },
    • "last_message": {
      },
    • "last_user_message": {
      },
    • "name": "Example Chat",
    • "not_read_messages": 12,
    • "reply_deadline": "2006-01-02T15:04:05Z07:00",
    • "unread": true,
    • "waiting_level": "warning",
    • "waiting_level_transition_time": "2006-01-02T15:04:05Z07:00",
    • "created_at": "2006-01-02T15:04:05.999999Z07:00",
    • "updated_at": "2006-01-02T15:04:05.999999Z07:00"
    }
]

Command

Список доступных команд бота

Возвращает список команд бота, отфильтрованных по необязательным параметрам

Authorizations:
bot_token
query Parameters
id
integer <int> >= 1

Уникальный идентификатор объекта

limit
integer <int> [ 1 .. 1000 ]

Количество элементов в ответе (по умолчанию 100)

since_id
integer <int64> >= 1

Нижняя граница идентификаторов объектов

since
string <date-time>

Нижняя граница даты последнего обновления объекта

until_id
integer <int64> >= 1

Верхняя граница идентификаторов объектов

until
string <date-time>

Верхняя граница даты последнего обновления объекта

name
string <= 32 characters

Фильтр команд по имени

Responses

Response Schema: application/json
Array
created_at
required
string <date-time>

Дата и время в формате RFC 3339 с микросекундами

description
required
string

Читаемое описание команды

id
required
integer <int64>

Уникальный идентификатор команды

name
required
string

Уникальное имя команды, используемое для выполнения или идентификации

updated_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

Response samples

Content type
application/json
[
  • {
    • "created_at": "2006-01-02T15:04:05.999999Z07:00",
    • "description": "demo-description",
    • "id": 1,
    • "name": "demo-name",
    • "updated_at": "2006-01-02T15:04:05.999999Z07:00"
    }
]

Создать или обновить команду

Создаёт новую команду либо обновляет существующую с указанным именем

Authorizations:
bot_token
path Parameters
command_name
required
string <= 32 characters

Уникальный идентификатор команды бота для ссылки на конкретную команду

Request Body schema: application/json

Тело запроса для создания/обновления команды бота

One of
description
required
string <= 64 characters

Читаемое описание назначения/поведения команды

name
string

Уникальный идентификатор команды

Responses

Response Schema: application/json
created_at
required
string <date-time>

Дата и время в формате RFC 3339 с микросекундами

description
required
string

Читаемое описание команды

id
required
integer <int64>

Уникальный идентификатор команды

name
required
string

Уникальное имя команды, используемое для выполнения или идентификации

updated_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

Request samples

Content type
application/json
Example
{
  • "name": "Demo command name",
  • "description": "Demo command description"
}

Response samples

Content type
application/json
{
  • "created_at": "2006-01-02T15:04:05Z07:00",
  • "description": "demo-description",
  • "id": 1,
  • "name": "demo-name",
  • "updated_at": "2006-01-02T15:04:05Z07:00"
}

Customer

Получить список клиентов

Возвращает список клиентов

Authorizations:
bot_token
query Parameters
id
integer <int> >= 1

Уникальный идентификатор объекта

since
string <date-time>

Нижняя граница даты последнего обновления объекта

until
string <date-time>

Верхняя граница даты последнего обновления объекта

since_id
integer <int64> >= 1

Нижняя граница идентификаторов объектов

until_id
integer <int64> >= 1

Верхняя граница идентификаторов объектов

limit
integer <int> [ 1 .. 1000 ]

Количество элементов в ответе (по умолчанию 100)

channel_id
integer >= 1

Фильтр по ID канала

channel_type
string (ChannelType)
Enum: "telegram" "tiktok" "fbmessenger" "viber" "whatsapp" "skype" "vk" "instagram" "consultant" "yandex_chat" "odnoklassniki" "max" "ozon" "wildberries" "yandex_market" "mega_market" "avito" "drom" "youla" "custom"
Example: channel_type=telegram

Фильтр по типу канала

external_id
string

Фильтр по внешнему идентификатору

Responses

Response Schema: application/json
Array
id
required
integer <int64>
created_at
required
string <date-time>

Дата и время в формате RFC 3339 с микросекундами

is_blocked
required
boolean
external_id
string or null
channel_id
integer or null <int64>
username
string or null
first_name
string or null
last_name
string or null
updated_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

revoked_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

avatar_url
string or null
profile_url
string or null
country
string or null
language
string or null
phone
string or null
email
string or null
object or null

UTM‑параметры для отслеживания маркетинговых кампаний

Response samples

Content type
application/json
[
  • {
    • "id": 1,
    • "external_id": "e3456",
    • "channel_id": 5,
    • "username": "demo_user",
    • "first_name": "Thomas",
    • "last_name": "Smith",
    • "created_at": "2006-01-02T15:04:05.999999Z07:00",
    • "updated_at": "2006-01-02T15:04:05.999999Z07:00",
    • "revoked_at": "2006-01-02T15:04:05.999999Z07:00",
    • "avatar_url": "https://avatar.demo/demo-avatar",
    • "profile_url": "https://profile.demo/demo-profile",
    • "country": "US",
    • "language": "US",
    • "phone": "928-970-2685",
    • "email": "demo@customer.demo",
    • "is_blocked": true,
    • "utm": {
      }
    }
]

Dialog

Получить список диалогов

Возвращает список диалогов с необязательными фильтрами

Authorizations:
bot_token
query Parameters
id
integer <int> >= 1

Уникальный идентификатор объекта

since
string <date-time>

Нижняя граница даты последнего обновления объекта

until
string <date-time>

Верхняя граница даты последнего обновления объекта

since_id
integer <int64> >= 1

Нижняя граница идентификаторов объектов

until_id
integer <int64> >= 1

Верхняя граница идентификаторов объектов

limit
integer <int> [ 1 .. 1000 ]

Количество элементов в ответе (по умолчанию 100)

chat_id
integer >= 1

Фильтр по идентификатору чата

user_id
integer >= 1

Фильтр по ID пользователя

bot_id
integer >= 1

Фильтр по ID бота

active
string (Boolean)
Enum: "1" "0" "true" "false"

Фильтр по флагу активности

assign
string (Boolean)
Enum: "1" "0" "true" "false"

Фильтр по статусу назначения

include_mass_communication
string (Boolean)
Enum: "1" "0" "true" "false"

Включать ли чаты/сообщения массовых коммуникаций

Responses

Response Schema: application/json
Array
chat_id
required
integer <int64>

ID чата, к которому принадлежит диалог

created_at
required
string <date-time>

Дата и время в формате RFC 3339 с микросекундами

id
required
integer <int64>

Уникальный идентификатор диалога

is_active
required
boolean

Показывает, активен ли диалог

is_assigned
required
boolean

Показывает, назначен ли диалог кому‑нибудь

begin_message_id
integer or null <int64>

ID первого сообщения в диалоге

bot_id
integer or null <int64>

ID бота, назначенного для диалога (если есть)

closed_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

ending_message_id
integer or null <int64>

ID последнего сообщения в диалоге

object

Текущая ответственная сущность диалога

Array of objects (Tag)

Список тегов, связанных с диалогом

updated_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

object

UTM‑параметры, связанные с диалогом

Response samples

Content type
application/json
[
  • {
    • "begin_message_id": 32,
    • "bot_id": 20,
    • "chat_id": 3,
    • "closed_at": "2006-01-02T15:04:05.999999Z07:00",
    • "created_at": "2006-01-02T15:04:05.999999Z07:00",
    • "ending_message_id": 39,
    • "id": 1,
    • "is_active": false,
    • "is_assigned": true,
    • "responsible": {
      },
    • "tags": [
      ],
    • "updated_at": "2006-01-02T15:04:05.999999Z07:00",
    • "utm": {
      }
    }
]

Назначить ответственного пользователя для диалога

Устанавливает или обновляет пользователя, ответственного за указанный диалог

Authorizations:
bot_token
path Parameters
dialog_id
required
integer <int64>
Example: 1

Уникальный идентификатор диалога

Request Body schema: application/json

Запрос на назначение ответственного пользователя и бота для диалога

bot_id
integer <int64>

Уникальный идентификатор бота, назначенного для диалога

user_id
integer <int64>

Уникальный идентификатор пользователя в чатах, назначаемого ответственным

Responses

Response Schema: application/json
required
object

Текущий ответственный пользователь диалога

is_reassign
required
boolean

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

left_user_id
integer or null <int64>

Уникальный идентификатор пользователя в чатах, который покинул диалог (если применимо)

object or null

Предыдущий ответственный пользователь до переназначения

Request samples

Content type
application/json
{
  • "bot_id": 1,
  • "user_id": 1
}

Response samples

Content type
application/json
{
  • "is_reassign": true,
  • "left_user_id": 0,
  • "previous_responsible": {
    • "assigned_at": "2006-01-02T15:04:05.999999Z07:00",
    • "external_id": "string",
    • "id": 1,
    • "type": "user"
    },
  • "responsible": {
    • "assigned_at": "2006-01-02T15:04:05.999999Z07:00",
    • "external_id": "string",
    • "id": 1,
    • "type": "user"
    }
}

Отменить назначение ответственного пользователя для диалога

Снимает текущего ответственного пользователя с указанного диалога

Authorizations:
bot_token
path Parameters
dialog_id
required
integer <int64>
Example: 1

Уникальный идентификатор диалога

Responses

Response Schema: application/json
object or null

Предыдущий ответственный пользователь до снятия назначения

Response samples

Content type
application/json
{
  • "previous_responsible": {
    • "assigned_at": "2006-01-02T15:04:05.999999Z07:00",
    • "external_id": "string",
    • "id": 1,
    • "type": "user"
    }
}

Закрыть диалог

Помечает указанный диалог как закрытый, блокируя дальнейшие обновления или сообщения

Authorizations:
bot_token
path Parameters
dialog_id
required
integer <int64>
Example: 1

Уникальный идентификатор диалога

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Добавить теги к диалогу

Добавляет теги к указанному диалогу

Authorizations:
bot_token
path Parameters
dialog_id
required
integer <int64>
Example: 1

Уникальный идентификатор диалога

Request Body schema: application/json

Запрос на добавление тегов к диалогу

required
Array of objects non-empty

Список тегов для добавления

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "tags": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{ }

Удалить теги из диалога

Удаляет теги из указанного диалога

Authorizations:
bot_token
path Parameters
dialog_id
required
integer <int64>
Example: 1

Уникальный идентификатор диалога

Request Body schema: application/json

Запрос на удаление тегов из диалога

required
Array of objects non-empty

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "tags": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{ }

Создать диалог

Создаёт новый диалог в указанном чате

Authorizations:
bot_token
path Parameters
chat_id
required
integer <int64>
Example: 1

Уникальный идентификатор чата

Request Body schema: application/json

Запрос на создание нового диалога

bot_id
integer or null <int64> >= 1

Идентификатор бота, который начинает диалог

user_id
integer or null <int64> >= 1

Уникальный идентификатор пользователя в чатах, который начинает диалог

Responses

Response Schema: application/json
id
required
integer <int64>

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

created_at
required
string <date-time>

Дата и время в формате RFC 3339 с микросекундами

Request samples

Content type
application/json
{
  • "bot_id": 32,
  • "user_id": 43
}

Response samples

Content type
application/json
{
  • "created_at": "2006-01-02T15:04:05.999999Z07:00",
  • "id": 1
}

File

Получить прямой URL файла по ID

Возвращает прямой URL для скачивания ранее загруженного файла по его уникальному идентификатору

Authorizations:
bot_token
path Parameters
id
required
string <uuid>
Example: e33e5398-814a-47d6-902a-466ba120ce45

Уникальный идентификатор (UUID) файла

Responses

Response Schema: application/json
id
required
string <uuid>

Уникальный идентификатор файла

type
required
string (FileType)
Enum: "none" "image" "video" "file" "audio"

Тип файла

size
required
integer

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

transcription
string or null

Необязательная текстовая транскрипция содержимого файла, если применимо

transcription_status
string
Enum: "in_progress" "ready" "error"

Статус транскрипции файла

url
string <uri>

Прямой URL для скачивания или доступа к загруженному файлу

Response samples

Content type
application/json
{
  • "id": "e33e5398-814a-47d6-902a-466ba120ce45",
  • "size": 102384,
  • "transcription": "Demo transcription",
  • "transcription_status": "ready",
  • "type": "file",
  • "url": "https://file.demo/demo-file"
}

Загрузить новый файл

Загружает новый файл на сервер с использованием multipart/form-data

Authorizations:
bot_token
Request Body schema: multipart/form-data
required
file
required
string <binary>

Двоичные данные файла для загрузки (изображение, документ, видео)

Responses

Response Schema: application/json
id
required
string <uuid>

Уникальный идентификатор файла

type
required
string (FileType)
Enum: "none" "image" "video" "file" "audio"

Тип файла

size
required
integer

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

transcription
string or null

Необязательная текстовая транскрипция содержимого файла, если применимо

transcription_status
string
Enum: "in_progress" "ready" "error"

Статус транскрипции файла

Response samples

Content type
application/json
{
  • "id": "e33e5398-814a-47d6-902a-466ba120ce45",
  • "size": 102384,
  • "transcription": "Demo transcription",
  • "transcription_status": "ready",
  • "type": "file"
}

Загрузить файл по URL

Скачивает файл по указанному URL и загружает его на сервер

Authorizations:
bot_token
Request Body schema: application/json

Тело запроса для загрузки файла по удалённому URL

url
required
string <uri>

URL файла для скачивания и загрузки

Responses

Response Schema: application/json
id
required
string <uuid>

Уникальный идентификатор файла

type
required
string (FileType)
Enum: "none" "image" "video" "file" "audio"

Тип файла

size
required
integer

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

transcription
string or null

Необязательная текстовая транскрипция содержимого файла, если применимо

transcription_status
string
Enum: "in_progress" "ready" "error"

Статус транскрипции файла

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "e33e5398-814a-47d6-902a-466ba120ce45",
  • "size": 102384,
  • "transcription": "Demo transcription",
  • "transcription_status": "ready",
  • "type": "file"
}

Обновляет метаданные ранее загруженного файла

Обновляет метаданные указанного файла по его идентификатору

Authorizations:
bot_token
path Parameters
id
required
string <uuid>
Example: e33e5398-814a-47d6-902a-466ba120ce45

Уникальный идентификатор (UUID) файла

Request Body schema: application/json

Тело запроса для обновления метаданных файла

transcription
required
string

Обновлённая транскрипция, связанная с файлом

transcription_status
string (FileTranscriptionStatus)
Enum: "in_progress" "ready" "error"

Текущий статус транскрипции файла

Responses

Response Schema: application/json
id
required
string <uuid>

Уникальный идентификатор файла

type
required
string (FileType)
Enum: "none" "image" "video" "file" "audio"

Тип файла

size
required
integer

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

transcription
string or null

Необязательная текстовая транскрипция содержимого файла, если применимо

transcription_status
string
Enum: "in_progress" "ready" "error"

Статус транскрипции файла

Request samples

Content type
application/json
{
  • "transcription": "Example updated transcription",
  • "transcription_status": "ready"
}

Response samples

Content type
application/json
{
  • "id": "e33e5398-814a-47d6-902a-466ba120ce45",
  • "size": 102384,
  • "transcription": "Demo transcription",
  • "transcription_status": "ready",
  • "type": "file"
}

User

Получает список участников чата

Возвращает список участников чата с учётом необязательных фильтров

Authorizations:
bot_token
query Parameters
id
integer <int> >= 1

Уникальный идентификатор объекта

since
string <date-time>

Нижняя граница даты последнего обновления объекта

until
string <date-time>

Верхняя граница даты последнего обновления объекта

since_id
integer <int64> >= 1

Нижняя граница идентификаторов объектов

until_id
integer <int64> >= 1

Верхняя граница идентификаторов объектов

limit
integer <int> [ 1 .. 1000 ]

Количество элементов в ответе (по умолчанию 100)

chat_id
integer >= 1

Фильтр по идентификатору чата

user_id
integer >= 1

Фильтр по ID пользователя

state
string
Enum: "active" "kicked" "leaved"

Фильтр по состоянию участника

Responses

Response Schema: application/json
Array
chat_id
required
integer <int64>

ID чата, участником которого является пользователь

created_at
required
string <date-time>

Дата и время в формате RFC 3339 с микросекундами

id
required
integer <int64>

Уникальный ID записи о членстве в чате

is_author
required
boolean
Deprecated

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

state
required
string
Enum: "active" "kicked" "leaved"

Состояние участника пользователя в чате

user_id
required
integer <int64>

Уникальный идентификатор пользователя в чатах

updated_at
string <date-time>

Дата и время в формате RFC 3339 с микросекундами

Response samples

Content type
application/json
[
  • {
    • "chat_id": 123,
    • "created_at": "2006-01-02T15:04:05.999999Z07:00",
    • "updated_at": "2006-01-02T15:04:05.999999Z07:00",
    • "id": 123,
    • "is_author": false,
    • "state": "active",
    • "user_id": 123
    }
]

Получает список пользователей

Возвращает список пользователей с учётом необязательных фильтров

Authorizations:
bot_token
query Parameters
id
integer <int> >= 1

Уникальный идентификатор объекта

since
string <date-time>

Нижняя граница даты последнего обновления объекта

until
string <date-time>

Верхняя граница даты последнего обновления объекта

since_id
integer <int64> >= 1

Нижняя граница идентификаторов объектов

until_id
integer <int64> >= 1

Верхняя граница идентификаторов объектов

limit
integer <int> [ 1 .. 1000 ]

Количество элементов в ответе (по умолчанию 100)

active
string (Boolean)
Enum: "1" "0" "true" "false"

Фильтр пользователей по статусу активности

online
string (Boolean)
Enum: "1" "0" "true" "false"

Фильтр пользователей по онлайн‑статусу

external_id
string

Фильтр по внешнему идентификатору

Responses

Response Schema: application/json
Array
id
required
integer <int64>

Внутренний ID пользователя

created_at
required
string <date-time>

Дата и время в формате RFC 3339 с микросекундами

available
required
boolean

Показывает, доступен ли пользователь для общения

is_online
required
boolean

Флаг, указывающий, находится ли пользователь в сети

connected
required
boolean

Показывает, подключался ли пользователь к системе

is_active
required
boolean

Флаг, указывающий, помечен ли пользователь как активный

is_technical_account
required
boolean

Показывает, является ли пользователь технической (системной) учётной записью

avatar_url
string <uri>

URL аватара пользователя

external_id
string

Внешний идентификатор пользователя (например, из внешней системы)

first_name
string

Имя пользователя

last_name
string

Фамилия пользователя

revoked_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

updated_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

username
string

Имя пользователя или логин

Response samples

Content type
application/json
[
  • {
    • "avatar_url": "https://avatar.demo/demo-avatar",
    • "available": true,
    • "connected": true,
    • "created_at": "2006-01-02T15:04:05.999999Z07:00",
    • "external_id": "user_324",
    • "first_name": "John",
    • "id": 1,
    • "is_active": true,
    • "is_online": true,
    • "is_technical_account": false,
    • "last_name": "Doe",
    • "revoked_at": "2006-01-02T15:04:05.999999Z07:00",
    • "updated_at": "2006-01-02T15:04:05.999999Z07:00",
    • "username": "demo-username"
    }
]

Message

Получить список сообщений

Возвращает список сообщений, отфильтрованных по разным критериям

Authorizations:
bot_token
query Parameters
since
string <date-time>

Нижняя граница даты последнего обновления объекта

until
string <date-time>

Верхняя граница даты последнего обновления объекта

since_id
integer <int64> >= 1

Нижняя граница идентификаторов объектов

until_id
integer <int64> >= 1

Верхняя граница идентификаторов объектов

limit
integer <int> [ 1 .. 1000 ]

Количество элементов в ответе (по умолчанию 100)

id
Array of integers <int64> [ items <int64 > ]

Фильтр по списку ID сообщений

chat_id
integer >= 1

Фильтр по идентификатору чата

user_id
integer >= 1

Фильтр по ID пользователя

customer_id
integer >= 1

Фильтр по ID клиента

bot_id
integer >= 1

Фильтр по ID бота

dialog_id
integer <int64> >= 1

Фильтр по ID диалога

channel_id
integer >= 1

Фильтр по ID канала

channel_type
string (ChannelType)
Enum: "telegram" "tiktok" "fbmessenger" "viber" "whatsapp" "skype" "vk" "instagram" "consultant" "yandex_chat" "odnoklassniki" "max" "ozon" "wildberries" "yandex_market" "mega_market" "avito" "drom" "youla" "custom"
Example: channel_type=telegram

Фильтр по типу канала

type
string (MessageType)
Enum: "text" "system" "command" "order" "product" "file" "image" "audio"
Example: type=text

Фильтр по типу сообщения

include_mass_communication
string (Boolean)
Enum: "1" "0" "true" "false"

Включать ли чаты/сообщения массовых коммуникаций

scope
string
Enum: "public" "private"

Фильтр по области сообщения (публичное или приватное)

Responses

Response Schema: application/json
Array
actions
required
Array of strings (MessageAction)
Items Enum: "edit" "delete" "quote"

Список интерактивных действий, связанных с сообщением

chat_id
required
integer <int64>

ID чата, к которому относится это сообщение

id
required
integer <int64>

Уникальный идентификатор сообщения

is_edit
required
boolean

Показывает, редактировалось ли сообщение

is_read
required
boolean

Показывает, было ли сообщение прочитано

scope
required
string
Enum: "undefined" "public" "private"

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

status
required
string
Enum: "undefined" "received" "sending" "sent" "failed" "seen"

Текущий статус сообщения

time
required
string <date-time>

Метка времени создания сообщения

type
required
string
Enum: "text" "system" "command" "order" "product" "file" "image" "audio"

Тип сообщения

created_at
required
string <date-time>

Дата и время в формате RFC 3339 с микросекундами

action
string or null
Enum: "dialog_opened" "dialog_closed" "user_joined" "user_left" "dialog_assign" "customer_blocked" "customer_unblocked" "dialog_unassign" "dialog_tag_added" "dialog_tag_removed"

Системное действие, отображаемое сообщением

content
string or null

Текстовое содержимое сообщения

object or null

Необязательный диалог, связанный с сообщением

object or null

Информация об ошибке, связанной с отправкой или обработкой сообщения

object

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

Array of objects (MessageFile)

Список прикреплённых файлов

note
string or null

Необязательное внутреннее примечание или комментарий к сообщению

object or null

Необязательные данные заказа, связанные с сообщением

object or null

Необязательные данные о продукте, упомянутые в сообщении

object or null

Цитируемое сообщение (если это ответ)

object or null

Пользователь, ответственный за это сообщение или задачу

template_code
string

Код шаблона для шаблонного сообщения

object or null

Вложения, специфичные для транспортного уровня

object or null

Пользователь, связанный с сообщением

channel_id
integer <int64>

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

channel_sent_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

updated_at
string or null <date-time>

Дата и время в формате RFC 3339 с микросекундами

Response samples

Content type
application/json
[
  • {
    • "action": "user_joined",
    • "actions": [
      ],
    • "chat_id": 1,
    • "content": "Hi there!",
    • "dialog": {
      },
    • "error": {
      },
    • "from": {
      },
    • "id": 1,
    • "is_edit": true,
    • "is_read": true,
    • "items": [
      ],
    • "note": "Nice cats",
    • "order": {
      },
    • "product": {},
    • "quote": {
      },
    • "responsible": {
      },
    • "scope": "public",
    • "status": "seen",
    • "template_code": "string",
    • "time": "2006-01-02T15:04:05Z07:00",
    • "transport_attachments": {},
    • "type": "text",
    • "user": {
      },
    • "channel_id": 1,
    • "channel_sent_at": "2006-01-02T15:04:05.999999Z07:00",
    • "created_at": "2006-01-02T15:04:05.999999Z07:00",
    • "updated_at": "2006-01-02T15:04:05.999999Z07:00"
    }
]

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

Отправка нового сообщения в заданный транспортный канал

Authorizations:
bot_token
Request Body schema: application/json

Тело запроса для отправки нового сообщения

chat_id
required
integer <int64>

ID чата‑получателя сообщения

scope
required
string
Enum: "undefined" "public" "private"

Область видимости сообщения (например: user, system)

content
string

Текстовое содержимое сообщения (обязательно только для текстовых сообщений)

Array of objects

Файловые вложения (обязательно для сообщений типа file, audio и image)

note
string

Примечание или описание файла (требуется для сообщений с файлами, аудио и изображениями)

object

Данные заказа (обязательно для сообщений типа order)

object

Данные продукта (обязательно для сообщений типа product)

quote_message_id
integer <int64>

ID цитируемого сообщения (только для текстовых сообщений)

type
string
Enum: "text" "system" "command" "order" "product" "file" "image" "audio"

Тип сообщения (например: text, file, order, product)

object or null

Транспортные вложения

mass_communication
boolean

Помечает сообщение как часть массовой рассылки. Сообщение, отправленное с этим флагом, не открывает диалог и не обновляет last_activity чата. Чаты, инициированные такими сообщениями, а также связанные с ними события WebSocket, возвращаются только при явном включении include_mass_communication (используйте одноимённый параметр запроса в REST-списках и опцию include_mass_communication при подключении по WebSocket)

Responses

Response Schema: application/json
message_id
required
integer <int64>

Уникальный идентификатор сообщения

time
required
string <date-time>

Request samples

Content type
application/json
{
  • "chat_id": 123,
  • "content": "Hello!",
  • "items": [
    • {
      }
    ],
  • "note": "demo note",
  • "order": {
    • "external_id": 56,
    • "cost": {
      },
    • "date": "2021-12-29T14:18:37.051393Z",
    • "delivery": {
      },
    • "discount": {
      },
    • "items": [],
    • "number": "23546",
    • "payments": [
      ],
    • "status": {
      },
    • "url": "https://url.demo/demo-url"
    },
  • "product": {},
  • "quote_message_id": 42,
  • "scope": "user",
  • "type": "text",
  • "transport_attachments": {},
  • "mass_communication": true
}

Response samples

Content type
application/json
{
  • "message_id": 1,
  • "time": "2006-01-02T15:04:05.999999Z07:00"
}

Редактировать сообщение по ID

Обновляет содержимое или метаданные существующего сообщения

Authorizations:
bot_token
path Parameters
message_id
required
integer <int64> >= 1
Example: 100

Уникальный идентификатор сообщения

Request Body schema: application/json

Тело запроса для редактирования существующего сообщения

content
string <= 2000 characters

Текстовое содержимое сообщения (обязательно только для текстовых сообщений)

Array of objects

Файловые вложения (обязательно для сообщений типа file, audio и image)

note
string

Примечание или описание файла (требуется для сообщений с файлами, аудио и изображениями)

object

Данные заказа (обязательно для сообщений типа order)

object

Данные продукта (обязательно для сообщений типа product)

object or null

Вложения, специфичные для транспортного уровня

quote_message_id
integer <int64>

ID цитируемого сообщения (только для текстовых сообщений)

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "content": "Hello!",
  • "items": [
    • {
      }
    ],
  • "note": "demo note",
  • "order": {
    • "external_id": 56,
    • "cost": {
      },
    • "date": "2021-12-29T14:18:37.051393Z",
    • "delivery": {
      },
    • "discount": {
      },
    • "items": [],
    • "number": "23546",
    • "payments": [
      ],
    • "status": {
      },
    • "url": "https://url.demo/demo-url"
    },
  • "product": {},
  • "transport_attachments": {},
  • "quote_message_id": 42
}

Response samples

Content type
application/json
{ }

Удалить сообщение по ID

Удаляет сообщение с указанным ID (операция необратима)

Authorizations:
bot_token
path Parameters
message_id
required
integer <int64> >= 1
Example: 100

Уникальный идентификатор сообщения

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

WS

Соединение WebSocket для обновлений в реальном времени

Этот URL используется для установления соединения через WebSocket. С помощью этого соединения бот может получать данные по каждому типу событий, на которые он подписан. Список событий передается в виде строки, со значениями, разделенными запятыми.

Authorizations:
bot_token
query Parameters
events
string non-empty
Example: events=message_new,message_updated,message_restored,message_deleted,dialog_opened,dialog_closed,dialog_assign,chat_created,chat_updated,chats_deleted,user_joined_chat,user_left_chat,user_updated,user_online_updated,channel_updated,customer_updated,bot_updated

Список событий через запятую для подписки по WebSocket

options
string
Example: options=include_mass_communication

Дополнительные параметры подключения WebSocket (include_mass_communication — позволяют получать события о сообщениях, отправленных с помощью массовых рассылок)

Responses

Response samples

Content type
application/json
{ }