1. Обзор

RetailCRM Message Gateway Bot API

1.2. Схема URI

Узел : api.example.com
Основной путь : /api/bot/v1
Схемы : HTTPS

1.3. Принимает

  • application/json

1.4. Возвращает

  • application/json

2. Пути

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

GET /bots

2.1.1. Описание

Возвращает список ботов в соответствии с переданными параметрами, количество записей - 1000, если переданы оба параметра since и until или только until, то список будет отсортирован в обратном порядке

2.1.2. Параметры

Тип Имя Описание Схема

Query

active
optional

Флаг активности (0|1)

integer

Query

id
optional

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

integer (uint64)

Query

limit
optional

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

integer (uint64)

Query

since
optional

Изменен начиная с даты/время (с микросекундами)

string (date-time)

Query

until
optional

Изменен вплоть до даты/время (с микросекундами)

string (date-time)

2.1.3. Ответы

HTTP код Описание Схема

200

Список получен

< Bot > array

400

Ошибка запроса

Error

500

Ошибка сервера

Error

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

GET /channels

2.2.1. Описание

Возвращает список каналов в соответствии с переданными параметрами, количество записей - 1000, если переданы оба параметра since и until или только until, то список будет отсортирован в обратном порядке

2.2.2. Параметры

Тип Имя Описание Схема

Query

active
optional

Флаг активности (0|1)

integer

Query

id
optional

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

integer (uint64)

Query

limit
optional

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

integer (uint64)

Query

since
optional

Изменен начиная с даты/время (с микросекундами)

string (date-time)

Query

types
optional

Доступные события

< string > array

Query

until
optional

Изменен вплоть до даты/время (с микросекундами)

string (date-time)

2.2.3. Ответы

HTTP код Описание Схема

200

Список получен

< Channel > array

400

Ошибка запроса

Error

500

Ошибка сервера

Error

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

GET /chats

2.3.1. Описание

Возвращает список чатов в соответствии с переданными параметрами, количество записей - 1000, если переданы оба параметра since и until или только until, то список будет отсортирован в обратном порядке

2.3.2. Параметры

Тип Имя Описание Схема

Query

channel_id
optional

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

integer (uint64)

Query

channel_type
optional

Тип канала

string

Query

id
optional

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

integer (uint64)

Query

limit
optional

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

integer (uint64)

Query

since
optional

Изменен начиная с даты/время (с микросекундами)

string (date-time)

Query

until
optional

Изменен вплоть до даты/время (с микросекундами)

string (date-time)

2.3.3. Ответы

HTTP код Описание Схема

200

Список получен

< Chat > array

400

Ошибка запроса

Error

500

Ошибка сервера

Error

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

GET /customers

2.4.1. Описание

Возвращает список клиентов в соответствии с переданными параметрами, количество записей - 1000, если переданы оба параметра since и until или только until, то список будет отсортирован в обратном порядке

2.4.2. Параметры

Тип Имя Описание Схема

Query

external_id (id в мессенджере)
optional

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

string

Query

id
optional

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

integer (uint64)

Query

limit
optional

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

integer (uint64)

Query

since
optional

Изменен начиная с даты/время (с микросекундами)

string (date-time)

Query

until
optional

Изменен вплоть до даты/время (с микросекундами)

string (date-time)

2.4.3. Ответы

HTTP код Описание Схема

200

Список получен

< Customer > array

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.5. Получение списка диалогов

GET /dialogs

2.5.1. Описание

Возвращает список диалогов в соответствии с переданными параметрами, количество записей - 1000, если переданы оба параметра since и until или только until, то список будет отсортирован в обратном порядке

2.5.2. Параметры

Тип Имя Описание Схема

Query

active
optional

Флаг активности (0|1)

integer

Query

assign
optional

Флаг назначенности на менеджера (0|1)

integer

Query

bot_id
optional

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

integer (uint64)

Query

chat_id
optional

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

integer (uint64)

Query

id
optional

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

integer (uint64)

Query

limit
optional

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

integer (uint64)

Query

since
optional

Изменен начиная с даты/время (с микросекундами)

string (date-time)

Query

until
optional

Изменен вплоть до даты/время (с микросекундами)

string (date-time)

Query

user_id
optional

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

integer (uint64)

2.5.3. Ответы

HTTP код Описание Схема

200

Список получен

< Dialog > array

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.6. Назначение диалога на менеджера или на бота

PATCH /dialogs/{dialog_id}/assign

