# FlashCall

## Отправка FlashCall

<mark style="color:green;">`POST`</mark> `https://external-api.i-dgtl.ru/message`

Метод позволяет отправить одиночный FlashCall.

#### Headers

| Name          | Type   | Description                 |
| ------------- | ------ | --------------------------- |
| Content-Type  | string | application/json            |
| Authorization | string | 'nodeID:password' \| base64 |

#### Request Body

| Name            | Type    | Description                                                                                                                                                                                                                             |
| --------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| @type           | string  | Тип сообщения, имеет постоянное значение оutbound (исходящее).                                                                                                                                                                          |
| addresses       | object  | Объект, содержащий адреса отправителя и получателя.                                                                                                                                                                                     |
| source          | string  | Имя отправителя. Допускается любая строка. Звонок придет с российского номера, в котором последние цифры будут отправленным кодом.                                                                                                      |
| destination     | string  | Номер телефона получателя. Указывается в международном формате MSISDN, состоящем из кода страны, DEF-кода оператора и номера абонента. Например, российский номер выглядит так: 79001234567, где 7 - код страны (Россия).               |
| body            | object  | Объект, в котором передаётся содержимое сообщения.                                                                                                                                                                                      |
| bodyType        | string  | Тип сообщения (flashcall).                                                                                                                                                                                                              |
| content         | string  | Числовой код, от 4 до 6 символов включительно.                                                                                                                                                                                          |
| nodeId          | integer | Номер ноды.                                                                                                                                                                                                                             |
| requestDelivery | boolean | Указывает, cледует ли предоставлять отчёт о доставке после отправки сообщения (true\|false).                                                                                                                                            |
| expirationDate  | integer | <p>Время, до которого будет ожидаться получение статуса от оператора.<br>Тип значения - <strong>timestamp</strong> в миллисекундах или в формате ISO 8601.<br>По умолчанию составляет 24 часа с момента отправки сообщения.<br><br></p> |

::::{tab-set}

:::{tab-item} 200 В случае успешного запроса возвращается ответ, в котором указан идентификатор сообщения и время отправки сообщения в формате Unix Timestamp.

```
{
    "id": "41937aa1-6322-1256-9884-aa0003427572",
    "timestamp": 1632212569902,
    "code": 200
}
```
:::


:::{tab-item} 400 Неверный синтаксис запроса

```
{
    "timestamp": 1632212616710,
    "code": 400,
    "description": "incorrect request body"
}
```
:::

::::


::::::{tip}
Если вам нужно настроить подбор кода по индивидуальным правилам, обратитесь к вашему менеджеру или в службу технической поддержки.
::::::

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

```
POST https://external-api.i-dgtl.ru/message
Authorization: Basic Mzk5OTk6MTIzNjU0
Content-Type: application/json

{
    "@type": "outbound",
    "addresses": {
        "source": "1234",
        "destination": "79500197493"
    },
    "body": {
        "bodyType": "flashcall",
        "content": "4411"
    },
    "nodeId": 31937,
    "requestDelivery": true
}
```

## **Передача конверсии для FlashCall-вызовов**

Передача конверсии для FlashCall-вызовов позволяет повысить качество сервиса, осуществляющего звонки абонентам. Настройка передачи конверсии для FlashCall-вызовов обязательна для всех направлений.

После ввода абонентом кода подтверждения/авторизации, в сервис передается одно из следующих событий:

* Введенный код совпал с отправленным
* Введенный код не совпал с отправленным
* Абонент не ввел код

Преимущества передачи конверсии:

* Из сервиса исключаются номера с плохой доставкой, что позволяет повысить коэффициент конверсии
* Дополнительный анализ кейсов, когда код был успешно отправлен, но не введен абонентом или было введено неверное значение

## Передача конверсии FlashCall

<mark style="color:green;">`POST`</mark> `https://external-api.i-dgtl.ru/conversion`

#### Headers

| Name          | Type   | Description                 |
| ------------- | ------ | --------------------------- |
| Content-Type  | string | application/json            |
| Authorization | string | 'nodeID:password' \| base64 |

#### Request Body

| Name   | Type   | Description                                                                                                                           |
| ------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| msid   | string | Уникальный идентификатор сообщения на платформе i-Digital. Передаётся клиенту при отправке сообщения.                                 |
| result | string | Результат проверки введенного пользователем кода. Возможные значения: `NUMBER_VERIFIED` - код подтвержден `WRONG_CODE` - неверный код |
| code   | string | Код, который ввел абонент.                                                                                                            |

::::{tab-set}

:::{tab-item} 200 Успешный запрос

```
 {
    "timestamp": 1632212569902,
    "path": "/conversion",
    "status": 200
 }
```
:::


:::{tab-item} 400 Неверный синтаксис запроса

```
{
    "timestamp": 1632212569902,
    "path": "/conversion",
    "status": 400,
    "error": "incorrect request body",
    "message": "Неверный синтаксис запроса",
    "requestId": "484930376"
}
```
:::

::::


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

```
POST https://external-api.i-dgtl.ru/conversion
Authorization: Basic Mzk5OTk6MTIzNjU0
Content-Type: application/json

{
    "msid": "41937aa1-6322-1256-9884-aa0003427572",
    "result": "NUMBER_VERIFIED",
    "code": "1111"
}
```