sinch-rtc
    Preparing search index...

    Interface DialVoiceRelayOptionsBeta

    Options for dialing a Voice Relay destination through the Sinch Voice V2 platform.

    interface DialVoiceRelayOptions {
        callHeaders?: Record<string, string>;
        enableInterruptions?: boolean;
        serviceId?: string;
        sttLanguage: string;
        ttsVoice: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    callHeaders? enableInterruptions? serviceId? sttLanguage ttsVoice

    Properties

    callHeaders?: Record<string, string>

    Custom headers sent in the call setup as SVAML extra info. At most 16 headers; each key must be 1-255 characters, and each value at most 255 characters.

    enableInterruptions?: boolean

    Whether speech can interrupt text-to-speech playback.

    serviceId?: string

    Identifier of a Sinch Voice V2 Service whose configuration (webhooks, signing credentials, call behaviours) governs the dial. When omitted, the project's default Service is used.

    sttLanguage: string

    BCP-47 language tag used for speech-to-text transcription, for example en-US. See https://developers.sinch.com/docs/voice/api-reference/voice-locales for available locales.

    ttsVoice: string

    Voice used when synthesizing speech, for example Emma. See https://developers.sinch.com/docs/voice/api-reference/voice-locales for available voices.

    Settings

    Member Visibility

    On This Page

    Properties