Перейти к основному содержимому
API docs by Redocly

Evolutrix CRM Rest API | Communication (1.0.0)

Download OpenAPI specification:Download

Описание Rest API — методов для взаимодействия с серверной стороной модуля Communication.

Коллекция Postman со всеми методами.

Каналы связи

Описание методов для взаимодействия с каналами связи.

index

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

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинации).

sort_by
string
Default: "id"
Enum: "id" "title" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых записей на странице.

service_providers
string
Value: "wazzup"

Сервисы, через которые работает канал связи.

transports
string
Value: "whatsapp"

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

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

generate iframe

Возвращает ссылку на iframe для создания нового или восстановления работы существующего канала связи.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные канала связи

transport
string
Enum: "whatsapp" "tgapi" "instAPI" "vk"

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

channel_id
string

Идентификатор канала связи, работу которого необходимо восстановить

Responses

Request samples

Content type
application/json
{
  • "transport": "whatsapp",
  • "channel_id": ""
}

Response samples

Content type
application/json
{}

show

Возвращает данные канала связи.

Требуются права доступа:*

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
communicationChannelId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет канал связи.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
communicationChannelId
required
integer

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

Request Body schema: application/json
required

Данные канала связи

title
required
string

Заголовок канала связи

description
string

Идентификатор канала связи, работу которого необходимо восстановить

Responses

Request samples