2.6.1. Описание

В теле запроса необходимо указать либо данные менеджера, на которого необходимо перевести диалог, либо данные бота

2.6.2. Параметры

Тип Имя Схема

Path

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

integer (uint64)

Body

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

AssignRequest

2.6.3. Ответы

HTTP код Описание Схема

200

Диалог назначен

AssignResponse

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.7. Закрытие диалога

DELETE /dialogs/{dialog_id}/close

2.7.1. Параметры

Тип Имя Схема

Path

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

integer (uint64)

2.7.2. Ответы

HTTP код Описание Схема

200

Диалог закрыт

Без содержимого

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.8. Снятие диалога с менеджера или бота

PATCH /dialogs/{dialog_id}/unassign

2.8.1. Параметры

Тип Имя Схема

Path

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

integer (uint64)

2.8.2. Ответы

HTTP код Описание Схема

200

Диалог снять

UnassignResponse

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.9. Загрузка файла

POST /files/upload

2.9.1. Параметры

Тип Имя Схема

FormData

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

file

2.9.2. Ответы

HTTP код Описание Схема

200

Файл загружен

UploadFileResponse

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.10. Загрузка файла по URL

POST /files/upload_by_url

2.10.1. Параметры

Тип Имя Схема

Body

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

UploadFileByUrlRequest

2.10.2. Ответы

HTTP код Описание Схема

200

Файл загружен

UploadFileResponse

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.11. Получение файла

GET /files/{file_id}

2.11.1. Параметры

Тип Имя Схема

Path

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

string

2.11.2. Ответы

HTTP код Описание Схема

200

Файл

FullFileResponse

400

Ошибка запроса

Error

500

Ошибка сервера

Error

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

GET /members

2.12.1. Описание

Возвращает список участников чата в соответствии с переданными параметрами, количество записей - 1000, если переданы оба параметра since и until или только until, то список будет отсортирован в обратном порядке

2.12.2. Параметры

Тип Имя Описание Схема

Query

chat_id
optional

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

integer (uint64)

Query

limit
optional

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

integer (uint64)

Query

manager_id
optional

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

integer (uint64)

Query

since
optional

Изменен начиная с даты/время (с микросекундами)

string (date-time)

Query

state
optional

Статус участника (active|kicked|leaved)

integer

Query

until
optional

Изменен вплоть до даты/время (с микросекундами)

string (date-time)

2.12.3. Ответы

HTTP код Описание Схема

200

Список получен

< Member > array

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.13. Отправка сообщения

POST /messages

2.13.1. Параметры

Тип Имя Схема

Body

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

MessageSendRequest

2.13.2. Ответы

HTTP код Описание Схема

200

Сообщение отправлено

MessageSendResponse

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.14. Получение списка сообщений

GET /messages

2.14.1. Описание

Возвращает список сообщений в соответствии с переданными параметрами, количество записей - 1000, если переданы оба параметра since и until или только until, то список будет отсортирован в обратном порядке

2.14.2. Параметры

Тип Имя Описание Схема

Query

bot_id
optional

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

integer (uint64)

Query

channel_id
optional

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

integer (uint64)

Query

chat_id
optional

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

integer (uint64)

Query

customer_id
optional

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

integer (uint64)

Query

dialog_id
optional

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

integer (uint64)

Query

id
optional

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

< integer > array

Query

manager_id
optional

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

integer (uint64)

Query

scope
optional

Область видимости (public|private)

string

Query

since
optional

Изменен начиная с даты/время (с микросекундами)

string (date-time)

Query

type
optional

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

string

Query

until
optional

Изменен вплоть до даты/время (с микросекундами)

string (date-time)

2.14.3. Ответы

HTTP код Описание Схема

200

Список получен

< Message > array

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.15. Удаление сообщения

DELETE /messages/{message_id}

2.15.1. Параметры

Тип Имя Схема

Path

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

integer (uint64)

2.15.2. Ответы

HTTP код Описание Схема

200

Сообщение удалено

Без содержимого

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.16. Редактирование сообщения

PATCH /messages/{message_id}

2.16.1. Параметры

Тип Имя Схема

Path

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

integer (uint64)

Body

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

MessageEditRequest

2.16.2. Ответы

HTTP код Описание Схема

200

Сообщение отредактировано

Без содержимого

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.17. Получение списка команд бота

GET /my/commands

2.17.1. Описание

