Reference Solutions Tutorials Visual Designer
    • REST API
      • Overview
        • API Endpoint
        • Authentication
        • Requests
        • Responses
        • Paging
      • Voice
        • Available Phone Numbers
        • Calls
          • Call List Resource URI
          • Making a Call
          • Modifying Live Calls
          • Examples
          • List Filter
          • Paging Information
        • Clients
          • Create a Client
          • Delete a Client
          • Change Client’s Password
          • Get a List of Available Clients
        • Conference Management
          • Supported Operations
          • Conference List Resource URI
        • Conference Participants Management
          • Participants List Resource URI
        • Incoming Phone Numbers
          • IncomingPhoneNumber Instance Resource
          • IncomingPhoneNumbers List Resource
          • Local IncomingPhoneNumber Factory Resource
          • Toll-Free IncomingPhoneNumber Factory Resource
          • Mobile IncomingPhoneNumber Factory Resource
          • Attach a phone number to an application
          • Delete a phone number
          • List of Phone Numbers
          • Incoming Phone Number Regex Support
        • Recordings
        • SIP Refer Support
      • SMS
        • Available Phone Numbers
        • Clients
          • Create a Client
          • Delete a Client
          • Change Client’s Password
          • Get a List of Available Clients
        • Incoming Phone Numbers
          • IncomingPhoneNumber Instance Resource
          • IncomingPhoneNumbers List Resource
          • Local IncomingPhoneNumber Factory Resource
          • Toll-Free IncomingPhoneNumber Factory Resource
          • Mobile IncomingPhoneNumber Factory Resource
          • Attach a phone number to an application
          • Delete a phone number
          • List of Phone Numbers
          • Incoming Phone Number Regex Support
        • Messages
          • Send SMS
          • Get SMS List
          • Get single SMS Information
          • SMS Attributes
        • Email
      • Accounts
      • Applications
      • Notifications
      • Usage Records
    • RCML
      • Overview
        • How wlparam:replace[textMode="sps",parmText="application_name",text="Restcomm",defaultText="$INFER_FROM_DOMAIN"
        • RCML Verbs
      • Dial
        • Client
        • Conference
        • Number
        • SIP
      • Email
      • Gather
      • Say
      • Play
      • SMS
      • Hangup
      • Pause
      • Redirect
      • Record
      • Reject
    • Solution APIs
      • Two-Factor Authentication (2FA)
docs 1.0
  • docs
    • 1.0
  • docs
  • Enterprise:REST API
  • Enterprise:Voice
  • Enterprise:Conference Participants Management

Participants

Participants

A Participant represents a single participant currently connected to a running conference. It is idefiable by its CallSid.

Participant Resource URI

/2012-04-24/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}

Resource Properties

Property Description

CallSid

A string that uniquely identifies this particpant.

ConferenceSid

A string that uniquely identifies the conference this particpant is currently connected in.

DateCreated

The date that this particpant was created.

DateUpdated

The date that this particpant was last updated.

AccountSid

The unique id of the Account that created this call.

Muted

Represents the flag if particpant is currently muted or not (true or false)?

StartConferenceOnEnter

Represents if StartConferenceOnEnter flag was set for this particpant (true or false)?

EndConferenceOnExit

Represents if EndConferenceOnExit flag was set for this particpant (true or false)?

Uri

The URI for this account, relative to https://$DOMAIN/restcomm.

Supported Operations

HTTP GET. Returns the representation of a Participant resource, including the properties above.

HTTP POST to a Participant to mute/unmute a live Participant, we make an HTTP POST request to a live Participant instance resource URI:

/2012-04-24/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}

or

/2012-04-24/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json

The following parameters are available for you to POST request.:

Request Parameters

Parameter Description

Mute

Either true or flase. Setting value of this parameter to true will mute the call. Setting value of this parameter to false will unmute the call.

HTTP PUT. Not supported

HTTP DELETE. Not supported

Participant List Resource URI

/2012-04-24/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants

Supported Operations

HTTP GET. Returns the list representation of all the Participant resources for this Account, including the properties above.

HTTP POST Not supported

HTTP PUT. Not supported

HTTP DELETE. Not supported

Examples

You can Mute/unMute an inprogress call as shown bellow.

curl -X POST https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACCOUNT_SID/Conferences/CONFERENCE_SID/Participants/CALL_SID.xml  \
   -d 'Mute=true' \
   -u 'YourAccountSid:YourAuthToken'
const request = require('request');

