Глоссарий Multi API
Термины Multi API — эндпоинт, payload, template, channel, senderId, вебхук
Коротко: словарь терминов, которые встречаются в интерфейсе и документации Multi API.
Кому подходит
- Роль: Клиент, Разработчик, Администратор
- Уровень: Новичок
Глоссарий длинный — используйте поиск по странице (Ctrl+F на Windows / Cmd+F на Mac), чтобы быстро найти нужный термин.
Общие термины API
API
Application Programming Interface — интерфейс программирования приложений. Позволяет интегрировать платформу с вашими системами.
API-ключ
Уникальный идентификатор для аутентификации запросов. Передаётся в заголовке X-API-Key.
Swagger UI
Интерактивная документация API с возможностью отправки тестовых запросов.
Scope
Право доступа API-ключа: omni-api, statistics, recipients, broadcasts, dids, crm.
Эндпоинт
Конечная точка API. Например, /messages для отправки сообщений.
HTTP-код
Код ответа API: 200, 202, 204, 400, 401, 403, 404, 429, 500.
requestId
Уникальный идентификатор запроса. Используется при обращении в поддержку.
Параметры запроса
channel
Канал отправки. Указывается в параметре channel.
clientInfo
Произвольное поле из запроса. Сохраняется в EDR и может быть использовано для связи сообщения с вашей системой.
contact
Номер телефона получателя с кодом страны, без «+».
isOtp
Флаг, что сообщение содержит одноразовый код. Если true — содержимое скрывается в EDR как маска ******.
payload
Объект с содержимым сообщения. Формат зависит от канала.
senderId
Имя отправителя. Идентификатор, от имени которого отправляется сообщение.
Как зарегистрировать имя отправителя →
template
Шаблон сообщения. Используется в параметре template API-запроса вместо payload.
Как создать шаблон сообщения →
ttl
Время жизни сообщения в секундах.
Каскад и статусы
Каскад
Способ отправки, при котором сообщение перенаправляется на альтернативный канал, если не доставлено по исходному.
cooldown
Время блокировки контакта при неудаче (в секундах).
sendNextAfterFail
Флаг: отправлять ли следующее сообщение каскада при получении статуса failed после наступления successOn.
successOn
Статус успеха в каскаде: sent, delivered, seen.
timeout
Время ожидания статуса (в секундах) до перехода к следующему каналу каскада.
Группы API
Broadcasts API
Группа эндпоинтов для управления рассылками и шаблонами рассылок.
Omni API
Группа эндпоинтов для отправки сообщений и справочных методов.
Recipients API
Группа эндпоинтов для управления получателями. Доступна только в сервисе «Мой диалог».
Термины Broadcasts API
contentType
Тип содержимого рассылки: 1 — Fallback, 2 — Chat Bot, 3 — RCS Capability Check.
deliveryCondition
Условие успеха шага рассылки: SUBMIT_SUCCESS, DELIVERY_SUCCESS, DISPLAY_SUCCESS.
flowSteps
Список шагов рассылки (каскад). Каждый шаг содержит канал, содержимое и условие перехода.
Вебхуки и события
messageStatus
Событие вебхука — статус отправленного сообщения.
message
Событие вебхука — входящее сообщение от контакта (MO).
Вебхук
URL на вашей стороне, куда платформа отправляет статусы и входящие сообщения.
Данные
CDR
Call Data Record — запись данных о вызове. Содержит информацию о голосовых вызовах.
Записи данных о вызовах (CDR) →
EDR
Event Data Record — запись события. Содержит информацию о каждом отправленном сообщении.
limit и offset
Параметры пагинации для запросов списков. limit — максимум записей (по умолчанию 10–100 в зависимости от эндпоинта), offset — смещение (по умолчанию 0).
См. также
Нужна помощь?
- Multi API: support@multiapi.ru