MG Bot API

bot_id
optional

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

integer (uint64)

dialog_id
optional

Идентификатор диалога

integer (uint64)

user_id
optional

Идентификатор менеджера

integer (uint64)

is_reassign
обязательно

Флаг успешного переназначения

boolean

left_manager_id
optional

Идентификатор предыдущего менеджера

integer (uint64)

previous_responsible
optional

Предыдущий ответственный

Responsible

responsible
обязательно

Новый ответственный

Responsible

caption
optional

Отображаемое название

string

height
optional

Высота, отсутствует, если файл не является изображением

integer (uint64)

id
optional

ID файла

integer (uint64)

preview_url
optional

URL превью, отсутствует, если файл не является изображением

string

size
optional

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

integer (uint64)

type
optional

MIME тип

string

width
optional

Ширина, отсутствует, если файл не является изображением

integer (uint64)

avatar_url
optional

URL аватара

string

client_id
optional

Идентификатор подключения

string

created_at
optional

Дата/время создания

string (date-time)

deactivated_at
optional

Дата/время деактивации

string (date-time)

id
обязательно

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

integer (uint64)

is_active
обязательно

Флаг активности

string

is_self
обязательно

Описание поля

string

name
обязательно

Имя бота

string

roles
optional

Роли

< object > array

updated_at
optional

Дата/время последнего изменения

string (date-time)

activated_at
обязательно

Дата/время последнего включения канала

string (date-time)

created_at
обязательно

Дата/время создания канала

string (date-time)

deactivated_at
optional

Дата/время последнего отключения канала

string (date-time)

id
обязательно

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

integer (int64)

is_active
обязательно

Признак активности канала

boolean

name
optional

Название канала

string

settings
optional

Настройки канала

ChannelSettings

type
обязательно

Тип канала

enum (telegram, fbmessenger, viber, whatsapp, skype, vk, instagram, consultant, yandex_chat, custom)

updated_at
optional

Дата/время последнего изменения данных канала

string (date-time)

audio
optional

Настройки аудио сообщений

audio

customer_external_id
optional

Параметр по которому производится внешняя идентификация клиента
По умолчанию : "any"

enum (any, phone)

file
optional

Настройки сообщений с файлами

file

image
optional

Настройки сообщений с изображениями

image

order
optional

Настройки сообщений с заказом

order

product
optional

Настройки сообщений с карточкой товара

product

sending_policy
optional

Политика отправки сообщений

sending_policy

status
optional

Настройки обновления статусов сообщений

status

suggestions
optional

Настройки сообщений c кнопками

suggestions

text
optional

Настройки текстовых сообщений

text

creating
optional

Возможность отправлять сообщения
По умолчанию : "none"

enum (none, receive, send, both)

deleting
optional

Возможность удалять сообщения
По умолчанию : "none"

enum (none, receive, send, both)

max_items_count
optional

Максимальное количество аудио записей в одном сообщении

integer

quoting
optional

Возможность цитировать сообщения
По умолчанию : "none"

enum (none, receive, send, both)

creating
optional

Возможность отправлять сообщения
По умолчанию : "none"

enum (none, receive, send, both)

deleting
optional

Возможность удалять сообщения
По умолчанию : "none"

enum (none, receive, send, both)

editing
optional

Возможность редактировать сообщения
По умолчанию : "none"

enum (none, receive, send, both)

max_items_count
optional

Максимальное количество файлов в одном сообщении

integer

note_max_chars_count
optional

Максимальная допустимая длина сообщения сопроводительного сообщения

integer

quoting
optional

Возможность цитировать сообщения
По умолчанию : "none"

enum (none, receive, send, both)

creating
optional

Возможность отправлять сообщения
По умолчанию : "none"

enum (none, receive, send, both)

deleting
optional

Возможность удалять сообщения
По умолчанию : "none"

enum (none, receive, send, both)

editing
optional

Возможность редактировать сообщения
По умолчанию : "none"

enum (none, receive, send, both)

max_items_count
optional

Максимальное количество изображений в одном сообщении

integer

note_max_chars_count
optional

Максимальная допустимая длина сообщения сопроводительного сообщения

integer

quoting
optional

Возможность цитировать сообщения
По умолчанию : "none"

enum (none, receive, send, both)

creating
optional

Возможность отправлять сообщения
По умолчанию : "none"

enum (none, receive, send, both)

deleting
optional

Возможность удалять сообщения
По умолчанию : "none"

enum (none, receive, send, both)

editing
optional

Возможность редактировать сообщения
По умолчанию : "none"

enum (none, receive, send, both)

creating
optional

Возможность отправлять сообщения
По умолчанию : "none"

enum (none, receive, send, both)

deleting
optional

Возможность удалять сообщения
По умолчанию : "none"

enum (none, receive, send, both)

editing
optional

Возможность редактировать сообщения
По умолчанию : "none"

enum (none, receive, send, both)

after_reply_timeout
optional

После истечения допустимого времени на ответ клиенту
По умолчанию : "no"

enum (no, template)

new_customer
optional

Для клиентов с которыми не было переписки ранее
По умолчанию : "no"

