Отправка FLASHCALL

Отправленное сообщение поступит абоненту в виде звонка; последние цифры номера соответствуют коду, переданному в сообщении.

Мы рекомендуем использовать канал SMS вместе с Flashcall для гарантированной доставки кода вашим пользователям. Операторы связи могут блокировать часть отправленных звонков российским абонентам, в связи с этим уровень доставки Flashcall может снизиться.

Отправка FLASHCALL-сообщений

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

Метод позволяет отправлять массив одиночных сообщений (от 1 до 1000)

Headers

Name	Type	Description
Authorization*	string	Basic {TOKEN_1}
Content-Type*	string	application/json

Request Body

Name	Type	Description
channelType*	string	Канал отправки (FLASHCALL)
senderName*	string	Имя отправителя. Допускается любая строка. Звонок будет произведен с номера телефона, последние цифры которого являются кодом подтверждения
destination*	string	Номер абонента
content*	string	Числовой код, от 3 до 6 символов
tags	array	Теги сообщения (массив строк). Каждый тег должен соответствовать выражению ^\w+$ (допускаются буквы в любом регистре, цифры и нижнее подчеркивание "_")
callbackUrl	string	Адрес для отправки callback
callbackEvents	array	События, по которым будут отправлены callback (массив строк). При наличии callbackUrl и отсутствии callbackEvents в запросе, будет отправлен callback по событию delivered.
ttl	integer	Время жизни сообщения в секундах. По истечении ttl сообщению присваивается финальный статус. 30≤ttl≤86400

200

В случае успешного запроса возвращается ответ, в котором перечислены идентификаторы сообщений и коды результата. При значении errors = false гарантируется, что все переданные сообщения успешно созданы.

{
  "errors": false,
  "items": [
    {
      "messageUuid": "063474ec-a34f-4558-90c5-984395000004",
      "code": 201
    },
    {
      "messageUuid": "063564ec-a34f-4558-90c5-984395000005",
      "code": 201
    }
  ]
}

401

403

422

402

Рекомендуемое время ожидания ответа: 70 секунд. Как правило, ответ на запрос возвращается не более чем за несколько секунд, но таймаут величиной в 70 секунд позволяет гарантированно получить ответ на запрос, в том числе в ситуациях повышенной нагрузки.

Возможные варианты перечислений:

Параметр	Варианты
callbackEvents	События для отправки callback

Пример запроса

JSON

POST https://direct.i-dgtl.ru/api/v1/message
Authorization: Basic QWxhZGRpbjpvc...
Content-Type: application/json
[
  {
    "channelType": "FLASHCALL",
    "senderName": "FLASHCALL",
    "destination": "79818268484",
    "content": "1234"
  }
]

cURL

В примере указан минимальный набор параметров, который позволяет моментально отправить FLASHCALL-сообщение. Вы можете настроить коллбэки, добавить теги и внутренний идентификатор, используя опциональные параметры, описанные выше на данной странице.

Отправка конверсии FLASHCALL

POST https://direct.i-dgtl.ru/api/v1/flashcall-conversion

Метод используется для того, чтобы сообщить о корректности введенного пользователем кода, отправленного в FLASHCALL-сообщении

Headers

Name	Type	Description
Authorization	string	Bearer {TOKEN_1}
Content-Type	string	application/json

Request Body

Name	Type	Description
messageUuid	string	Идентификатор flashcall-сообщения
result	string	Результат ввода кода Код подтвержден -- NUMBER_VERIFIERD Неверный код -- WRONG_CODE
code	string	Код

200 Совпадает с ответом на отправку одиночных сообщений

{
  "errors": false,
  "items": [
    {
      "messageUuid": "063474ec-a34f-4558-90c5-984395000004",
      "code": 201
    },
    {
      "messageUuid": "063564ec-a34f-4558-90c5-984395000005",
      "code": 201
    }
  ]
}

Возможные варианты перечислений:

Параметр	Варианты
result	Результат отправки FlashCall

Передача конверсии помогает нам улучшать качество отправки FLASHCALL-сообщений

Пример запроса

JSON

POST https://direct.i-dgtl.ru/api/v1/flashcall-conversion
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
[
  {
    "messageUuid": "063464ec-a34f-4558-90c5-984395000004",
    "result": "NUMBER_VERIFIED",
    "code": "7777"
  }
]

cURL