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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type VoicesResult = Record<string, string>

try {
  const response = await $b24.actions.v2.call.make<VoicesResult>({
    method: 'voximplant.tts.voices.get',
    params: {},
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Available TTS voices:', result)
    console.info('Total voices:', Object.keys(result).length)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getVoices() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'voximplant.tts.voices.get',
        params: {},
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Available TTS voices:', result)
      console.info('Total voices:', Object.keys(result).length)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getVoices)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.voximplant.tts.voices.get().response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "voximplant.tts.voices.get", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("voximplant.tts.voices.get: %w", err)
}

var item struct {
	Auenglishfemale    string `json:"auenglishfemale"`
	Brportuguesefemale string `json:"brportuguesefemale"`
	Caenglishfemale    string `json:"caenglishfemale"`
	Cafrenchfemale     string `json:"cafrenchfemale"`
	Cafrenchmale       string `json:"cafrenchmale"`
	Chchinesefemale    string `json:"chchinesefemale"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Auenglishfemale, item.Brportuguesefemale)

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

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-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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