enum (no, template)

delivered
optional

Возможность отправки статуса доставки
По умолчанию : "none"

enum (none, receive, send, both)

read
optional

Возможность отправки статуса прочтения
По умолчанию : "none"

enum (none, receive, send, both)

Email
optional

Возможность запрашивать email клиента
По умолчанию : "none"

enum (none, receive, send, both)

Phone
optional

Возможность запрашивать телефон клиента
По умолчанию : "none"

enum (none, receive, send, both)

text
optional

Возможность работы с кнопками на которых произвольный текст
По умолчанию : "none"

enum (none, receive, send, both)

creating
optional

Возможность отправлять сообщения
По умолчанию : "none"

enum (none, receive, send, both)

deleting
optional

Возможность удалять сообщения
По умолчанию : "none"

enum (none, receive, send, both)

editing
optional

Возможность редактировать сообщения
По умолчанию : "none"

enum (none, receive, send, both)

max_chars_count
optional

Максимальная допустимая длина сообщения (по умолчанию 2000 символов)

integer (uint16)

quoting
optional

Возможность цитировать сообщения
По умолчанию : "none"

enum (none, receive, send, both)

author_id
обязательно

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

integer (uint64)

avatar
обязательно

URL аватара

string

channel
optional

Данные канала

Channel

created_at
обязательно

Дата/время создания

string (date-time)

customer
обязательно

Пользователь

Customer

id
обязательно

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

integer (uint64)

last_activity
обязательно

Последняя активность

string (date-time)

last_message
обязательно

Последнее сообщение

LastMessage

name
обязательно

Имя

string

updated_at
обязательно

Дата/время последнего изменения

string (date-time)

id
optional

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

integer (uint64)

time
optional

Время создания

string (date-time)

type
optional

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

string

created_at
обязательно

Дата/время создания

string (date-time)

description
обязательно

Описание команды

string

id
обязательно

Идентификатор команды

integer (uint64)

name
обязательно

Имя команды

string

updated_at
optional

Дата/время последнего изменения

string (date-time)

description
optional

Описание команды

string

name
optional

Имя команды

string

avatar
optional

URL аватара

string

channel_id
optional

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

string

country
optional

Страна

string

created_at
обязательно

Дата/время создания

string (date-time)

email
optional

Email

string

external_id
optional

Внешний идентификатор клиента (id в мессенджере)

string

first_name
optional

Имя клиента

string

id
обязательно

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

integer (uint64)

language
optional

Выбранная локаль

string

last_name
optional

Фамилия клиента

string

phone
optional

Телефон

string

profile_url
optional

URL профиля

string

revoked_at
optional

Дата/время отзыва регистрации

string (date-time)

updated_at
optional

Дата/время последнего изменения

string (date-time)

username
optional

Никнейм

string

begin_message_id
optional

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

integer (uint64)

bot_id
optional

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

integer (uint64)

chat_id
обязательно

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

integer (uint64)

closed_at
optional

Дата/время закрытия

string (date-time)

created_at
обязательно

Дата/время создания

string (date-time)

ending_message_id
optional

Идентификатор последнего сообщения

integer (uint64)

id
обязательно

Идентификатор диалога

integer (uint64)

is_active
обязательно

Флаг активности

string

is_assigned
обязательно

Флаг назначенности

string

responsible
optional

Responsible

updated_at
optional

Дата/время последнего изменения

string (date-time)

messages
обязательно

Список сообщений об ошибке
Пример : [ "Something went wrong" ]

< string > array

app_id
обязательно

Идентификатор приложения

integer (uint)

data
обязательно

Тело объекта (зависит от типа события, будет получено одно из нижеописанных свойств)

data

meta
обязательно

Метаданные

meta

type
обязательно

Тип события

string

chat_event
optional

Событие - chat_created, chat_updated

Chat

dialog_assign
optional

Событие - dialog_assign

EventTypeDialogAssign

dialog_event
optional

Событие - dialog_opened, dialog_closed

Dialog

message_event
optional

Событие - message_new, message_updated, message_deleted

EventTypeMessage

user_join_chat_event
optional

Событие - user_join_chat

EventTypeUserJoinChat

user_left_chat_event
optional

Событие - user_left_chat

EventTypeUserLeftChat

user_update_event
optional

Событие - user_updated

User

timestamp
optional

Временная метка

integer (int64)

chat
обязательно

Информация о чате

Chat

dialog
обязательно

Информация о диалоге

Dialog

message
optional

Информация о сообщении

Message

chat
обязательно

Информация о чате

Chat

user
обязательно

Информация о пользователе

User

chat
обязательно

Информация о чате

Chat

reason
обязательно

Причина события (active, left, kicked)

string

user
обязательно

Информация о пользователе

User

height
optional

integer (uint64)

width
optional

integer (uint64)

id
optional

Идентификатор файла

string

size
optional

Размер файла

integer (uint64)

type
optional

Тип файла

string

url
optional

Ссылка на файл

string

avatar_url
optional

URL аватара

string

name
optional

Имя бота

string

roles
optional

< object > array

caption
обязательно

string

id
обязательно

