---
title: Обзор API OTP-кодов
description: API OTP-кодов — OMNI API, Broadcasts API и 2FA-эндпоинты. Отправка и проверка кодов, рассылки, Swagger UI
---

> **For AI agents:** the complete documentation index is at [llms.txt](/llms.txt). Append `.md` to any page URL for its markdown version.


> **Коротко:** OTP-сервис предоставляет доступ к двум группам API — OMNI API для отправки кодов и Broadcasts API для рассылок. Плюс специальные эндпоинты для 2FA-интеграции.

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

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

## Что такое API OTP-кодов

Через API OTP-сервиса можно:

- Отправлять одноразовые коды через SMS, WhatsApp, TTS, RCS, FlashCall и другие каналы.
- Запускать каскадную отправку с автоматическим переключением между каналами.
- Управлять рассылками и их шаблонами.
- Работать с 2FA-интеграцией: отправлять и проверять коды, получать статус запроса.
- Получать баланс, список каналов, имена отправителей, EDR-записи.
- Работать с шаблонами сообщений и WhatsApp.

## Базовый URL

```
https://web.otpcod.ru/api/v1
```

## Аутентификация

Заголовок `X-API-Key` с вашим API-ключом в каждом запросе.

**Как получить ключ:** [API-ключи](/06-reference/01-api/api-keys).

<Note>
При создании ключа вы выбираете имена отправителей. От выбранных имён зависит, по каким каналам сможет отправлять ключ.
</Note>

## Три группы эндпоинтов

| Группа | Что делает | Доступна в OTP |
|---|---|---|
| **OMNI API** | Отправка кодов, работа с балансом, каналами, EDR, шаблонами | ✅ |
| **Broadcasts API** | Запуск рассылок, управление шаблонами рассылок | ✅ |
| **2FA-эндпоинты** | Отправка и проверка кодов через 2FA-интеграцию | ✅ |
| Recipients API | Управление контактами, атрибутами, фильтрами | ❌ |

<Note>
Recipients API в OTP-сервисе недоступен. Для работы с получателями используйте интерфейс «Мой диалог».
</Note>

## OMNI API — эндпоинты

| Метод | Эндпоинт | Для чего |
|---|---|---|
| POST | `/messages` | Отправка одного сообщения с кодом |
| POST | `/omnimessages` | Каскадная отправка |
| POST | `/messages/revoke` | Отозвать верификационное сообщение Telegram Gateway |
| POST | `/messages/verification` | Проверить статус верификации Telegram Gateway |
| GET | `/balance` | Баланс компании |
| GET | `/channels` | Список каналов, доступных компании |
| GET | `/edrs` | Записи о доставке сообщений |
| GET | `/senders` | Список имён отправителей компании |
| GET | `/templates` | Список шаблонов сообщений |
| GET | `/wa_templates` | Список шаблонов WhatsApp |

## Broadcasts API — эндпоинты

| Метод | Эндпоинт | Для чего |
|---|---|---|
| POST | `/broadcast/broadcasts` | Запуск рассылки |
| GET | `/broadcast/templates` | Список шаблонов рассылок |
| POST | `/broadcast/templates` | Создать шаблон рассылки |
| GET | `/broadcast/templates/{id}` | Детали шаблона рассылки |
| PUT | `/broadcast/templates/{id}` | Обновить шаблон рассылки |
| DELETE | `/broadcast/templates/{id}` | Удалить шаблон рассылки |

## 2FA-эндпоинты

Специальные эндпоинты для 2FA-интеграции. Используют Basic Auth, а не `X-API-Key`. Ключ и URL выдаются при настройке интеграции в разделе **2FA Service**.

| Метод | Эндпоинт | Для чего |
|---|---|---|
| POST | `/2fa/verify` | Проверить введённый код |
| GET | `/2fa/requests/{requestId}` | Получить статус 2FA-запроса |

Подробнее о работе 2FA-интеграции — в статьях:

- [Принцип работы 2FA: на стороне платформы](/02-otp/01-turnkey/otp-106-platform-side)
- [Принцип работы 2FA: на стороне клиента](/02-otp/01-turnkey/otp-107-client-side)
- [Получение обратных вызовов при 2FA](/02-otp/01-turnkey/otp-108-callbacks)
- [Проверка запроса 2FA](/02-otp/01-turnkey/otp-109-check-request)

## Swagger UI

- OMNI API: https://web.otpcod.ru/api/v1/swagger-ui/index.html?urls.primaryName=OMNI_API
- Broadcasts API: https://web.otpcod.ru/api/v1/swagger-ui/index.html?urls.primaryName=Broadcasts_API

## Что дальше

<Columns cols={2}>
  <Card title="Подключение к API" icon="plug" href="/02-otp/08-api/otp-api-connection">
    Аутентификация, базовый URL, формат запросов
  </Card>
  <Card title="OMNI API" icon="paper-plane" href="/02-otp/08-api/otp-api-omni">
    Отправка кодов и шаблонов, каскад, 2FA
  </Card>
  <Card title="Broadcasts API" icon="bullhorn" href="/02-otp/08-api/otp-api-broadcasts">
    Запуск рассылок, шаблоны рассылок
  </Card>
  <Card title="API-ключи" icon="key" href="/06-reference/01-api/api-keys">
    Создание и управление ключами доступа
  </Card>
</Columns>

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

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