Earmuff a call

This code snippet earmuffs and unearmuffs a call. When a call is earmuffed, the user cannot hear other participants, but other participants can hear the user.

Prerequisites

Create an Application

You can install the CLI with the following command:

npm install --location=global @vonage/cli

Before you can start working with your apps, you need to register your configuration: API Key and Secret. You can find them via the Dashboard, in API Settings. Once set, initialize your account using the following command:

vonage config:set --apiKey=XXXXXX --apiSecret=XXXXXX

As soon as the CLI is both installed and configured, use it to create a Vonage application using the following command:

vonage apps:create

The command starts an interactive prompt to ask for the application name, and the capabilities you want to enable - make sure to enable Voice.

When finished, it creates the vonage_app.json file in the current directory containing the Application ID, Application name and private key. It also creates a second file with the private key name app_name.key.

Go to the Application's page on the Dashboard, and define a Name for your Application.

Make sure to click on the Generate public and private key button, and keep the file private.key around.

Then, enable the Voice capability. For the moment, leave everything by default.

An example of enabling Voice capabilities

Finally, click Save at the bottom of the page.

Rent a Number

You can rent a number using the Vonage CLI. The following command purchases an available number in the United States:

vonage numbers:search USvonage numbers:buy 15555555555 US

Specify an alternative two-character country code to purchase a number in another country.

Link a Number

Now that you have both an application and a number, you need to link them together.

Replace YOUR_VONAGE_NUMBER with the number you bought and APPLICATION_ID with your application id, then run the following command:

vonage apps:link APPLICATION_ID --number=YOUR_VONAGE_NUMBER

Example

Replace the following variables in the example code:

Key	Description
`UUID`	The UUID of the call leg.

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 earmuff-a-call.sh:

curl -X PUT https://api.nexmo.com/v1/calls/$UUID \
  -H "Authorization: Bearer $JWT"\
  -H "Content-Type: application/json"\
  -d '{"action": "earmuff"}'

sleep 5s

curl -X PUT https://api.nexmo.com/v1/calls/$UUID \
  -H "Authorization: Bearer $JWT"\
  -H "Content-Type: application/json"\
  -d '{"action": "unearmuff"}'

View full source

Run your code

Save this file to your machine and run it:

bash earmuff-a-call.sh

Prerequisites

npm install @vonage/server-sdk

Create a file named earmuff-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 earmuff-a-call.js:

vonage.voice.earmuffCall(UUID)
  .then(() => console.log('Call earmuffed'))
  .catch((error) => console.error(error));

const unearmuff = () => {
  vonage.voice.unearmuffCall(UUID)
    .then(() => console.log('Unearmuffed call'))
    .catch((error) => console.error(error));
};

setTimeout(unearmuff, 3000); // delay 3 seconds

View full source

Run your code

Save this file to your machine and run it:

node earmuff-a-call.js

Prerequisites

Add the following to build.gradle:

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

Create a file named EarmuffCall and add the following code to the main method:

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

View full source

Write the code

Add the following to the main method of the EarmuffCall file:

val call = client.voice.call(CALL_UUID)
call.earmuff()
Thread.sleep(3000)
call.unearmuff()

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 EarmuffCall:

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

Prerequisites

Add the following to build.gradle:

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

Write the code

Add the following to the main method of the EarmuffCall file:

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

client.getVoiceClient().earmuffCall(CALL_UUID);
Thread.sleep(3000);
client.getVoiceClient().unearmuffCall(CALL_UUID);

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 EarmuffCall:

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

Prerequisites

Install-Package Vonage

Write the code

Add the following to EarmuffCall.cs:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(vonageApplicationId, vonagePrivateKeyPath);
var client = new VonageClient(credentials);

var command = new CallEditCommand() { Action = CallEditCommand.ActionType.earmuff };
var response = await client.VoiceClient.UpdateCallAsync(uuid, command);

Console.WriteLine($"Earmuff Call Command succeeded: {response}");

Thread.Sleep(3000);

command = new CallEditCommand() { Action = CallEditCommand.ActionType.unearmuff };
response = await client.VoiceClient.UpdateCallAsync(uuid, command);

View full source

Prerequisites

composer require vonage/client

Write the code

Add the following to index.php:

require_once __DIR__ . '/../../vendor/autoload.php';

$keypair = new \Vonage\Client\Credentials\Keypair(file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH), VONAGE_APPLICATION_ID);
$client = new \Vonage\Client($keypair);

$client->voice()->earmuffCall(UUID);
sleep(3);
$client->voice()->unearmuffCall(UUID);

View full source

Run your code

Save this file to your machine and run it:

php index.php

Prerequisites

pip install vonage

Write the code

Add the following to earmuff-a-call.py:

client = vonage.Client(
    application_id=VONAGE_APPLICATION_ID,
    private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
)

response = client.voice.update_call(UUID, action="earmuff")
pprint(response)
time.sleep(5)
response = client.voice.update_call(UUID, action="unearmuff")
pprint(response)

View full source

Run your code

Save this file to your machine and run it:

python earmuff-a-call.py

Prerequisites

gem install vonage

Write the code

Add the following to earmuff-a-call.rb:

client = Vonage::Client.new(
  application_id: VONAGE_APPLICATION_ID,
  private_key: File.read(VONAGE_APPLICATION_PRIVATE_KEY_PATH)
)

client.voice.earmuff(UUID)

sleep(5)

View full source

Run your code

Save this file to your machine and run it:

ruby earmuff-a-call.rb

Try it out

When you run the code the call identified by UUID will be earmuffed or unearmuffed.

Earmuff a call

Prerequisites

Create an Application

Rent a Number

Link a Number

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