Mute a call
This code snippet mutes / unmutes a call.
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 mute-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": "mute"}'
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": "unmute"}'Run your code
Save this file to your machine and run it:
Prerequisites
npm install @vonage/server-sdkCreate a file named mute-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,
});Write the code
Add the following to mute-a-call.js:
vonage.voice.muteCall(VOICE_CALL_ID)
.then(() => console.log('Call Muted'))
.catch((error) => console.error(error));
const unmute = () => {
vonage.voice.unmuteCall(VOICE_CALL_ID)
.then(() => console.log('Unmuted Call'))
.catch((error) => console.error(error));
};
setTimeout(unmute, 5000); // delay 5 secondsRun your code
Save this file to your machine and run it:
Prerequisites
Add the following to build.gradle:
Create a file named MuteCall and add the following code to the main method:
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:
Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.voice with the package containing MuteCall:
Prerequisites
Add the following to build.gradle:
Create a file named MuteCall and add the following code to the main method:
VonageClient client = VonageClient.builder()
.applicationId(VONAGE_APPLICATION_ID)
.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
.build();Write the code
Add the following to the main method of the MuteCall file:
client.getVoiceClient().muteCall(VOICE_CALL_ID);
Thread.sleep(3000);
client.getVoiceClient().unmuteCall(VOICE_CALL_ID);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:
Run the following gradle command to execute your application, replacing com.vonage.quickstart.voice with the package containing MuteCall:
Prerequisites
Install-Package VonagePrerequisites
composer require vonage/clientWrite 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()->muteCall(UUID);
sleep(3);
$client->voice()->unmuteCall(UUID);Run your code
Save this file to your machine and run it:
Prerequisites
pip install vonage python-dotenvRun your code
Save this file to your machine and run it:
Prerequisites
gem install vonageRun your code
Save this file to your machine and run it:
Try it out
When you run the code the call is muted or unmuted depending on the action specified.
Further Reading
- Conference Calling - This guide explains the two concepts Vonage associates with a call, a leg and a conversation.