Отправка VOICECODE

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

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

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

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	Канал отправки (VOICECODE)
senderName*	string	Имя отправителя. Необходимо отправлять значение voicecode
destination*	string	Номер абонента
content*	object	Объект с содержимым сообщения
tags	array	Теги сообщения (массив строк). Каждый тег должен соответствовать выражению ^\w+$ (допускаются буквы в любом регистре, цифры и нижнее подчеркивание "_")
callbackUrl	string	Адрес для отправки callback
callbackEvents	array	События, по которым будут отправлены callback (массив строк). При наличии callbackUrl и отсутствии callbackEvents в запросе, будет отправлен callback по событию delivered.
content.contentType*	string	Тип контента (всегда text)
content.text*	string	Текст сообщения, который будет зачитан абоненту. Должен соответствовать шаблону (описано ниже) От 1 до 1000 символов
ttl	integer	Время жизни сообщения в секундах. По истечении ttl сообщению присваивается финальный статус. 30≤ttl≤86400
externalMessageId	string	Внутренний id сообщения в вашей системе. До 100 символов.

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 секунд позволяет гарантированно получить ответ на запрос, в том числе в ситуациях повышенной нагрузки.

• Отправляемый текст должен соответствовать шаблону: Код авторизации от {Бренд}: {Код} Код может передаваться слитно (1234), с пробелом (1 2 3 4), разделяя спец.символом (1-2-3-4) - на качестве озвучки кода это не сказывается. Для возможности отправки сообщений по другому шаблону вы можете обратиться к менеджеру

• В качестве senderName нужно передавать значение voicecode

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

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

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

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"
    }
  }
]

cURL

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