Возвращает список команд бота в соответствии с переданными параметрами, количество записей - 1000, если переданы оба параметра since и until или только until, то список будет отсортирован в обратном порядке

2.17.2. Параметры

Тип Имя Описание Схема

Query

id
optional

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

integer (uint64)

Query

name
optional

Имя команды

string

Query

since
optional

Изменен начиная с даты/время (с микросекундами)

string (date-time)

Query

until
optional

Изменен вплоть до даты/время (с микросекундами)

string (date-time)

2.17.3. Ответы

HTTP код Описание Схема

200

Список получен

< Command > array

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.18. Создание/редактирование команды

PUT /my/commands/{name}

2.18.1. Параметры

Тип Имя Схема

Path

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

string

Body

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

CommandEditRequest

2.18.2. Ответы

HTTP код Описание Схема

200

Команда отредактирована

Без содержимого

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.19. Удаление команды

DELETE /my/commands/{name}

2.19.1. Параметры

Тип Имя Схема

Path

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

string

2.19.2. Ответы

HTTP код Описание Схема

200

Команда удалена

Без содержимого

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.20. Обновление информации о боте

PATCH /my/info

2.20.1. Параметры

Тип Имя Схема

Body

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

InfoRequest

2.20.2. Ответы

HTTP код Описание Схема

200

Данные бота обновлены

Без содержимого

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.21. Получение списка менеджеров

GET /users

2.21.1. Описание

Возвращает список менеджеров в соответствии с переданными параметрами, количество записей - 1000, если переданы оба параметра since и until или только until, то список будет отсортирован в обратном порядке

2.21.2. Параметры

Тип Имя Описание Схема

Query

active
optional

Флаг активности (0|1)

integer

Query

external_id (id в мессенджере)
optional

Внешний идентификатор менеджера

string

Query

id
optional

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

integer (uint64)

Query

limit
optional

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

integer (uint64)

Query

online
optional

Флаг нахождения в сети (0|1)

integer

Query

since
optional

Изменен начиная с даты/время (с микросекундами)

string (date-time)

Query

until
optional

Изменен вплоть до даты/время (с микросекундами)

string (date-time)

2.21.3. Ответы

HTTP код Описание Схема

200

Список получен

< User > array

400

Ошибка запроса

Error

500

Ошибка сервера

Error

2.22. Открытие веб-сокета

GET /ws

2.22.1. Описание

Данный url используется для открытия соединения с использованием веб-сокета, используя данное соединение бот сможет получать данные по каждому типу событий, на которые он подписан, перечень событий передается в виде строки, значения разделенны запятой (ws://api.example.com/api/bot/v1/ws?events=message_new,message_updated)

2.22.2. Параметры

Тип Имя Описание Схема

Query

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

Типы событий, на которые можно подписать бота

enum (message_new, message_updated, message_deleted, dialog_opened, dialog_closed, dialog_assign, chat_created, chat_updated, user_joined_chat, user_left_chat, user_updated)

2.22.3. Ответы

HTTP код Описание Схема

200

Соединение открыто

Event

3. Определения

3.1. AssignRequest

Указывается один из двух параметров

Имя Описание Схема

bot_id
optional

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

integer (uint64)

dialog_id
optional

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

integer (uint64)

user_id
optional

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

integer (uint64)

3.2. AssignResponse

Имя Описание Схема

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

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

boolean

left_manager_id
optional

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

integer (uint64)

previous_responsible
optional

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

Responsible

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

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

Responsible

3.3. Bot

Имя Описание Схема

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)

3.4. Channel

Имя Описание Схема

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

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

string (date-time)

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

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

string (date-time)

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

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

string (date-time)

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

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

integer (uint64)

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

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

string

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

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

Settings

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

Тип канала

string

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

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

string (date-time)

3.5. Chat

Имя Описание Схема

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)

LastMessage

Имя Описание Схема

id
optional

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

integer (uint64)

time
optional

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

string (date-time)

type
optional

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

string

3.6. Command

Имя Описание Схема

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

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

string (date-time)

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

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

string

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

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

integer (uint64)

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

Имя команды

string

updated_at
optional

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

string (date-time)

3.7. CommandEditRequest

Имя Описание Схема

description
optional

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

string

name
optional

Имя команды

string

3.8. Customer

Имя Описание Схема

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

3.9. Dialog

Имя Описание Схема

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)

3.10. Error

Имя Описание Схема

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

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

< string > array

3.11. Event

