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.

Example

Replace the following variables in the example code:

Key	Description
`VOICE_CALL_ID`	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/$VOICE_CALL_ID \
  -H "Authorization: Bearer $JWT"\
  -H "Content-Type: application/json"\
  -d '{"action": "earmuff"}'

sleep 5s

curl -X PUT https://api.nexmo.com/v1/calls/$VOICE_CALL_ID \
  -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(VOICE_CALL_ID)
  .then(() => console.log('Call earmuffed'))
  .catch((error) => console.error(error));

const unearmuff = () => {
  vonage.voice.unearmuffCall(VOICE_CALL_ID)
    .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:2.1.1'

Create a class named EarmuffCall 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 EarmuffCall class:

val call = client.voice.call(VOICE_CALL_ID)
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:9.3.1'

Create a class named EarmuffCall 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 EarmuffCall class:

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

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(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var client = new VonageClient(credentials);

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

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

Thread.Sleep(3000);

command = new CallEditCommand() { Action = CallEditCommand.ActionType.unearmuff };
response = await client.VoiceClient.UpdateCallAsync(VOICE_CALL_ID, 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 python-dotenv

Write the code

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

from vonage import Auth, Vonage

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

client.voice.earmuff(VOICE_CALL_ID)
sleep(3)
client.voice.unearmuff(VOICE_CALL_ID)

View full source

Run your code

Save this file to your machine and run it:

python voice/earmuff-a-call.py

Prerequisites

gem install vonage

Write the code

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

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

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