Skip to main content

$dialer.getTtsConfig

This method returns the TTS provider settings of the phone channel used for the current call.

Syntax​

The method is called without arguments:

$dialer.getTtsConfig();

The method returns a settings object. The properties of this object are different based on the provider. If the provider supports no additional settings, the method returns an empty object {}.

tip
All settings returned by the method can be overridden for the current call using the $dialer.setTtsConfig method.

Provider settings​

Google​

  • lang

    • Synthesized speech language.

  • voice

    • Speech synthesis voice.
    tip
    See the complete list of languages and voices for synthesis in the Google documentation.

  • pitch

    • Voice pitch. Takes an integer or float value from -20 to 20, where -20 means a 20-halftone decrease from the original tone, and 20 means the same increase.

  • speakingRate

    • Synthesized speech rate. Takes an integer or float value from 0.25 to 4, where 1 is the normal voice speed.

  • volumeGain

    • Volume increase in dB relative to the normal voice volume. Takes an integer or float value from -96 to 16. When set to 6, the volume is approximately twice as high as normal.

Yandex​

The list of available settings depends on the TTS version.

You can get the current version during a call via $dialer.getTtsConfig. If the useV3 parameter is set to true, then the third version of the Yandex SpeechKit protocol is used.

caution

Select a version in the connection settings.

Do not change the value of the useV3 parameter via $dialer.setTtsConfig as this can cause TTS errors.

  • lang
    • Speech synthesis language.
  • voice
    • Speech synthesis voice.
  • speed
    • Synthesized speech rate. Takes an integer or float value from 0.1 to 3, where 1 is the normal voice speed.
  • emotion

    • Speaker role, which is a characteristic of the voice. For example, the speaker can sound friendlier or whisper.

      caution

      If you use a role that is not supported for the current voice, a TTS error will occur.

tip

See the complete list of languages, voices, and roles in the Yandex documentation.

Azure​

  • language

    • Synthesized speech language.

  • voiceName

    • Speech synthesis voice.
    tip
    See the complete list of languages and voices for synthesis in the Azure documentation.

  • sampleRate

    • Sample rate.

Aimyvoice​

  • voice
    • Speech synthesis voice.

3iTech​

  • model
    • Speech synthesis language model.
  • sampleRate
    • Sample rate.
  • speed
    • Synthesized speech rate.
  • tone
    • Voice tone.

ElevenLabs​

  • voiceId

    • Voice ID. You can copy it in the ElevenLabs interface.

      note

      The ElevenLabs website is not available for Russian IP addresses.

  • modelId

    • Model for speech synthesis.

  • stability

    • Controls voice stability and synthesis variation. At low values the voice sounds emotional, at high values it sounds monotonous. Accepts values from 0 to 1.

  • similarityBoost

    • Controls how closely the AI should imitate the original voice. Accepts values from 0 to 1.

  • style

    • Amplifies the style of the original voice. Accepts values from 0 to 1. Values above 0 require more resources and might increase the latency.