Play text-to-speech into a call

This code snippet plays a text-to-speech message into the specified call.

Example

Replace the following variables in the example code:

Key	Description
`VOICE_CALL_ID`	The UUID of the call leg.
`VOICE_TEXT`	The text of the message to play into the call.
`VOICE_LANGUAGE`	Language to use for the speech - see Supported Languages.

Prerequisites

Execute the following command at your terminal prompt to create the JWT for authentication:

export JWT=$(nexmo jwt:generate $PATH_TO_PRIVATE_KEY application_id=$NEXMO_APPLICATION_ID)

Write the code

Add the following to play-tts-into-a-call.sh:

curl -X PUT https://api.nexmo.com/v1/calls/$VOICE_CALL_ID/talk\
  -H "Authorization: Bearer $JWT"\
  -H "Content-Type: application/json"\
  -d '{"text": "'"$VOICE_TEXT"'", "language": "'"$VOICE_LANGUAGE"'"}'

View full source

Run your code

Save this file to your machine and run it:

bash play-tts-into-a-call.sh

Prerequisites

npm install @vonage/server-sdk

Create a file named play-tts-into-a-call.js and add the following code:

const { Vonage } = require('@vonage/server-sdk');

const vonage = new Vonage({
  applicationId: VONAGE_APPLICATION_ID,
  privateKey: VONAGE_PRIVATE_KEY,
});

View full source

Write the code

Add the following to play-tts-into-a-call.js:

vonage.voice.playTTS(
  VOICE_CALL_ID,
  {
    action: 'talk',
    text: VOICE_TEXT,
    language: 'en-US',
  })
  .then((resp) => console.log(resp))
  .catch((error) => console.error(error));

View full source

Run your code

Save this file to your machine and run it:

node play-tts-into-a-call.js

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

Create a class named PlayTextToSpeechIntoCall and add the following code to the main method:

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}

View full source

Write the code

Add the following to the main method of the PlayTextToSpeechIntoCall class:

val response = client.voice.call(VOICE_CALL_ID).startTalk(VOICE_TEXT) {
    language(VOICE_LANGUAGE)
}

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.voice with the package containing PlayTextToSpeechIntoCall:

gradle run -Pmain=com.vonage.quickstart.kt.voice.PlayTextToSpeechIntoCall

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk:9.3.1'

Create a class named SendTalkToCall and add the following code to the main method:

VonageClient client = VonageClient.builder()
        .applicationId(VONAGE_APPLICATION_ID)
        .privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
        .build();

View full source

Write the code

Add the following to the main method of the SendTalkToCall class:

var payload = TalkPayload.builder(VOICE_TEXT).language(VOICE_LANGUAGE).build();
client.getVoiceClient().startTalk(VOICE_CALL_ID, payload);

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.voice with the package containing SendTalkToCall:

gradle run -Pmain=com.vonage.quickstart.voice.SendTalkToCall

Prerequisites

Install-Package Vonage

Write the code

Add the following to PlayTextToSpeech.cs:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var client = new VonageClient(credentials);

var command = new TalkCommand() { Text = VOICE_TEXT, Language = "en-US"};

var response = await client.VoiceClient.StartTalkAsync(VOICE_CALL_ID, command);

View full source

Prerequisites

composer require vonage/client

Write the code

Add the following to index.php:

View full source

Run your code

Save this file to your machine and run it:

php index.php

Prerequisites

pip install vonage python-dotenv

Write the code

Add the following to play-tts-into-call.py:

from vonage import Auth, Vonage
from vonage_voice import CallMessage, TtsStreamOptions

client = Vonage(
    Auth(
        application_id=VONAGE_APPLICATION_ID,
        private_key=VONAGE_PRIVATE_KEY,
    )
)

response: CallMessage = client.voice.play_tts_into_call(
    uuid=VOICE_CALL_ID,
    tts_options=TtsStreamOptions(text=VOICE_TEXT, language=VOICE_LANGUAGE),
)

pprint(response)

View full source

Run your code

Save this file to your machine and run it:

python voice/play-tts-into-call.py

Prerequisites

gem install sinatra sinatra-contrib

Write the code

Add the following to play-text-to-speech-into-a-call.rb:

View full source

Run your code

Save this file to your machine and run it:

ruby play-text-to-speech-into-a-call.rb

Try it out

When you run the code, a text-to-speech message is played into the call identified with the specified UUID.

Play text-to-speech into a call

Example

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

Try it out

Further Reading