--- title: Глоссарий Multi API description: Термины Multi API — эндпоинт, payload, template, channel, senderId, вебхук --- > **For AI agents:** the complete documentation index is at [llms.txt](https://docs.mydialogi.ru/llms.txt). Append `.md` to any page URL for its markdown version. > **Коротко:** словарь терминов, которые встречаются в интерфейсе и документации Multi API. ## Кому подходит - Роль: Клиент, Разработчик, Администратор - Уровень: Новичок Глоссарий длинный — используйте поиск по странице (**Ctrl+F** на Windows / **Cmd+F** на Mac), чтобы быстро найти нужный термин. ## Общие термины API ### API Application Programming Interface — интерфейс программирования приложений. Позволяет интегрировать платформу с вашими системами. [Обзор API →](https://docs.mydialogi.ru/06-reference/01-api/api-overview) ### API-ключ Уникальный идентификатор для аутентификации запросов. Передаётся в заголовке `X-API-Key`. [API-ключи →](https://docs.mydialogi.ru/06-reference/01-api/api-keys) ### Swagger UI Интерактивная документация API с возможностью отправки тестовых запросов. [Swagger UI →](https://docs.mydialogi.ru/06-reference/01-api/api-swagger) ### Scope Право доступа API-ключа: `omni-api`, `statistics`, `recipients`, `broadcasts`, `dids`, `crm`. [API-ключи →](https://docs.mydialogi.ru/06-reference/01-api/api-keys) ### Эндпоинт Конечная точка API. Например, `/messages` для отправки сообщений. [Обзор API →](https://docs.mydialogi.ru/06-reference/01-api/api-overview) ### HTTP-код Код ответа API: 200, 202, 204, 400, 401, 403, 404, 429, 500. [HTTP-коды ошибок →](https://docs.mydialogi.ru/06-reference/03-troubleshooting/ts-api-http-codes) ### requestId Уникальный идентификатор запроса. Используется при обращении в поддержку. [Обработка ошибок API →](https://docs.mydialogi.ru/06-reference/01-api/api-errors) ## Параметры запроса ### channel Канал отправки. Указывается в параметре `channel`. [Какие каналы доступны →](https://docs.mydialogi.ru/03-multiapi/03-channels/mapi-201-which-channels) ### clientInfo Произвольное поле из запроса. Сохраняется в EDR и может быть использовано для связи сообщения с вашей системой. [OMNI API — отправка →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-103-omni-api) ### contact Номер телефона получателя с кодом страны, без «+». [OMNI API — отправка →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-103-omni-api) ### isOtp Флаг, что сообщение содержит одноразовый код. Если `true` — содержимое скрывается в EDR как маска `******`. [OMNI API — отправка →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-103-omni-api) ### payload Объект с содержимым сообщения. Формат зависит от канала. [Форматы payload по каналам →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-104-omni-payload) ### senderId Имя отправителя. Идентификатор, от имени которого отправляется сообщение. [Как зарегистрировать имя отправителя →](https://docs.mydialogi.ru/03-multiapi/01-for-developers/mapi-301-sender-id) ### template Шаблон сообщения. Используется в параметре `template` API-запроса вместо `payload`. [Как создать шаблон сообщения →](https://docs.mydialogi.ru/03-multiapi/04-assets/mapi-401-message-template) ### ttl Время жизни сообщения в секундах. [OMNI API — отправка →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-103-omni-api) ## Каскад и статусы ### Каскад Способ отправки, при котором сообщение перенаправляется на альтернативный канал, если не доставлено по исходному. [Настройка каскада →](https://docs.mydialogi.ru/03-multiapi/03-channels/mapi-203-cascade) ### cooldown Время блокировки контакта при неудаче (в секундах). [OMNI API — отправка →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-103-omni-api) ### sendNextAfterFail Флаг: отправлять ли следующее сообщение каскада при получении статуса `failed` после наступления `successOn`. [OMNI API — отправка →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-103-omni-api) ### successOn Статус успеха в каскаде: `sent`, `delivered`, `seen`. [OMNI API — отправка →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-103-omni-api) ### timeout Время ожидания статуса (в секундах) до перехода к следующему каналу каскада. [OMNI API — отправка →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-103-omni-api) ## Группы API ### Broadcasts API Группа эндпоинтов для управления рассылками и шаблонами рассылок. [Broadcasts API →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-105-broadcasts-api) ### Omni API Группа эндпоинтов для отправки сообщений и справочных методов. [OMNI API — отправка →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-103-omni-api) ### Recipients API Группа эндпоинтов для управления получателями. Доступна только в сервисе «Мой диалог». [Recipients API →](https://docs.mydialogi.ru/04-mydialogi/09-api/md-api-recipients) ## Термины Broadcasts API ### contentType Тип содержимого рассылки: `1` — Fallback, `2` — Chat Bot, `3` — RCS Capability Check. [Broadcasts API →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-105-broadcasts-api) ### deliveryCondition Условие успеха шага рассылки: `SUBMIT_SUCCESS`, `DELIVERY_SUCCESS`, `DISPLAY_SUCCESS`. [Broadcasts API →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-105-broadcasts-api) ### flowSteps Список шагов рассылки (каскад). Каждый шаг содержит канал, содержимое и условие перехода. [Broadcasts API →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-105-broadcasts-api) ## Вебхуки и события ### messageStatus Событие вебхука — статус отправленного сообщения. [Вебхуки →](https://docs.mydialogi.ru/06-reference/01-api/api-webhooks) ### message Событие вебхука — входящее сообщение от контакта (MO). [Вебхуки →](https://docs.mydialogi.ru/06-reference/01-api/api-webhooks) ### Вебхук URL на вашей стороне, куда платформа отправляет статусы и входящие сообщения. [Вебхуки →](https://docs.mydialogi.ru/06-reference/01-api/api-webhooks) ## Данные ### CDR Call Data Record — запись данных о вызове. Содержит информацию о голосовых вызовах. [Записи данных о вызовах (CDR) →](https://docs.mydialogi.ru/03-multiapi/05-statistics/mapi-502-cdr) ### EDR Event Data Record — запись события. Содержит информацию о каждом отправленном сообщении. [Записи сообщений (EDR) →](https://docs.mydialogi.ru/03-multiapi/05-statistics/mapi-501-edr) ### limit и offset Параметры пагинации для запросов списков. `limit` — максимум записей (по умолчанию 10–100 в зависимости от эндпоинта), `offset` — смещение (по умолчанию 0). [Broadcasts API →](https://docs.mydialogi.ru/03-multiapi/02-api/mapi-105-broadcasts-api) ## См. также A2P, API, EDR, CDR, FMS, каскад, таргет OTP, 2FA, Zero-Tap, TOTP, HOTP Таргет, тег, сессия, чат-бот OMNI API, Broadcasts API — эндпоинты и домены ## Нужна помощь? - Multi API: support@multiapi.ru