Mute a call
This code snippet mutes / unmutes a call.
Prerequisites
Create an Application
You can install the CLI with the following command:
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:
As soon as the CLI is both installed and configured, use it to create a Vonage application using the following command:
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.
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:
Specify an alternative two-character country code to purchase a number in another country.
In the Dashboard, go to the Buy Numbers page. Make sure to tick Voice in the search filter, and select the country you want to buy a number in.
You can then click the Buy button next to the number you want, and validate your purchase.
Congratulations! Your virtual number is now listed in Your Numbers
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:
Now that you have both an application and a number, you need to link them together.
Go to the Application page, and click on the application you created earlier.
In the Voice section, click on the Link button next to the number you want to link.
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 mute-a-call.sh:
curl -X PUT https://api.nexmo.com/v1/calls/$UUID \
-H "Authorization: Bearer $JWT"\
-H "Content-Type: application/json"\
-d '{"action": "mute"}'
sleep 5s
curl -X PUT https://api.nexmo.com/v1/calls/$UUID \
-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(UUID)
.then(() => console.log('Call Muted'))
.catch((error) => console.error(error));
const unmute = () => {
vonage.voice.unmuteCall(UUID)
.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:
implementation 'com.vonage:server-sdk-kotlin:1.1.2'Create a file named MuteCall and add the following code to the main method:
val client = Vonage {
applicationId(VONAGE_APPLICATION_ID)
privateKeyPath(VONAGE_APPLICATION_PRIVATE_KEY_PATH)
}Write the code
Add the following to the main method of the MuteCall file:
val call = client.voice.call(CALL_UUID)
call.mute()
Thread.sleep(3000)
call.unmute()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 MuteCall:
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 MuteCall file:
VonageClient client = VonageClient.builder()
.applicationId(VONAGE_APPLICATION_ID)
.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
.build();
client.getVoiceClient().muteCall(CALL_UUID);
Thread.sleep(3000);
client.getVoiceClient().unmuteCall(CALL_UUID);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 MuteCall:
Prerequisites
Install-Package VonageWrite the code
Add the following to MuteCall.cs:
var credentials = Credentials.FromAppIdAndPrivateKeyPath(vonageApplicationId, vonagePrivateKeyPath);
var client = new VonageClient(credentials);
var command = new CallEditCommand() { Action = CallEditCommand.ActionType.mute };
var response = await client.VoiceClient.UpdateCallAsync(uuid, command);
Console.WriteLine($"Mute Call Command succeeded: {response}");
Thread.Sleep(5000);
command = new CallEditCommand() { Action = CallEditCommand.ActionType.unmute };
response = await client.VoiceClient.UpdateCallAsync(uuid, command);Prerequisites
composer require vonage/clientRun your code
Save this file to your machine and run it:
Prerequisites
pip install vonageWrite the code
Add the following to mute-a-call.py:
from vonage import Auth, Vonage
client = Vonage(
Auth(
application_id=VONAGE_APPLICATION_ID,
private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
)
)
client.voice.mute(CALL_UUID)
sleep(5)
client.voice.unmute(CALL_UUID)Run your code
Save this file to your machine and run it:
Prerequisites
gem install vonageWrite the code
Add the following to mute-a-call.rb:
client = Vonage::Client.new(
application_id: VONAGE_APPLICATION_ID,
private_key: File.read(VONAGE_APPLICATION_PRIVATE_KEY_PATH)
)
client.voice.mute(UUID)
sleep(5)
Run 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.