// Provide your Account Sid and Auth Token from your Console Account page
const ACCOUNT_SID = 'my_ACCOUNT_SID';
const AUTH_TOKEN = 'my_AUTH_TOKEN';
// Provide additional path parameters if applicable
const CONFERENCE_SID = 'my_CONFERENCE_SID'
const CALL_SID = 'my_CALL_SID'

request.({
      method: 'POST',
      url: 'https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Conferences/' + CONFERENCE_SID + '/Participants/' + CALL_SID + '.xml',
      auth: { 'user': ACCOUNT_SID, 'pass': AUTH_TOKEN },
      form: {
         'Mute': 'true'
      }
   },
   function (error, response, body) {
      // Add your business logic below; status can be found at 'response.statusCode' and response body at 'body'
      ...
});
from http.client import HTTPSConnection
from base64 import b64encode
from urllib.parse import urlencode

# Provide your Account Sid and Auth Token from your Console Account page
ACCOUNT_SID = 'my_ACCOUNT_SID'
AUTH_TOKEN = 'my_AUTH_TOKEN'
// Provide additional path parameters if applicable
CONFERENCE_SID = 'my_CONFERENCE_SID'
CALL_SID = 'my_CALL_SID'

userAndPass = b64encode(bytes(ACCOUNT_SID + ':' + AUTH_TOKEN, 'utf-8')).decode("ascii")
headers = { 'Authorization' : 'Basic %s' %  userAndPass,
    'Content-type': 'application/x-www-form-urlencoded',
    'Accept': 'text/plain' }

# Update POST parameters accordingly
params = urlencode({
   'Mute': 'true'
})

conn = HTTPSConnection('mycompany.restcomm.com')
conn.request("POST", '/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Conferences/' + CONFERENCE_SID + '/Participants/' + CALL_SID + '.xml',
      params, headers=headers)
res = conn.getresponse()

# Add your business logic below; status can be found at 'res.status', reason at 'res.reason' and response body can be retrieved with res.read()
...
import java.net.URL;
import javax.net.ssl.HttpsURLConnection;
import java.io.*;
import java.util.Base64;

public class JavaSampleClass {
   // Provide your Account Sid and Auth Token from your Console Account page
   public static final String ACCOUNT_SID = "my_ACCOUNT_SID";
   public static final String AUTH_TOKEN = "my_AUTH_TOKEN";
   // Provide additional path parameters if applicable
   public static final String CONFERENCE_SID = "my_CONFERENCE_SID"
   public static final String CALL_SID = "my_CALL_SID"