Content type
application/json
{
  • "title": "Тестовый канал",
  • "description": "Тестовое описание"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет канал связи.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
communicationChannelId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Подключение Telegram - бота

Описание методов для подключения клиентского Telegram - бота.

status

Возвращает статус подключения клиентского Telegram - бота.

Если бот не подключен, в bot_info возвращается null.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Подключает клиентский Telegram - бот.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные для подключения

access_token
required
string

Access токен Telegram - бота, полученный в BotFather

Responses

Request samples

Content type
application/json
{
  • "access_token": "5636961asdf12341fasdraL1235LE2M41WJn2owc"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

connect user

Связывает аккаунт сотрудника с клиентским Telegram - ботом.

Authorizations:
BearerToken
Request Body schema: application/json
required

Данные канала связи

chat_id
required
string

Идентификатор Telegram - чата сотрудника с ботом

Responses

Request samples

Content type
application/json
{
  • "chat_id": "1234567890"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

Системные сообщения Telegram - бота

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

index

Возвращает список конфигураций системных сообщений бота.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинации).

sort_by
string
Default: "id"
Enum: "id" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых записей на странице.

keys
Array of strings
Items Value: "bot-auto-reply-message"

Массив ключей конфигураций (для фильтрации).

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет системное сообщение бота.

В качестве параметра configId допускаются только идентификаторы конфигов, полученные в методе get.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
configId
required
integer

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

Request Body schema: application/json
required

Данные конфига

value
required
string

Содержимое системного сообщения

Responses

Request samples

Content type
application/json
{
  • "value": "Мы получили Ваше сообщение и спешим ответить на него. Пожалуйста, ожидайте ответа."
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Информационное меню Telegram - бота

Описание методов для взаимодействия с информационным меню клиентского Telegram - бота.

index

Возвращает список элементов информационного меню бота.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE

    https://docs.production.evolutrix.ru/api-communication/#tag/Informacionnoe-menyu-Telegram-bota/paths/~1api~1v1.0.0~1ant-communication~1bot-menu-items/get
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинации).

sort_by
string
Default: "position"
Enum: "id" "position" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых записей на странице.

parent_id
integer

Идентификатор родительского элемента.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новый элемент информационного меню бота.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные элемента информационного меню бота

title
required
string

Заголовок элемента информационного меню бота

message
required
string

Текстовое содержимое элемента информационного меню бота

Array of objects

Массив медиа-вложений элемента информационного меню бота (не более 10 медиа-вложений)

bot_menu_item_parent_id
integer

Идентификатор родительского элемента информационного меню бота

bot_menu_item_ref_id
integer

Идентификатор ссылки на элемент информационного меню бота

is_draft
required
boolean

Флаг черновика (true - черновик/false - активный элемент информационного меню бота)

Responses

Request samples

Content type
application/json
{
  • "title": "Информация об услуге",
  • "message": "Услуга оказывается в лучшем виде!",
  • "media": [],
  • "bot_menu_item_parent_id": 1,
  • "bot_menu_item_ref_id": 1,
  • "is_draft": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные элемента информационного меню бота.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botMenuItemId
required
integer

Идентификатор элемента информационного меню бота

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет данные элемента информационного меню бота.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botMenuItemId
required
integer

Идентификатор элемента информационного меню бота

Request Body schema: application/json
required

Данные элемента информационного меню бота

title
required
string

Заголовок элемента информационного меню бота

message
required
string

Текстовое содержимое элемента информационного меню бота

Array of objects

Массив медиа-вложений элемента информационного меню бота (не более 10 медиа-вложений)

bot_menu_item_ref_id
integer

Идентификатор ссылки на элемент информационного меню бота

is_draft
required
boolean

Флаг черновика (true - черновик/false - активный элемент информационного меню бота)

Responses

Request samples

Content type
application/json
{
  • "title": "Информация об услуге",
  • "message": "Услуга оказывается в лучшем виде!",
  • "media": [],
  • "bot_menu_item_ref_id": 1,
  • "is_draft": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

patch

Обновляет отдельные поля элемента информационного меню бота.

Принимает и обновляет одно или несколько полей элемента информационного меню, сохраняя прочие поля без изменений.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botMenuItemId
required
integer

Идентификатор элемента информационного меню бота

Request Body schema: application/json
required

Данные элемента информационного меню бота

title
string

Заголовок элемента информационного меню бота

message
string

Текстовое содержимое элемента информационного меню бота

bot_menu_item_ref_id
integer

Идентификатор ссылки на элемент информационного меню бота

is_draft
boolean

Флаг черновика (true - черновик/false - активный элемент информационного меню бота)

Responses

Request samples

Content type
application/json
{
  • "title": "Тестовый элемент",
  • "message": "Текст тестового элемента",
  • "bot_menu_item_ref_id": 1,
  • "is_draft": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет элемент информационного меню бота.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botMenuItemId
required
integer

Идентификатор элемента информационного меню бота

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

reorder

Обновляет позицию и родительский элемент пункта информационного меню бота.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botMenuItemId
required
integer

Идентификатор элемента информационного меню бота

Request Body schema: application/json
required

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

bot_menu_item_parent_id
integer

Идентификатор родительского элемента информационного меню бота

position
required
integer

Новая позиция типа

Responses

Request samples

Content type
application/json
{
  • "bot_menu_item_parent_id": 1,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Прогревающие сообщения Telegram - бота

Описание методов для взаимодействия с прогревающими сообщениями клиентского Telegram - бота.

index

Возвращает список прогревающих сообщений.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинации).

sort_by
string
Default: "id"
Enum: "id" "title" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых записей на странице.

provider
required
string
Value: "telegram"

Поставщик прогревающих сообщений.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новое прогревающее сообщение.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные прогревающего сообщения

title
required
string

Название прогревающего сообщения

is_active
required
boolean

Признак активности прогревающего сообщения

provider
required
string

Поставщик прогревающего сообщения

text
required
string

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

target
required
string

Указание целевых чатов прогревающего сообщения

schedule_type
required
string

Тип расписания прогревающего сообщения

delay
required
integer

Время прогревающего сообщения в минутах

Responses

Request samples

Content type
application/json
{
  • "title": "Автоматическое сообщение",
  • "is_active": true,
  • "provider": "telegram",
  • "text": "Тестовое сообщение спустя 10 минут с последнего сообщения",
  • "target": "TARGET_NO_CUSTOM_MESSAGES",
  • "schedule_type": "SCHEDULE_TYPE_LAST_MESSAGE_DELAY",
  • "delay": 10
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные прогревающего сообщения.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botNurturingMessageId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет прогревающее сообщение.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botNurturingMessageId
required
integer

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

Request Body schema: application/json
required

Данные прогревающего сообщения

title
required
string

Название прогревающего сообщения

is_active
required
boolean

Признак активности прогревающего сообщения

text
required
string

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

target
required
string

Указание целевых чатов прогревающего сообщения

schedule_type
required
string

Тип расписания прогревающего сообщения

delay
required
integer

Время прогревающего сообщения в минутах

Responses

Request samples

Content type
application/json
{
  • "title": "Автоматическое сообщение",
  • "is_active": true,
  • "text": "Тестовое сообщение спустя 10 минут с последнего сообщения",
  • "target": "TARGET_NO_CUSTOM_MESSAGES",
  • "schedule_type": "SCHEDULE_TYPE_LAST_MESSAGE_DELAY",
  • "delay": 10
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет прогревающее сообщение.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botNurturingMessageId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Команды Telegram - бота

Описание методов для взаимодействия с командами клиентского Telegram - бота.

index

Возвращает список команд бота.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинация).

sort_by
string
Default: "id"
Enum: "id" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых записей на странице.

provider
required
string
Value: "telegram"

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

bot
required
string
Value: "ClientBot"

Имя бота, выполняющего команду

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные команды бота.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botCommandId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет данные команды бота.

Параметр params имеет уникальные правила валидации для каждой отдельной команды бота. Содержимое параметра params должно соответствовать списку параметров, полученных в методе show.

Параметр is_active требуется, но игнорируется для команд Telegram - бота Начало работы с ботом (/start) и "Политика конфиденциальности" (/privacy).

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botCommandId
required
integer

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

Request Body schema: application/json
required

Данные команды бота

is_active
required
boolean

Признак активности команды бота

params
object

Параметры команды бота

Responses

Request samples

Content type
application/json
{
  • "is_active": true,
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Источники начала работы с Telegram - ботом

Описание методов для взаимодействия с источниками начала работы с клиентским Telegram - ботом.

index

Возвращает список источников начала работы с ботом.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинации).

sort_by
string
Default: "id"
Enum: "id" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых записей на странице.

search
string

Произвольный текстовый запрос для поиска записей.

provider
required
string
Value: "telegram"

Сервис бота.

bot
required
string
Value: "ClientBot"

Имя бота.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новый источник начала работы с ботом.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные источника начала работы с ботом

title
required
string

Название источника начала работы с ботом

provider
required
string
Value: "telegram"

Сервис бота

bot
required
string
Value: "ClientBot"

Имя бота

Responses

Request samples

Content type
application/json
{
  • "title": "Тестовый источник",
  • "provider": "telegram",
  • "bot": "ClientBot"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные источника начала работы с ботом.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botStartSourceId
required
integer

Идентификатор источника начала работы с ботом

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет источник начала работы с ботом.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botStartSourceId
required
integer

Идентификатор источника начала работы с ботом

Request Body schema: application/json
required

Данные источника начала работы с ботом

title
required
string

Название источника начала работы с ботом

Responses

Request samples

Content type
application/json
{
  • "title": "Тестовый источник"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет источник начала работы с ботом.

Требуются права доступа:

  • COMMUNICATION_CHANNEL_CONFIGURE
Authorizations:
BearerToken
path Parameters
botStartSourceId
required
integer

Идентификатор источника начала работы с ботом

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Чаты

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

index

Возвращает список чатов.

Возвращаются только чаты, в которых есть хотя бы одно сообщение.

В данном методе действует ограничение на максимальное количество возвращаемых связей клиентов, а именно:

  • Возвращается не более 5 меток чата,

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

sort_by
string
Default: "position"
Enum: "id" "latest_chat_message_created_at" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых записей на странице.

search
string

Произвольный текстовый запрос для поиска записей.

clients
Array of integers

Массив идентификаторов клиентов, которые должны быть связаны к чату.

has_tags
Array of integers

Массив идентификаторов меток, которые ДОЛЖНЫ быть у чата.

has_no_tags
Array of integers

Массив идентификаторов меток, которых НЕ ДОЛЖНО быть у чата.

folders
Array of integers

Массив идентификаторов папок, которые должны быть связаны с чатом.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новый чат.

Требуются права доступа:

  • CHAT_SHOW

  • При отсутствии права доступа CLIENT_SHOW параметр client_id будет игнорирован (что приведёт к ошибке 400).

Authorizations:
BearerToken
Request Body schema: application/json
required

Данные чата

client_id
string

Идентификатор клиента. Обязательно для создания чата с клиентом.

tags
Array of integers

Массив идентификаторов меток, которые должны быть связаны с чатом (не более 50 меток)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные чата.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
path Parameters
chatId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

unread count

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

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show by client

Возвращает данные чата с конкретным клиентом. Если с клиентом не существует чата — будет создан новый.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
path Parameters
clientId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

sync with client

Создаёт новый (или возвращает существующий) чат с привязанным клиентом. Все сообщения из старого чата переносятся в новый, старый чат удаляется. Контакты клиента, через которые были отправлены сообщения в старый чат, связываются с новым клиентом.

Требуются права доступа:

  • CLIENT_SHOW
  • CHAT_SHOW
  • CHAT_MESSAGE_STORE_CLIENT
Authorizations:
BearerToken
path Parameters
chatId
required
integer

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

Request Body schema: application/json
required

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

client_id
required
string

Идентификатор клиента. Обязательно для создания чата с клиентом.

Responses

Request samples

Content type
application/json
{
  • "client_id": 1
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Папки чатов

Описание методов для взаимодействия с папками с чатов.

index

Возвращает список папок чатов аутентифицированного сотрудника.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинация).

sort_by
string
Default: "id"
Enum: "id" "title" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых записей на странице.

search
string

Произвольный текстовый запрос для поиска записей.

ids
Array of integers

Массив идентификаторов папок. В случае передачи этого параметра игнорирует прочие параметры и возвращает папки с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новую папку чатов аутентифицированного сотрудника.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные папки чатов

title
required
string

Название папки чатов

chats
required
Array of integers

Массив идентификаторов чатов, которые должны быть связаны с папкой (не более 50 чатов)

Responses

Request samples

Content type
application/json
{
  • "title": "Тестовая папка",
  • "chats": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные папки чатов аутентифицированного сотрудника.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
path Parameters
chatFolderId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет папку чатов аутентифицированного сотрудника.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
path Parameters
chatFolderId
required
integer

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

Request Body schema: application/json
required

Данные папки чатов

title
required
string

Название папки чатов

chats
required
Array of integers

Массив идентификаторов чатов, которые должны быть связаны с папкой (не более 50 чатов)

Responses

Request samples

Content type
application/json
{
  • "title": "Тестовая папка",
  • "chats": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет папку чатов аутентифицированного сотрудника.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
path Parameters
chatFolderId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Сообщения в чатах

Описание методов для взаимодействия с сообщениями в чатах.

index

Возвращает список сообщений в чатах.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинации).

sort_by
string
Default: "id"
Enum: "id" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых записей на странице.

search
string

Произвольный текстовый запрос для поиска записей.

chats
Array of integers

Массив идентификаторов чатов, которые должны быть связаны с сообщениями (не более 50 чатов)

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новое сообщение в чате.

Требуются права доступа:

  • CHAT_SHOW

Для создания сообщения в чате с клиентом дополнительно требуются право доступа CHAT_MESSAGE_STORE_CLIENT.

При передаче параметра reply_to_chat_message_id параметры chat_id, contact_id, provider и communication_channel_id заменяются на соответствующие поля сообщения, на которое ссылается параметр reply_to_chat_message_id. Валидация указанных параметров происходит только после их замены.

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

Authorizations:
BearerToken
Request Body schema: multipart/form-data
required

Данные сообщения

chat_id
required
integer

Идентификатор чата, в котором должно быть создано сообщение

contact_id
integer

Идентификатор контакта, с помощью которого должно быть отправлено сообщение. Если не указано, то сообщение будет отправлено в чат без доставки до клиента. Список контактов, через которые доступна отправка сообщений в указанный чат, доступен в поле available_contacts, который возвращается в ответе метода chat show.

provider
string

Сервис, через который должно быть отправлено сообщение. Обязательно для заполнения, если указан параметр contact_id. Список доступных сервисов для отправки сообщений в указанный чат доступен в поле available_contacts.providers, который возвращается в ответе метода chat show.

communication_channel_id
integer

Идентификатор канала связи, через который должно быть отправлено сообщение. Идентификатор канала связи доступен в объектах контактов в поле available_contacts, который возвращается в ответе метода chat show.

text
required
string

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

attachments
Array of file <binary> [ items <binary > ]

Массив файлов, которые должны быть отправлены в чат (не более 10 файлов)

reply_to_chat_message_id
integer

Идентификатор сообщения, на которое нужно ответить

Responses

Request samples

Content type
multipart/form-data
{
  "chat_id": "",
  "contact_id": 1,
  "provider": "telegram",
  "communication_channel_id": 1,
  "text": "Привет, как дела?",
  "attachments": [
    "file.pdf"
  ],
  "reply_to_chat_message_id": 1
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные сообщения в чате.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
path Parameters
chatMessageId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Изменяет текст сообщения, отправленного аутентифицированным сотрудником.

При попытке изменения НЕ текстового сообщения будет возвращена ошибка с кодом 400.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
path Parameters
chatMessageId
required
integer

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

Request Body schema: application/json
required

Новый текст сообщения

text
required
string

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

Responses

Request samples

Content type
application/json
{
  • "text": "Привет, как дела?"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет сообщение, отправленное аутентифицированным сотрудником.

В случае ошибки удаления сообщения во внешнем сервисе (например в Telegram) будет возвращена ошибка с кодом 400.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
path Parameters
chatMessageId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

forward original

Пересылает оригинал сообщения аутентифицированному сотруднику в личные сообщения на сервисе, через которое сообщение было отправлено.

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

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
path Parameters
chatMessageId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

mark as read

Помечает сообщения в чате прочитанными.

Передаваемые в параметре chat_message_ids идентификаторы сообщений должны быть из чата, который передан в параметре chat_id.

Передаваемые в параметре chat_message_ids идентификаторы сообщений должны иметь флаг is_readable со значение true.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
Request Body schema: application/json
required

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

chat_id
required
integer

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

chat_message_ids
required
integer

Массив идентификаторов сообщений, которые необходимо пометить прочитанными.

Responses

Request samples

Content type
application/json
{
  • "chat_id": 1,
  • "chat_message_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

Шаблоны сообщений в чатах

Описание методов для взаимодействия с шаблонами сообщений в чатах.

index

Возвращает список шаблонов сообщений аутентифицированного сотрудника.

Требуются права доступа:

  • CHAT_SHOW ChatMessageTemplatesIndexParameters
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинация).

sort_by
string
Default: "id"
Enum: "id" "title" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых записей на странице.

search
string

Произвольный текстовый запрос для поиска записей.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новый шаблон сообщения аутентифицированного сотрудника.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные шаблона сообщения

title
required
string

Название шаблона сообщения

content
required
string

Содержимое шаблона сообщения

Responses

Request samples

Content type
application/json
{
  • "title": "Тестовый шаблон",
  • "content": "Текст тестового шаблона"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает шаблон сообщения аутентифицированного сотрудника.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
path Parameters
chatMessageTemplateId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

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

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
path Parameters
chatMessageTemplateId
required
integer

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

Request Body schema: application/json
required

Данные шаблона сообщения

title
required
string

Название шаблона сообщения

content
required
string

Содержимое шаблона сообщения

Responses

Request samples

Content type
application/json
{
  • "title": "Тестовый шаблон",
  • "content": "Текст тестового шаблона"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет шаблон сообщения аутентифицированного сотрудника.

Требуются права доступа:

  • CHAT_SHOW
Authorizations:
BearerToken
path Parameters
chatMessageTemplateId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Статистика

Описание методов для взаимодействия со статистикой.

chats

Создаёт фоновую задачу на расчёт статистики чатов.

Требуются права доступа:

  • STATISTIC_SHOW
  • CHATS_STATISTIC_SHOW

Если не передан параметр chat_at_from и/или chat_at_to, будет сгенерирована статистика за всё время.

В результате выполнения будет возвращён объект фоновой задачи. Процесс выполнения фоновой задачи следует отслеживать с помощью соответствующего метода.

При успешном расчёте статистики полученный объект фоновой задачи будет иметь следующую структуру поля result:

{
  "type": "chats_statistic", // Тип статистики
  "params": { // Параметры, с учётом которых рассчитана статистики
    "chat_at_from": "01.01.2025",
    "chat_at_to": "31.02.2025"
  },
  "chats": {
    "total": 7, // Всего чатов
    "old": {
      "total": 3, // Всего старых чатов
      "clients_total": 2, // Всего клиентов, связанных с новыми чатами
      "clients_ids": [1, 2] // Идентификаторы клиентов, связанных с новыми чатами
    },
    "new": {
      "total": 4, // Всего новых чатов
      "clients_total": 3, // Всего клиентов, связанных со старыми чатами
      "clients_ids": [3, 4, 5] // Идентификаторы клиентов, связанных со старыми чатами
    },
    "dynamic": [ // Динамика чатов с разбивкой по месяцам
      {
        "month": "01.2025", // Месяц/Год
        "total": 5, // Всего чатов
        "old": 3, // Старых чатов
        "new": 2 // Новых чатов
      },
      {
        "month": "02.2025",
        "total": 2, // Всего чатов
        "old": 0, // Старых чатов
        "new": 2 // Новых чатов
      }
    ]
  },
  "calendar_event_types": { // Типы календарных событий
    "old_chats": [ // Для старых чатов
      {
        "id": 1, // Идентификатор типа календарного события
        "title": "Консультация первичная", // Заголовок типа календарного события
        "color": "#fff", // Цвет типа календарного события
        "statuses": [ // Статусы календарных событий
          {
            "id": 1, // Идентификатор статуса календарного события
            "title": "Запланировано", // Заголовок статуса календарного события
            "color": "#cccccc", // Цвет статуса календарного события
            "calendar_events_total": 2, // Всего календарных событий с соответствующим типом и статусом
            "calendar_events_ids": [1, 2] // Идентификаторы календарных событий с соответствующим типом и статусом
          }
        ]
      }
    ],
    "new_chats": [ // Для новых чатов
      {
        "id": 1, // Идентификатор типа календарного события
        "title": "Консультация первичная", // Заголовок типа календарного события
        "color": "#fff", // Цвет типа календарного события
        "statuses": [ // Статусы календарных событий
          {
            "id": 1, // Идентификатор статуса календарного события
            "title": "Запланировано", // Заголовок статуса календарного события
            "color": "#cccccc", // Цвет статуса календарного события
            "calendar_events_total": 2, // Всего календарных событий с соответствующим типом и статусом
            "calendar_events_ids": [1, 2] // Идентификаторы календарных событий с соответствующим типом и статусом
          }
        ]
      }
    ]
  },
  "bot_start_sources": [ // Источники начала чатов с ботом
    {
        "id": 1, // Идентификатор источника
        "title": "Личный сайт", // Название источника
        "chats_total": 5, // Уникальных чатов, начатых через соответствующий источник
        "clients_ids": [1, 2], // Идентификаторы клиентов, с которыми установлена связь чатов, начатых через соответствующий источник
        "clients_total": 2 // Всего клиентов, с которыми установлена связь чатов, начатых через соответствующий источник
    },
  ]
}
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные сделок

chat_at_from
string

Минимальная дата взаимодействия с чатом в формате dd.mm.YYYY.

chat_at_to
string

Максимальная дата взаимодействия с чатом в формате dd.mm.YYYY.

Responses

Request samples

Content type
application/json
{
  • "chat_at_from": "01.01.2025",
  • "chat_at_to": "31.01.2025"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Автоматические подтверждения календарных событий

Описание методов для взаимодействия с автоматическими подтверждениями календарных событий.

index

Возвращает список автоматических подтверждений календарных событий.

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинации).

sort_by
string
Default: "id"
Enum: "id" "created_at" "updated_at" "relevance"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых записей на странице.

types
Array of integers

Массив идентификаторов типов календарных событий

statuses
Array of integers

Массив идентификаторов статусов календарных событий

search
string

Произвольный текстовый запрос для поиска записей.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новое автоматическое подтверждение календарных событий.

Параметр types обязателен при отрицательном значении параметра is_for_all_types.

Параметр statuses обязателен при отрицательном значении параметра is_for_all_statuses.

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json
required

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

time_before
required
integer

Время, за которое должно сработать автоматическое подтверждение

time_before_units
required
string
Value: ["minute","hour","day","week","month","year"]

Единицы измерения времени, за которое должно сработать автоматическое подтверждение

notification_text
required
string

Текст сообщения, отправляемый клиенту для подтверждения

confirmation_text
required
string

Текст сообщения, отправляемый клиенту при подтверждении

cancellation_text
required
string

Текст сообщения, отправляемый клиенту при отмене

is_active
required
boolean

Флаг активности автоматического подтверждения

is_for_all_types
required
boolean

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

is_for_all_statuses
required
boolean

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

types
Array of integers

Массив идентификаторов типов календарных событий, для которых должно срабатывать автоматическое подтверждение

statuses
Array of integers

Массив идентификаторов статусов календарных событий, для которых должно срабатывать автоматическое подтверждение

Responses

Request samples

Content type
application/json
{
  • "time_before": 24,
  • "time_before_units": "hour",
  • "notification_text": "{клиент}, Вы записаны на {запись}, {дата}, {время}. Пожалуйста, подтвердите запись.",
  • "confirmation_text": "Запись успешно подтверждена",
  • "cancellation_text": "Запись отменена",
  • "is_active": true,
  • "is_for_all_types": false,
  • "is_for_all_statuses": false,
  • "types": [
    ],
  • "statuses": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные автоматического подтверждения календарных событий.

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE
Authorizations:
BearerToken
path Parameters
calendarEventAutoConfirmationId
required
integer

Идентификатор автоматического подтверждения календарного события

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет автоматическое подтверждение календарных событий.

Параметр types обязателен при отрицательном значении параметра is_for_all_types.

Параметр statuses обязателен при отрицательном значении параметра is_for_all_statuses.

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE
Authorizations:
BearerToken
path Parameters
calendarEventAutoConfirmationId
required
integer

Идентификатор автоматического подтверждения календарного события

Request Body schema: application/json
required

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

time_before
required
integer

Время, за которое должно сработать автоматическое подтверждение

time_before_units
required
string
Value: ["minute","hour","day","week","month","year"]

Единицы измерения времени, за которое должно сработать автоматическое подтверждение

notification_text
required
string

Текст сообщения, отправляемый клиенту для подтверждения

confirmation_text
required
string

Текст сообщения, отправляемый клиенту при подтверждении

cancellation_text
required
string

Текст сообщения, отправляемый клиенту при отмене

is_active
required
boolean

Флаг активности автоматического подтверждения

is_for_all_types
required
boolean

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

is_for_all_statuses
required
boolean

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

types
Array of integers

Массив идентификаторов типов календарных событий, для которых должно срабатывать автоматическое подтверждение

statuses
Array of integers

Массив идентификаторов статусов календарных событий, для которых должно срабатывать автоматическое подтверждение

Responses

Request samples

Content type
application/json
{
  • "time_before": 24,
  • "time_before_units": "hour",
  • "notification_text": "{клиент}, Вы записаны на {запись}, {дата}, {время}. Пожалуйста, подтвердите запись.",
  • "confirmation_text": "Запись успешно подтверждена",
  • "cancellation_text": "Запись отменена",
  • "is_active": true,
  • "is_for_all_types": false,
  • "is_for_all_statuses": false,
  • "types": [
    ],
  • "statuses": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет автоматическое подтверждение календарных событий.

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE
Authorizations:
BearerToken
path Parameters
calendarEventAutoConfirmationId
required
integer

Идентификатор автоматического подтверждения календарного события

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

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

Описание методов для взаимодействия с параметрами каналов связи, используемых для автоматических подтверждений календарных событий.

show

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

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE

В качестве идентификатора канала связи Telegram-бота используется "tg_bot". Во всех остальных случаях используется числовой идентификатор каналов связи.

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "message": "ОК"
}

update

Обновляет информацию об активности и приоритете каналов связи, использующихся для автоматических подтверждений календарных событий

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE

В качестве идентификатора канала связи Telegram-бота используется "tg_bot". Во всех остальных случаях используется числовой идентификатор каналов связи.

Authorizations:
BearerToken
Request Body schema: application/json
required

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

Array of objects

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

Array
id
string

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

position
integer

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

is_active
boolean

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "message": "ОК"
}

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

Описание методов для взаимодействия с параметрами задержки между автоматическими подтверждениями календарных событий.

show

Возвращает информацию о задержке между повторной отправкой сообщений автоматических подтверждений календарных событий

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет информацию о задержке между повторной отправкой сообщений автоматических подтверждений календарных событий

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные конфигурации задержки между автоматическими подтверждениями календарных событий

delay
required
integer

Время задержки

units
required
string
Value: ["minute","hour","day"]

Единицы измерения времени задержки

Responses

Request samples

Content type
application/json
{
  • "delay": 30,
  • "units": "minute"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Параметры статуса, назначаемого календарному событию при его отмене через автоматическое подтверждение

Описание методов для взаимодействия с параметрами статуса, назначаемого календарному событию при его отмене через автоматическое подтверждение.

show

Возвращает информацию о статусе, назначаемом календарному событию при его отмене через автоматическое подтверждение. Если статус не указан - при отмене календарного события его статус не изменяется.

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет информацию о статусе, назначаемом календарному событию при его отмене через автоматическое подтверждение. Если статус не указан - при отмене календарного события его статус не изменяется.

Требуются права доступа:

  • CALENDAR_EVENT_AUTO_CONFIRMATION_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные статуса, назначаемого календарному событию при его отмене через автоматическое подтверждение

status_id
integer

Идентификатор статуса, назначаемого календарному событию при его отмене через автоматическое подтверждение

Responses

Request samples

Content type
application/json
{
  • "status_id": 1
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}