# Отправка TEXT TO SPEECH ## Отправка TEXT TO SPEECH-сообщений `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 | Канал отправки (`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 символов. | {% tabs %} {% tab title="200" %} В случае успешного запроса возвращается ответ, в котором перечислены идентификаторы сообщений и коды результата. При значении errors = false гарантируется, что все переданные сообщения успешно созданы. ``` { "errors": false, "items": [ { "messageUuid": "063474ec-a34f-4558-90c5-984395000004", "code": 201 }, { "messageUuid": "063564ec-a34f-4558-90c5-984395000005", "code": 201 } ] } ``` {% endtab %} {% tab title="401" %} Использование невалидного токена / отсутствие заголовка авторизации. {% tabs %} {% tab title="4012" %} ``` { "error": { "code": 4012, "msg": "Bad credentials" } } ``` {% endtab %} {% tab title="4010" %} ``` { "error": { "code": 4010, "msg": "Not Authenticated" } } ``` {% endtab %} {% endtabs %} {% endtab %} {% tab title="403" %} Использование неподходящего токена. ``` { "error": { "code": 4030, "msg": "Access Denied" } } ``` {% endtab %} {% tab title="422" %} Невалидные параметры в теле запроса; ниже приведены несколько примеров ответа. ``` { "error": { "code": 4220, "msg": "Invalid content" } } ----------------------------------------------------------------------------- { "error": { "code": 4220, "msg": "Invalid msisdn" } } ``` {% endtab %} {% tab title="402" %} Payment Required. Недостаточно средств на балансе. ```javascript { "error": { "code": 402, "msg": "Insufficient funds" } } ``` {% endtab %} {% endtabs %} {% hint style="warning" %} Рекомендуемое время ожидания ответа: 70 секунд.\ Как правило, ответ на запрос возвращается не более чем за несколько секунд, но таймаут величиной в 70 секунд позволяет гарантированно получить ответ на запрос, в том числе в ситуациях повышенной нагрузки. {% endhint %} {% hint style="info" %} Для отправки кодов подтверждения рекомендуем использовать канал VOICECODE, т.к. там отслеживается конверсия доставки кодов.\ \ При отправке цифр в тексте рекомендуем разделять цифры пробелом или дефисом. {% endhint %} Возможные варианты перечислений: | content.sex | | | -------------- | --------------------------------------------------------------------- | | callbackEvents | [События для отправки callback](/extra/references.md#callback-events) | ## Пример запроса {% tabs %} {% tab title="JSON" %} ``` POST https://direct.i-dgtl.ru/api/v1/message Authorization: Basic QWxhZGRpbjpvc... Content-Type: application/json [ { "channelType": "TEXT_TO_SPEECH", "senderName": "74999553511", "destination": "79999999999", "content": { "contentType": "tts", "text": "Ваш код: 1-2-3-4" } } ] ``` {% endtab %} {% tab title="cURL" %} ``` curl -X POST 'https://direct.i-dgtl.ru/api/v1/message' \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic QWxhZGRpbjpvc...' \ -d '[{"channelType":"TEXT_TO_SPEECH","senderName":"74999553511","destination":"79999999999","content":{"contentType":"tts","text":"Ваш код: 1-2-3-4"}}]' ``` {% endtab %} {% endtabs %} {% hint style="info" %} В примере указан минимальный набор параметров, который позволяет моментально отправить TEXT-TO-SPEECH. Вы можете кастомизировать время отправки, настроить коллбэки, добавить теги и внутренний идентификатор, используя опциональные параметры, описанные выше на данной странице. {% endhint %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://api.docs.direct.i-dgtl.ru/messages/text-to-speech-sending.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.