   public static void main(String[] args) throws Exception {
      String userAndPass = ACCOUNT_SID + ':' + AUTH_TOKEN;
      String encoded = Base64.getEncoder().encodeToString(userAndPass.getBytes());

      URL url = new URL(("https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/" + ACCOUNT_SID + "/Conferences/" + CONFERENCE_SID + "/Participants/" + CALL_SID + ".xml");
      HttpsURLConnection conn = (HttpsURLConnection)url.openConnection();
      conn.setRequestProperty("Authorization", "Basic " + encoded);
      conn.setRequestMethod("POST");
      conn.setDoOutput(true);
      DataOutputStream os = new DataOutputStream(conn.getOutputStream());

      // Update POST parameters accordingly
      os.writeBytes("Mute=true");
      os.close();

      // Add your business logic below; response code can be obtained from 'conn.getResponseCode()' and input stream from 'conn.getInputStream()'
      ...
  }
}

Sample Mute Response

<RestcommResponse>
  <Call>
    <Sid>CA02b649d3ffe24408a1e141be089f347b</Sid>
    <ConferenceSid>CFcc373b0637114f088eae954fa73f0f57</ConferenceSid>
    <DateCreated>Wed, 15 Mar 2017 10:10:57 +0000</DateCreated>
    <DateUpdated>Wed, 15 Mar 2017 10:15:33 +0000</DateUpdated>
    <AccountSid>ACae6e420f425248d6a26948c17a9e2acf</AccountSid>
    <Muted>true</Muted>
    <Hold>false</Hold>
    <StartConferenceOnEnter>true</StartConferenceOnEnter>
    <EndConferenceOnEnter>false</EndConferenceOnEnter>
    <Uri>/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Calls/CA02b649d3ffe24408a1e141be089f347b</Uri>
  </Call>
</RestcommResponse>
curl -X POST https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACCOUNT_SID/Conferences/CONFERENCE_SID/Participants/CALL_SID.xml  \
   -d 'Mute=false' \
   -u 'YourAccountSid:YourAuthToken'
const request = require('request');

// Provide your Account Sid and Auth Token from your Console Account page
const ACCOUNT_SID = 'my_ACCOUNT_SID';
const AUTH_TOKEN = 'my_AUTH_TOKEN';
// Provide additional path parameters if applicable
const CONFERENCE_SID = 'my_CONFERENCE_SID'
const CALL_SID = 'my_CALL_SID'

request.({
      method: 'POST',
      url: 'https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Conferences/' + CONFERENCE_SID + '/Participants/' + CALL_SID + '.xml',
      auth: { 'user': ACCOUNT_SID, 'pass': AUTH_TOKEN },
      form: {
         'Mute': 'false'
      }
   },
   function (error, response, body) {
      // Add your business logic below; status can be found at 'response.statusCode' and response body at 'body'
      ...
});
from http.client import HTTPSConnection
from base64 import b64encode
from urllib.parse import urlencode

# Provide your Account Sid and Auth Token from your Console Account page
ACCOUNT_SID = 'my_ACCOUNT_SID'
AUTH_TOKEN = 'my_AUTH_TOKEN'
// Provide additional path parameters if applicable
CONFERENCE_SID = 'my_CONFERENCE_SID'
CALL_SID = 'my_CALL_SID'

userAndPass = b64encode(bytes(ACCOUNT_SID + ':' + AUTH_TOKEN, 'utf-8')).decode("ascii")
headers = { 'Authorization' : 'Basic %s' %  userAndPass,
    'Content-type': 'application/x-www-form-urlencoded',
    'Accept': 'text/plain' }

# Update POST parameters accordingly
params = urlencode({
   'Mute': 'false'
})

conn = HTTPSConnection('mycompany.restcomm.com')
conn.request("POST", '/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Conferences/' + CONFERENCE_SID + '/Participants/' + CALL_SID + '.xml',
      params, headers=headers)
res = conn.getresponse()

# Add your business logic below; status can be found at 'res.status', reason at 'res.reason' and response body can be retrieved with res.read()
...
import java.net.URL;
import javax.net.ssl.HttpsURLConnection;
import java.io.*;
import java.util.Base64;

public class JavaSampleClass {
   // Provide your Account Sid and Auth Token from your Console Account page
   public static final String ACCOUNT_SID = "my_ACCOUNT_SID";
   public static final String AUTH_TOKEN = "my_AUTH_TOKEN";
   // Provide additional path parameters if applicable
   public static final String CONFERENCE_SID = "my_CONFERENCE_SID"
   public static final String CALL_SID = "my_CALL_SID"

   public static void main(String[] args) throws Exception {
      String userAndPass = ACCOUNT_SID + ':' + AUTH_TOKEN;
      String encoded = Base64.getEncoder().encodeToString(userAndPass.getBytes());

      URL url = new URL(("https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/" + ACCOUNT_SID + "/Conferences/" + CONFERENCE_SID + "/Participants/" + CALL_SID + ".xml");
      HttpsURLConnection conn = (HttpsURLConnection)url.openConnection();
      conn.setRequestProperty("Authorization", "Basic " + encoded);
      conn.setRequestMethod("POST");
      conn.setDoOutput(true);
      DataOutputStream os = new DataOutputStream(conn.getOutputStream());

      // Update POST parameters accordingly
      os.writeBytes("Mute=false");
      os.close();

      // Add your business logic below; response code can be obtained from 'conn.getResponseCode()' and input stream from 'conn.getInputStream()'
      ...
  }
}

Sample unMute Response

<RestcommResponse>
  <Call>
    <Sid>CA02b649d3ffe24408a1e141be089f347b</Sid>
    <ConferenceSid>CFcc373b0637114f088eae954fa73f0f57</ConferenceSid>
    <DateCreated>Wed, 15 Mar 2017 10:10:57 +0000</DateCreated>
    <DateUpdated>Wed, 15 Mar 2017 10:16:44 +0000</DateUpdated>
    <AccountSid>ACae6e420f425248d6a26948c17a9e2acf</AccountSid>
    <Muted>false</Muted>
    <Hold>false</Hold>
    <StartConferenceOnEnter>true</StartConferenceOnEnter>
    <EndConferenceOnEnter>false</EndConferenceOnEnter>
    <Uri>/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Calls/CA02b649d3ffe24408a1e141be089f347b</Uri>
  </Call>
</RestcommResponse>
Products

Programmable Voice

Programmable SMS

Use Cases

Two-Factor Authentication (2FA)

Phone Number Masking

Voicemail to Email Application

Learn

Terms And Conditions

Contact us

Telestax