Mute a call

This building block mutes / unmutes a call.

Example

Replace the following variables in the example code:

Key Description
UUID replace with the UUID of the call to modify.
action the action to use in updating the call. In this case mute or unmute.

Prerequisites

Use your existing application

Modifying an existing call requires that the UUID provided is a currently active call. To modify a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

Write the code

Add the following to mute-a-call.sh:

Copy to Clipboard
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"}'

View full source 

Run your code

Save this file to your machine and run it:

$ bash mute-a-call.sh

Prerequisites

Use your existing application

Modifying an existing call requires that the UUID provided is a currently active call. To modify a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

Install dependencies

$ npm install nexmo dotenv
Initialize your dependencies

Create a file named app.js and add the following code:

Copy to Clipboard
const Nexmo = require('nexmo');

const nexmo = new Nexmo({
  apiKey: NEXMO_API_KEY,
  apiSecret: NEXMO_API_SECRET,
  applicationId: NEXMO_APPLICATION_ID,
  privateKey: NEXMO_PRIVATE_KEY
}, {debug: true});

View full source 

Write the code

Add the following to app.js:

Copy to Clipboard
nexmo.calls.update(CALL_UUID, { action: 'mute' }, (err, res) => {
  if(err) { console.error(err); }
  else {
      console.log(res);
  }
});

function unmute (){
    nexmo.calls.update(CALL_UUID, { action: 'unmute' }, (err, res) => {
        if(err) { console.error(err); }
        else {
            console.log(res);
        }
    });
}

setTimeout(unmute, 5000); // delay 5 seconds

View full source 

Run your code

Save this file to your machine and run it:

$ node app.js

Prerequisites

Use your existing application

Modifying an existing call requires that the UUID provided is a currently active call. To modify a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

Install dependencies

Add the following to build.gradle:

compile 'com.nexmo:client:latest.release'
Initialize your dependencies

Create a file named MuteCall.java and add the following code:

Copy to Clipboard
AuthMethod auth = new JWTAuthMethod(NEXMO_APPLICATION_ID, FileSystems.getDefault().getPath(NEXMO_PRIVATE_KEY));
NexmoClient nexmo = new NexmoClient(auth);

View full source 

Write the code

Add the following to MuteCall.java:

Copy to Clipboard
nexmo.getVoiceClient().modifyCall(UUID, ModifyCallAction.MUTE);
Thread.sleep(3000);
nexmo.getVoiceClient().modifyCall(UUID, ModifyCallAction.UNMUTE);

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.nexmo.quickstart.voice with the package containing MuteCall:

gradle run -Pmain=com.nexmo.quickstart.voice.MuteCall

Prerequisites

Use your existing application

Modifying an existing call requires that the UUID provided is a currently active call. To modify a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

Install dependencies

$ Install-Package Nexmo.Csharp.Client
Initialize your dependencies

Create a file named VoiceController.cs and add the following code:

Copy to Clipboard
var client = new Client(creds: new Nexmo.Api.Request.Credentials
{
    ApiKey = "NEXMO_API_KEY",
    ApiSecret = "NEXMO_API_SECRET",
    ApplicationId = "NEXMO_APPLICATION_ID",
    ApplicationKey = "NEXMO_APPLICATION_PRIVATE_KEY"
});

View full source 

Write the code

Add the following to VoiceController.cs:

Copy to Clipboard
var result = Client.Call.Edit(NEXMO_CALL_UUID, new Call.CallEditCommand
{
    action = "mute"
});

View full source 

Run your code

Save this file to your machine and run it:

$ Run using your IDE

Prerequisites

Use your existing application

Modifying an existing call requires that the UUID provided is a currently active call. To modify a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

Install dependencies

$ composer require nexmo/client
Initialize your dependencies

Create a file named index.php and add the following code:

Copy to Clipboard
$keypair = new \Nexmo\Client\Credentials\Keypair(
    file_get_contents(NEXMO_APPLICATION_PRIVATE_KEY_PATH),
    NEXMO_APPLICATION_ID
);

$client = new \Nexmo\Client($keypair);

View full source 

Write the code

Add the following to index.php:

Copy to Clipboard
$client->calls[UUID]->put(new \Nexmo\Call\Mute());
sleep(3);
$client->calls[UUID]->put(new \Nexmo\Call\Unmute());

View full source 

Run your code

Save this file to your machine and run it:

$ php index.php

Prerequisites

Use your existing application

Modifying an existing call requires that the UUID provided is a currently active call. To modify a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

Install dependencies

$ pip install nexmo
Initialize your dependencies

Create a file named mute-a-call.py and add the following code:

Copy to Clipboard
import nexmo
import time
from pprint import pprint

client = nexmo.Client(
    application_id=APPLICATION_ID,
    private_key=APPLICATION_PRIVATE_KEY_PATH,
)

View full source 

Write the code

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

Copy to Clipboard
response = client.update_call(UUID, action="mute")
pprint(response)
time.sleep(5)
response = client.update_call(UUID, action="unmute")
pprint(response)

View full source 

Run your code

Save this file to your machine and run it:

$ python3 mute-a-call.py

Prerequisites

Use your existing application

Modifying an existing call requires that the UUID provided is a currently active call. To modify a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

Install dependencies

$ gem install nexmo
Initialize your dependencies

Create a file named mute-a-call.rb and add the following code:

Copy to Clipboard
require 'nexmo'

client = Nexmo::Client.new(
    application_id: NEXMO_APPLICATION_ID,
    private_key: File.read(NEXMO_APPLICATION_PRIVATE_KEY_PATH)
)

View full source 

Write the code

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

Copy to Clipboard
client.calls.mute(UUID)

sleep(5)

client.calls.unmute(UUID)

View full source 

Run your code

Save this file to your machine and run it:

$ ruby mute-a-call.rb

Try it out

When you run the code the call is muted or unmuted depending on the action specified.