string

chat_id
обязательно

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

integer (uint64)

created_at
обязательно

Дата/время создания

string (date-time)

id
обязательно

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

integer (uint64)

is_author
обязательно

Флаг автор

string

state
обязательно

Статус

string

updated_at
optional

Дата/время последнего изменения

string (date-time)

user_id
обязательно

Идентификатор пользователя

integer (uint64)

actions
обязательно

Доступные действия

< object > array

channel_id
обязательно

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

integer (uint64)

channel_sent_at
обязательно

Дата/время отправки

string (date-time)

chat
optional

Данные чата

Chat

chat_id
обязательно

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

integer (uint64)

content
обязательно

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

string

created_at
обязательно

Дата/время создания

string (date-time)

from
обязательно

От кого

User

id
обязательно

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

integer (uint64)

is_edit
обязательно

Отметка редактирования

boolean

is_read
обязательно

Флаг прочитанности

boolean

items
обязательно

Вложения

< Attachment > array

order
optional

Карточка заказа

MessageOrder

product
optional

Карточка товара

MessageProduct

scope
обязательно

Область видимости

string

status
обязательно

Статус

string

time
обязательно

Временная метка

string (date-time)

transport_attachments
optional

Вложения

TransportAttachments

type
обязательно

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

string

updated_at
обязательно

Дата/время последнего изменения

string (date-time)

currency
обязательно

Код валюты
Пример : "rub | usd | eur"

string

value
optional

Стоимость единицы

number (float32)

address
обязательно

Адрес

string

comment
optional

Комментарий

string

name
обязательно

Название способа доставки

string

price
обязательно

Стоимость

MessageCost

content
optional

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

string

id
optional

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

integer (uint64)

cost
optional

Сумма по заказу

MessageCost

date
optional

Дата оформления

string

delivery
обязательно

Доставки

MessageDelivery

items
optional

Статус заказа

< MessageOrderItem > array

number
обязательно

Номер заказа

string

payments
обязательно

Платежи

< MessagePayment > array

status
optional

Статус заказа

MessageStatus

img
optional

URL изображения

string

name
optional

Название товара

string

price
optional

Стоимость

MessageCost

quantity
optional

Количество

MessageQuantity

url
optional

URL карточки товара

string

name
обязательно

Название статуса

string

payed
обязательно

Флаг завершенности платежа

boolean

amount
обязательно

Размер платежа

MessageCost

name
обязательно

Название платежа

string

status
обязательно

Статус платежа

MessageOrderPaymentStatus

article
optional

Артикул

string

cost
optional

Цена

MessageCost

id
обязательно

ID оффера

integer (uint64)

img
optional

URL изображения

string

name
обязательно

Название товара

string

quantity
optional

Количество

MessageQuantity

url
optional

URL карточки товара

string

unit
обязательно

Единица измерения

string

value
обязательно

Количество

number (float32)

chat_id
обязательно

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

integer (uint64)

content
optional

Тело текстового сообщения, обязательно, в случае указания типа 'text'

string

items
optional

Массив файлов, обязательно, в случае указания типа 'file'

< Item > array

order
optional

Тело карточки заказа, обязательно, в случае указания типа 'text'

MessageOrder

product
optional

Тело карточки товара, обязательно, в случае указания типа 'product'

MessageProduct

quote_message_id
optional

Идентификатор цитирцемого сообщения

integer (uint64)

scope
обязательно

Область видимости
Пример : "public"

string

transport_attachments
optional

Вложения

TransportAttachments

type
обязательно

Тип сообщения
Пример : "text | order | product | file"

string

message_id
optional

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

integer (uint64)

time
optional

Временная метка

string

code
optional

Код статуса

string

name
optional

Название статуса

string

assigned_at
обязательно

Дата/время назначения

string (date-time)

id
обязательно

Идентификатор ответственного

integer (uint64)

type
обязательно

Тип ответственного

string

title
optional

Заголовок быстрого ответа (доступен только для типа text)

string

type
обязательно

Тип быстрого ответа
Пример : "text | email | phone"

string

suggestions
optional

Быстрые ответы

< Suggestion > array

previous_responsible
optional

Предыдущий ответственный

Responsible

url
обязательно

string

created_at
обязательно

Время создания файла

string (date-time)

hash
обязательно

Хэш файла

string

id
обязательно

Идентификатор файла

string

meta
обязательно

Информация о файле

FileMeta

mime_type
обязательно

MIME тип

string

size
обязательно

Размер файла

integer (uint64)

source_url
обязательно

Ссылка на файл

string

type
обязательно

Тип файла

string

avatar
optional

URL аватара

string

created_at
обязательно

Дата/время создания

string (date-time)

external_id
optional

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

string

first_name
optional

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

string

id
обязательно

Идентификатор пользователя

integer (uint64)

is_active
обязательно

Флаг активности

string

is_online
обязательно

Флаг нахождения в сети

string

last_name
optional

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

string

revoked_at
optional

Дата/время отзыва регистрации

string (date-time)

updated_at
optional

Дата/время последнего изменения

string (date-time)

username
optional

Никнейм

string