Перейти к содержанию

TrueNum API

TrueNum — сервис верификации телефонных номеров через callback (caller-ID). Конечный пользователь звонит на выданный нами номер со своего телефона; мы фиксируем номер звонящего и подтверждаем владение номером.

В отличие от классических SMS-OTP схем, метод не требует от пользователя вводить код — достаточно просто позвонить. Стоимость на стороне TrueNum ниже SMS, а UX — короче.

Как это работает

sequenceDiagram
    autonumber
    participant Client as Ваш бэкенд
    participant API as TrueNum API
    participant User as Пользователь
    participant SIP as TrueNum SIP
    Client->>API: POST /api/v1/verifications/<br/>{phone, webhook_url}
    API-->>Client: 201 {verification_id, dial_number, expires_at}
    Client->>User: Покажите "позвоните на dial_number"
    User->>SIP: Звонок с phone на dial_number
    SIP-->>User: 486 Busy (короткий гудок, отбой)
    API->>Client: POST webhook_url<br/>{type: "verification.completed", caller_id}

Полный цикл — 10–30 секунд. Если за TTL (по умолчанию 5 минут) звонок не поступил, мы отправляем verification.expired.

С чего начать

  • Быстрый старт — путь от регистрации до первой успешной верификации за 10 минут.
  • Аутентификация — Bearer-токены tn_live_*, как их создавать и хранить.
  • API: верификации — два публичных эндпоинта с примерами.
  • Webhooks — приём событий, верификация HMAC-подписи, политика ретраев.

Поддержка

Issues / вопросы по API: пишите на адрес из дашборда вашего аккаунта.