Broadcasts API — рассылки и шаблоны

Коротко: Broadcasts API OTP-сервиса запускает рассылки и управляет их шаблонами. Рассылка может использовать готовый шаблон или inline-содержимое.

Кому подходит

• Роль: Разработчик, Интегратор
• Уровень: Опытный

Эндпоинты

Полный URL: https://web.otpcod.ru/api/v1/broadcast/....

Запуск рассылки

Эндпоинт: POST /broadcast/broadcasts

Параметры запроса:

*- нужен либо templateId, либо payload.

Пример 1. Запуск по шаблону:

curl --location 'https://web.otpcod.ru/api/v1/broadcast/broadcasts' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <ваш-ключ>' \
  --data-raw '{
    "templateId": 3091,
    "launchTime": "",
    "webhook": "https://webhook.site/9a9a9a9a-9a9a-9a9a-9a9a-9a9a9a9a9a9a"
  }'

Пример 2. Отложенная рассылка с указанием получателей:

curl --location 'https://web.otpcod.ru/api/v1/broadcast/broadcasts' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <ваш-ключ>' \
  --data-raw '{
    "templateId": 3091,
    "launchTime": "2024-08-30T09:14:45.410958Z",
    "webhook": "https://webhook.site/9a9a9a9a-9a9a-9a9a-9a9a-9a9a9a9a9a9a",
    "recipientsList": [
      { "phoneNumber": "4915735987904" }
    ]
  }'

Пример 3. Рассылка без шаблона (inline):

curl --location 'https://web.otpcod.ru/api/v1/broadcast/broadcasts' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <ваш-ключ>' \
  --data-raw '{
    "name": "Рассылка кодов",
    "launchTime": "2025-08-30T09:14:45.410958Z",
    "webhook": "https://webhook.site/9a9a9a9a-9a9a-9a9a-9a9a-9a9a9a9a9a9a",
    "recipientsList": [
      { "phoneNumber": "4915735987904" }
    ],
    "payload": {
      "contentType": 1,
      "contentSettings": {
        "flowSteps": [
          {
            "channelType": 1,
            "senderId": "smsGate",
            "timeout": 172800,
            "deliveryCondition": "SUBMIT_SUCCESS",
            "contentPattern": "Ваш код: 1234"
          }
        ]
      }
    }
  }'

Формат payload

Объект contentSettings:

Шаги рассылки — flowSteps

Элемент flowSteps — это один шаг каскада: канал, содержимое, условие перехода.

Проверка поддержки RCS — rcsCapabilityCheck

Используется, когда contentType: 3 — RCS Capability Check. Позволяет проверить, поддерживает ли устройство получателя RCS.

Пример:

{
  "contentType": 3,
  "contentSettings": {
    "rcsCapabilityCheck": {
      "senderId": "rcs_sender"
    }
  }
}

Сценарий чат-бота — scenario

Используется, когда contentType: 2 — Chat Bot. Запускает двустороннюю рассылку со сценарием чат-бота.

Пример:

{
  "contentType": 2,
  "contentSettings": {
    "scenario": {
      "channelId": 4,
      "flowId": 42,
      "senderId": "wa_sender"
    }
  }
}

Управление шаблонами

Список

Эндпоинт: GET /broadcast/templates

curl --location 'https://web.otpcod.ru/api/v1/broadcast/templates?limit=2' \
  --header 'X-API-Key: <ваш-ключ>'

Создание шаблона

Эндпоинт: POST /broadcast/templates

curl --location 'https://web.otpcod.ru/api/v1/broadcast/templates' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <ваш-ключ>' \
  --data-raw '{
    "name": "Рассылка кодов",
    "contentType": 1,
    "content": {
      "flowSteps": [
        {
          "channelType": 1,
          "senderId": "sms_sender",
          "contentPattern": "Ваш код: {{code}}",
          "deliveryCondition": "DELIVERY_SUCCESS",
          "timeout": 259200
        }
      ]
    }
  }'

Детали / обновление / удаление

# Детали
curl --location 'https://web.otpcod.ru/api/v1/broadcast/templates/1670' \
  --header 'X-API-Key: <ваш-ключ>'

# Обновление (частичное)
curl --location --request PUT 'https://web.otpcod.ru/api/v1/broadcast/templates/1670' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <ваш-ключ>' \
  --data-raw '{
    "name": "Рассылка кодов 2024"
  }'

# Удаление — возвращает 204 No Content
curl --location --request DELETE 'https://web.otpcod.ru/api/v1/broadcast/templates/1670' \
  --header 'X-API-Key: <ваш-ключ>'

Вебхук статусов рассылки

URL вебхука обязателен при запуске рассылки.

Коды ответов

Частые проблемы

См. также

Нужна помощь?

• OTP-коды: support@otpcod.ru