Получить список доступных голосов для синтеза речи voximplant.tts.voices.get

Scope: telephony

Кто может выполнять метод: любой пользователь

Метод voximplant.tts.voices.get возвращает список доступных голосов для синтеза речи.

Параметры метода

Без параметров.

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/voximplant.tts.voices.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/voximplant.tts.voices.get
        
try
        {
            const response = await $b24.callMethod(
                'voximplant.tts.voices.get',
                {}
            );
            
            const result = response.getData().result;
            console.log('Data:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'voximplant.tts.voices.get',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'voximplant.tts.voices.get',
            {},
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error(), result.error_description());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'voximplant.tts.voices.get',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "auenglishfemale": "Австралийский английский (женский) (Amazon)",
                "brportuguesefemale": "Бразильский португальский (женский) (Amazon)",
                "caenglishfemale": "Канадский английский (женский) (Default)",
                "cafrenchfemale": "Канадский французский (женский) (Amazon)",
                "cafrenchmale": "Канадский французский (мужской) (Amazon)",
                "chchinesefemale": "Китайский (женский) (Default)",
                "chchinesemale": "Китайский (мужской) (Default)",
                "eurcatalanfemale": "Каталонский (женский) (Default)",
                "eurczechfemale": "Чешский (женский) (Default)",
                "eurdanishfemale": "Датский (женский) (Default)",
                "eurdutchfemale": "Голландский (женский) (Default)",
                "eurfinnishfemale": "Финский (женский) (Default)",
                "eurfrenchfemale": "Французский (женский) (Amazon)",
                "eurfrenchmale": "Французский (мужской) (Amazon)",
                "eurgermanfemale": "Немецкий (женский) (Default)",
                "eurgermanmale": "Немецкий (мужской) (Default)",
                "euritalianfemale": "Итальянский (женский) (Default)",
                "euritalianmale": "Итальянский (мужской) (Default)",
                "eurnorwegianfemale": "Норвежский (женский) (Default)",
                "eurpolishfemale": "Польский (женский) (Default)",
                "eurportuguesefemale": "Португальский (женский) (Default)",
                "eurportuguesemale": "Португальский (мужской) (Default)",
                "eurspanishfemale": "Испанский (женский) (Default)",
                "eurspanishmale": "Испанский (мужской) (Default)",
                "eurturkishfemale": "Турецкий (женский) (Default)",
                "eurturkishmale": "Турецкий (мужской) (Default)",
                "hkchinesefemale": "Гонконгский кантонский (женский) (Default)",
                "huhungarianfemale": "Венгерский (женский) (Default)",
                "jpjapanesefemale": "Японский (женский) (Default)",
                "jpjapanesemale": "Японский (мужской) (Default)",
                "krkoreanfemale": "Корейский (женский) (Default)",
                "krkoreanmale": "Корейский (мужской) (Default)",
                "ruinternalfemale": "Русский (женский) (Default)",
                "ruinternalmale": "Русский (мужской) (Default)",
                "swswedishfemale": "Шведский (женский) (Default)",
                "twchinesefemale": "Тайванский китайский (женский) (Default)",
                "ukenglishfemale": "Английский (женский) (Amazon)",
                "ukenglishmale": "Английский (мужской) (Amazon)",
                "usenglishfemale": "Американский английский (женский) (Default)",
                "usenglishmale": "Американский английский (мужской) (Default)",
                "usspanishfemale": "Американский испанский (женский) (Amazon)",
                "usspanishmale": "Американский испанский (мужской) (Amazon)"
            },
            "time": {
                "start": 1773323829,
                "finish": 1773323829.353531,
                "duration": 0.3535308837890625,
                "processing": 0,
                "date_start": "2026-03-12T16:57:09+03:00",
                "date_finish": "2026-03-12T16:57:09+03:00",
                "operating_reset_at": 1773324429,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
object

Объект со списком доступных голосов для синтеза речи, где ключ — идентификатор голоса, а значение — название голоса

time
time

Информация о времени выполнения запроса

Обработка ошибок

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Осуществить автозвонок голосовым роботом
Следующая
Обзор событий