---
description: >-
  Канал предназначен для отправки кода подтверждения в звонке, который будет
  продиктован роботом.
---

# Отправка VOICECODE

{% hint style="info" %}
**Мы рекомендуем использовать канал SMS вместе с VoiceCode для гарантированной доставки кода вашим пользователям.** \
\
Операторы связи могут блокировать часть отправленных звонков российским абонентам, в связи с этим уровень доставки VoiceCode может снизиться.
{% endhint %}

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

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

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

#### Headers

| Name                                            | Type   | Description        |
| ----------------------------------------------- | ------ | ------------------ |
| Authorization<mark style="color:red;">\*</mark> | string | `Basic {TOKEN_1}`  |
| Content-Type<mark style="color:red;">\*</mark>  | string | `application/json` |

#### Request Body

| Name                                                  | Type    | Description                                                                                                                                                                                                               |
| ----------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| channelType<mark style="color:red;">\*</mark>         | string  | Канал отправки (`VOICECODE`)                                                                                                                                                                                              |
| senderName<mark style="color:red;">\*</mark>          | string  | Имя отправителя. Необходимо отправлять значение `voicecode`                                                                                                                                                               |
| destination<mark style="color:red;">\*</mark>         | string  | Номер абонента                                                                                                                                                                                                            |
| content<mark style="color:red;">\*</mark>             | object  | Объект с содержимым сообщения                                                                                                                                                                                             |
| tags                                                  | array   | Теги сообщения (массив строк). Каждый тег должен соответствовать выражению `^\w+$` (допускаются буквы в любом регистре, цифры и нижнее подчеркивание "\_")                                                                |
| callbackUrl                                           | string  | Адрес для отправки callback                                                                                                                                                                                               |
| callbackEvents                                        | array   | События, по которым будут отправлены callback (массив строк). При наличии `callbackUrl` и отсутствии `callbackEvents` в запросе, будет отправлен callback по событию `delivered`.                                         |
| content.contentType<mark style="color:red;">\*</mark> | string  | Тип контента (всегда `text`)                                                                                                                                                                                              |
| content.text<mark style="color:red;">\*</mark>        | string  | <p>Текст сообщения, который будет зачитан абоненту. Должен соответствовать шаблону (описано ниже)<br>От 1 до 1000 символов</p>                                                                                            |
| ttl                                                   | integer | <p>Время жизни сообщения в секундах. По истечении ttl сообщению присваивается финальный статус.</p><p><code>30</code><strong><code>≤</code></strong><code>ttl</code><strong><code>≤</code></strong><code>86400</code></p> |
| externalMessageId                                     | string  | Внутренний id сообщения в вашей системе. До 100 символов.                                                                                                                                                                 |

::::::{tab-set}

:::::{tab-item} 200

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

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


:::::{tab-item} 401

Использование невалидного токена / отсутствие заголовка авторизации.

::::{tab-set}

:::{tab-item} 4012

```
{
    "error": {
        "code": 4012,
        "msg": "Bad credentials"
    }
}
```
:::


:::{tab-item} 4010

```
{
    "error": {
        "code": 4010,
        "msg": "Not Authenticated"
    }
}
```
:::

::::

:::::


:::::{tab-item} 403

Использование неподходящего токена.

```
{
    "error": {
        "code": 4030,
        "msg": "Access Denied"
    }
}
```
:::::


:::::{tab-item} 422

Невалидные параметры в теле запроса; ниже приведены несколько примеров ответа.

```
{
    "error": {
        "code": 4220,
        "msg": "Invalid content"
    }
}
-----------------------------------------------------------------------------
{
    "error": {
        "code": 4220,
        "msg": "Invalid msisdn"
    }
}
```
:::::


:::::{tab-item} 402

Payment Required. Недостаточно средств на балансе.

```javascript
{
    "error": {
        "code": 402,
        "msg": "Insufficient funds"
    }
}
```
:::::

::::::


{% hint style="warning" %}
Рекомендуемое время ожидания ответа: 70 секунд.\
Как правило, ответ на запрос возвращается не более чем за несколько секунд, но таймаут величиной в 70 секунд позволяет гарантированно получить ответ на запрос, в том числе в ситуациях повышенной нагрузки.
{% endhint %}

{% hint style="info" %}
* Отправляемый текст должен соответствовать шаблону:\
  &#xNAN;**`Код авторизации от {Бренд}: {Код}`**\
  &#xNAN;**`Код авторизации от {Бренд}: {Код}. Повторяю: {Код}`**\
  \
  Код может передаваться слитно (1234), с пробелом (1 2 3 4), разделяя спец.символом (1-2-3-4) - на качестве озвучки кода это не сказывается. \
  \
  Для возможности отправки сообщений по другому шаблону вы можете обратиться к менеджеру
* В качестве senderName нужно передавать значение `voicecode`
{% endhint %}

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

| Параметр       | Варианты                                                              |
| -------------- | --------------------------------------------------------------------- |
| callbackEvents | [События для отправки callback](../extra/references/#callback-events) |

## Пример запроса <a href="#example" id="example"></a>

::::::{tab-set}

:::::{tab-item} JSON

```
POST https://direct.i-dgtl.ru/api/v1/message
Authorization: Basic QWxhZGRpbjpvc...
Content-Type: application/json
[
  {
    "channelType": "VOICECODE",
    "senderName": "voicecode",
    "destination": "79999999999",
    "content": {
        "contentType": "text",
        "text": "Код авторизации от i-digital: 3 4 5 6"
    }
  }
]
```
:::::


:::::{tab-item} cURL

```
curl -X POST 'https://direct.i-dgtl.ru/api/v1/message' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic QWxhZGRpbjpvc...' \
-d '[{"channelType":"VOICECODE","senderName":"voicecode","destination":"79999999999","content":{"contentType":"text","text":"Код авторизации от i-digital: 3 4 5 6"}}'
```
:::::

::::::


{% hint style="info" %}
В примере указан минимальный набор параметров, который позволяет моментально отправить VOICECODE. Вы можете кастомизировать время отправки, настроить коллбэки, добавить теги и внутренний идентификатор, используя опциональные параметры, описанные выше на данной странице.&#x20;
{% endhint %}