Отправка кода подтверждения

Отправка кода подтверждения#

Отправка кода#

POST https://direct.i-dgtl.ru/api/v1/verifier/send

Запрос позволяет отправить код подтверждения по условиям настроенного модуля

Headers#

Name

Type

Description

Authorization*

String

Basic {TOKEN_3}

Content-Type*

String

application/json

Request Body#

Name

Type

Description

gatewayId*

String

ID модуля подтверждения (указан на странице в ЛК)

channelType*

String

Канал отправки кода, настроенный в модуле. Допускаются значения SMS, VK, VIBER, WHATSAPP, WEASY,TELEGRAM GATEWAY

destination*

String

Номер абонента в международном формате. Только цифры.

substitutions

Json

Объект с подстановками для текста сообщения

{% hint style=»info» %} Использование подстановок позволяет передавать в сообщении с кодом какие-либо уникальные данные (например, ссылку на договор).

По умолчанию для модуля доступны только шаблоны без возможности подстановок – для использования подстановок в ваших шаблонах обратитесь к вашему менеджеру. {% endhint %}

Код передан к отправке. Возвращается идентификатор, который необходимо использовать для проверки

{
  "uuid": "b8e52cdd-f5de-4c3c-95bc-63e841c70be9"
}

Код HTTP 429 сообщает о превышении количества запросов на один номер в единицу времени (ограничение устанавливается в настройках модуля в личном кабинете).

Сообщение не будет отправлено.

Пример тела запроса 1 #

Отправка кода в SMS из-под модуля с id = Abc123 на номер +7 000 000 00 00

{
  "gatewayId": "Abc123",
  "channelType": "SMS",
  "destination": "70000000000"
}

Пример тела запроса 2#

Отправка кода в VK из-под модуля с id = dEf456 на номер +7 123 456 78 90 с подстановками для текста сообщения:

{
  "gatewayId": "dEf456",
  "channelType": "VK",
  "destination": "71234567890",
  "substitutions": {
    "link": "https://example.com",
    "name": "Иван"
  }
}

{% hint style=»info» %} Ключи для подстановок должны соответствовать названиям подстановок в шаблоне. Для использования шаблонов с подстановками обратитесь к вашему менеджеру. {% endhint %}