Mute a call

This code snippet 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.
  • cURL
  • Node.js
  • Java
  • .NET
  • PHP
  • Python
  • Ruby

    • 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.

    Generate your JWT

    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:

    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
    Initialize your dependencies

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

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

function unmute (){
    nexmo.calls.update(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 mute-a-call.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:5.2.1'
    Initialize your dependencies

    Create a class named MuteCall and add the following code to the main method:

    Copy to Clipboard 
    NexmoClient client = NexmoClient.builder()
        .applicationId(NEXMO_APPLICATION_ID)
        .privateKeyPath(NEXMO_PRIVATE_KEY_PATH)
        .build();

    View full source

    Write the code

    Add the following to the main method of the MuteCall class:

    Copy to Clipboard 
    client.getVoiceClient().modifyCall(UUID, ModifyCallAction.MUTE);
Thread.sleep(3000);
client.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
    Import dependencies

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

    Copy to Clipboard 
    using Nexmo.Api;
using Nexmo.Api.Request;
using Nexmo.Api.Voice;

    View full source

    Initialize your dependencies

    Add the following to MuteCall.cs:

    Copy to Clipboard 
    var credentials = Credentials.FromAppIdAndPrivateKeyPath(NEXMO_APPLICATION_ID, NEXMO_PRIVATE_KEY_PATH);
var client = new NexmoClient(credentials);

    View full source

    Write the code

    Add the following to MuteCall.cs:

    Copy to Clipboard 
    var command = new CallEditCommand() { Action = CallEditCommand.ActionType.mute };
var response = client.VoiceClient.UpdateCall(UUID, command);

    View full source

    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 
    
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.voice.mute(UUID)

sleep(5)

    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.