Отправка TEXT TO SPEECH
Отправленные сообщения поступят абоненту в формате звонка; текст будет продиктован роботом.
Отправка TEXT TO SPEECH-сообщений
POST https://direct.i-dgtl.ru/api/v1/message
Метод позволяет отправлять массив одиночных сообщений (от 1 до 1000)
Headers
Authorization*
string
Basic {TOKEN_1}
Content-Type*
string
application/json
Request Body
channelType*
string
Канал отправки (TEXT_TO_SPEECH)
senderName*
string
Имя отправителя. По-умолчанию разрешена доставка с номера 74999553511. Другой номер можно запросить у тех.поддержки
destination*
string
Номер абонента
content*
object
Объект с содержимым сообщения
tags
array
Теги сообщения (массив строк). Каждый тег должен соответствовать выражению ^\w+$ (допускаются буквы в любом регистре, цифры и нижнее подчеркивание "_")
callbackUrl
string
Адрес для отправки callback
callbackEvents
array
События, по которым будут отправлены callback (массив строк). При наличии callbackUrl и отсутствии callbackEvents в запросе, будет отправлен callback по событию delivered.
content.contentType*
string
Тип контента (всегда tts)
content.text*
string
Текст сообщения, который будет зачитан абоненту. От 1 до 5000 символов
localSendTime
string
Нижняя граница допустимого времени отправки сообщения (с учетом useLocalTime)
Дата в формате 'YYYY-MM-DD hh:mm:ss' в диапазоне от (текущее время в UTC - 12 часов) до (текущее время в UTC + 7 дней)
По умолчанию сообщение будет отправлено сразу
useLocalTime
boolean
Флаг, отвечающий за таймзону, в которой будет отправлено сообщение:
true - отправка в таймзоне абонента
false - отправка по МСК
localCompletionTime
string
Верхняя граница допустимого времени отправки сообщения (с учетом useLocalTime) в диапазоне от localSendTime до (текущее время в UTC + 70 дней)
days
array
Допустимые дни отправки (массив чисел). В массиве могут быть переданы целые числа от 1 (пн) до 7 (вс), каждое из которых соответствует разрешенному для отправки дню недели; значения должны быть уникальны.
hours
array
Допустимые часы отправки (массив чисел). В массиве могут быть переданы целые числа от 0 до 23, каждое из которых соответствует разрешенному для отправки часовому интервалу с учетом useLocalTime; значения должны быть уникальны.
ttl
integer
Время жизни сообщения в секундах. По истечении ttl сообщению устанавливается финальный статус.
60 ≤ ttl ≤ 86400
content.sex
string
Пол голоса, произносящего сообщение.
По умолчанию female
content.speed
number
Скорость произнесения сообщения. Допускаются значения: 0.5, 0.8, 1.0, 1.2, 1.5 По умолчанию 1.2
externalMessageId
string
Внутренний id сообщения в вашей системе. До 100 символов.
В случае успешного запроса возвращается ответ, в котором перечислены идентификаторы сообщений и коды результата. При значении errors = false гарантируется, что все переданные сообщения успешно созданы.
Использование невалидного токена / отсутствие заголовка авторизации.
Использование неподходящего токена.
Невалидные параметры в теле запроса; ниже приведены несколько примеров ответа.
Payment Required. Недостаточно средств на балансе.
Рекомендуемое время ожидания ответа: 70 секунд. Как правило, ответ на запрос возвращается не более чем за несколько секунд, но таймаут величиной в 70 секунд позволяет гарантированно получить ответ на запрос, в том числе в ситуациях повышенной нагрузки.
Для отправки кодов подтверждения рекомендуем использовать канал VOICECODE, т.к. там отслеживается конверсия доставки кодов. При отправке цифр в тексте рекомендуем разделять цифры пробелом или дефисом.
Возможные варианты перечислений:
content.sex
male — мужской голос
female — женский голос
callbackEvents
Пример запроса
В примере указан минимальный набор параметров, который позволяет моментально отправить TEXT-TO-SPEECH. Вы можете кастомизировать время отправки, настроить коллбэки, добавить теги и внутренний идентификатор, используя опциональные параметры, описанные выше на данной странице.
Last updated