Объект возвращаемый по событию

Имя Описание Схема

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

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

integer (uint)

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

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

data

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

Метаданные

meta

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

Тип события

string

data

Имя Описание Схема

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

meta

Имя Описание Схема

timestamp
optional

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

integer (int64)

3.12. EventTypeDialogAssign

Имя Описание Схема

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

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

Chat

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

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

Dialog

3.13. EventTypeMessage

Имя Описание Схема

message
optional

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

Message

3.14. EventTypeUserJoinChat

Имя Описание Схема

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

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

Chat

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

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

User

3.15. EventTypeUserLeftChat

Имя Описание Схема

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

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

Chat

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

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

string

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

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

User

3.16. FileMeta

Имя Схема

height
optional

integer (uint64)

width
optional

integer (uint64)

3.17. FullFileResponse

Имя Описание Схема

id
optional

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

string

size
optional

Размер файла

integer (uint64)

type
optional

Тип файла

string

url
optional

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

string

3.18. InfoRequest

Имя Описание Схема

avatar_url
optional

URL аватара

string

name
optional

Имя бота

string

roles
optional

< object > array

3.19. Item

Имя Схема

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

string

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

string

3.20. Member

Имя Описание Схема

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)

3.21. Message

Имя Описание Схема

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

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)

3.22. MessageCost

Имя Описание Схема

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

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

string

value
optional

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

number (float32)

3.23. MessageDelivery

Имя Описание Схема

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

Адрес

string

comment
optional

Комментарий

string

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

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

string

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

Стоимость

MessageCost

3.24. MessageEditRequest

Имя Описание Схема

content
optional

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

string

id
optional

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

integer (uint64)

3.25. MessageOrder

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

Имя Описание Схема

cost
optional

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

MessageCost

date
optional

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

string

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

Доставки

MessageDelivery

items
optional

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

< MessageOrderItem > array

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

Номер заказа

string

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

Платежи

< MessagePayment > array

status
optional

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

MessageStatus

3.26. MessageOrderItem

Имя Описание Схема

img
optional

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

string

name
optional

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

string

price
optional

Стоимость

MessageCost

quantity
optional

Количество

MessageQuantity

url
optional

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

string

3.27. MessageOrderPaymentStatus

Имя Описание Схема

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

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

string

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

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

boolean

3.28. MessagePayment

Имя Описание Схема

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

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

MessageCost

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

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

string

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

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

MessageOrderPaymentStatus

3.29. MessageProduct

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

Имя Описание Схема

article
optional

Артикул

string

cost
optional

Цена

MessageCost

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

ID оффера

integer (uint64)

img
optional

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

string

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

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

string

quantity
optional

Количество

MessageQuantity

url
optional

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

string

3.30. MessageQuantity

Имя Описание Схема

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

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

string

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

Количество

number (float32)

3.31. MessageSendRequest

Имя Описание Схема

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

3.32. MessageSendResponse

Имя Описание Схема

message_id
optional

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

integer (uint64)

time
optional

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

string

3.33. MessageStatus

Имя Описание Схема

code
optional

Код статуса

string

name
optional

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

string

3.34. Responsible

Имя Описание Схема

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

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

string (date-time)

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

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

integer (uint64)

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

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

string

3.35. Settings

Имя Описание Схема

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

Разрешение на рассылку (0|1)

integer (uint8)

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

Статус

Status

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

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

TextSettings

3.36. Status

Имя Описание Схема

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

Доставлено

string

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

Прочитано

string

3.37. Suggestion

Имя Описание Схема

title
optional

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

string

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

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

string

3.38. TextSettings

Имя Описание Схема

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

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

string

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

Возможность удалять сообщения

string

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

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

string

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

Возможность цитировать сообщения

string

3.39. TransportAttachments

Имя Описание Схема

suggestions
optional

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

< Suggestion > array

3.40. UnassignResponse

Имя Описание Схема

previous_responsible
optional

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

Responsible

3.41. UploadFileByUrlRequest

Имя Схема

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

string

3.42. UploadFileResponse

Имя Описание Схема

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

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

string (date-time)

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

Хэш файла

string

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

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

string

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

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

FileMeta

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

MIME тип

string

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

Размер файла

integer (uint64)

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

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

string

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

Тип файла

string

3.43. User

Имя Описание Схема

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

4. Безопасность

4.1. key

Тип : apiKey
Имя : x-bot-token
Содержится в : HEADER