Conference

The <Conference> represents a single conference originated and terminated from an account.

Conference Resource URI

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

Conference Attributes

Attribute Description

Attribute	Description
Sid	A string that uniquely identifies this conference.
FriendlyName	A user provided string that identifies this conference room.
Status	A string representing the status of the conference. Possible values are RUNNING_MODERATOR_PRESENT, RUNNING_MODERATOR_ABSENT and COMPLETED.
DateCreated	The date that this conference was created.
DateUpdated	The date that this conference was last updated.
AccountSid	The unique id of the Account that created this conference.
ApiVersion	Displays the current API version
Uri	The URI for this account, relative to `\https://$DOMAIN/api/2012-04-24/`.

Sid

A string that uniquely identifies this conference.

FriendlyName

A user provided string that identifies this conference room.

Status

A string representing the status of the conference. Possible values are RUNNING_MODERATOR_PRESENT, RUNNING_MODERATOR_ABSENT and COMPLETED.

DateCreated

The date that this conference was created.

DateUpdated

The date that this conference was last updated.

AccountSid

The unique id of the Account that created this conference.

ApiVersion

Displays the current API version

Uri

The URI for this account, relative to \https://$DOMAIN/api/2012-04-24/.

Get Conference details

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

Example: Get Conference by ConferenceSid

curl -X GET https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACCOUNT_SID/Conferences/(conference_sid).json  \
   -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';

request({
      method: 'GET',
      url: 'https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Conferences/(conference_sid).json',
      auth: { 'user': ACCOUNT_SID, 'pass': AUTH_TOKEN }
   },
   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

# Provide your Account Sid and Auth Token from your Console Account page
ACCOUNT_SID = 'my_ACCOUNT_SID'
AUTH_TOKEN = 'my_AUTH_TOKEN'

userAndPass = b64encode(bytes(ACCOUNT_SID + ':' + AUTH_TOKEN, 'utf-8')).decode("ascii")
headers = { 'Authorization' : 'Basic %s' %  userAndPass }

conn = HTTPSConnection('mycompany.restcomm.com')
conn.request("GET", '/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Conferences/(conference_sid).json',
      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";


   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).json");
      HttpsURLConnection conn = (HttpsURLConnection)url.openConnection();
      conn.setRequestProperty("Authorization", "Basic " + encoded);
      conn.setRequestMethod("GET");

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

HTTP POST Not supported

HTTP PUT Not supported

HTTP DELETE Not supported

Conference Subresources <Participants> represent set/list of in-progress calls in a running conference room.

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

Conference List Resource URI

/2012-04-24/Accounts/\{AccountSid}/Conferences

Supported Operations

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

HTTP POST Not supported

HTTP PUT Not supported

HTTP DELETE Not supported

List Filter

HTTP GET. The following GET query string parameters allow you to limit the list returned. Note, parameters are case-sensitive.

Paging Information

HTTP GET. The following GET query string parameters allow you to limit the list returned. Note, parameters are case-sensitive:

Request Parameters

Parameter	Description
Page	The current page number. Zero-indexed, so the first page is 0.
PageSize	How many items are in each page
Limit	The total number of items in the list.
StartTime	The position in the overall list of the first item in this page.
EndTime	The position in the overall list of the last item in this page.
CallSid	The Call sid of the resource.

Parameter

Description

Page

The current page number. Zero-indexed, so the first page is 0.

PageSize

How many items are in each page

Limit

The total number of items in the list.

StartTime

The position in the overall list of the first item in this page.

EndTime

The position in the overall list of the last item in this page.

CallSid

The Call sid of the resource.

Example.

The command below will return a single item from the list of calls using the PageSize parameter

curl -X GET https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACCOUNT_SID/Conferences.json?PageSize=1  \
   -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';

request({
      method: 'GET',
      url: 'https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Conferences.json?PageSize=1',
      auth: { 'user': ACCOUNT_SID, 'pass': AUTH_TOKEN }
   },
   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

# Provide your Account Sid and Auth Token from your Console Account page
ACCOUNT_SID = 'my_ACCOUNT_SID'
AUTH_TOKEN = 'my_AUTH_TOKEN'

userAndPass = b64encode(bytes(ACCOUNT_SID + ':' + AUTH_TOKEN, 'utf-8')).decode("ascii")
headers = { 'Authorization' : 'Basic %s' %  userAndPass }

conn = HTTPSConnection('mycompany.restcomm.com')
conn.request("GET", '/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Conferences.json?PageSize=1',
      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";


   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.json?PageSize=1");
      HttpsURLConnection conn = (HttpsURLConnection)url.openConnection();
      conn.setRequestProperty("Authorization", "Basic " + encoded);
      conn.setRequestMethod("GET");

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

The result of the PageSize parameter

{
    "page": 0,
    "num_pages": 0,
    "page_size": 1,
    "total": 1,
    "limit": 10000,
    "start": "0",
    "end": "1",
    "uri": "/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Conferences",
    "first_page_uri": "/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Conferences?Page=0&PageSize=1&Limit=10000",
    "previous_page_uri": "null",
    "next_page_uri": "null",
    "last_page_uri": "/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Conferences?Page=0&PageSize=1&Limit=10000",
    "conferences": [{
        "sid": "CF1e4a2e67ada54298a83b93818c0ea1e4",
        "date_created": "Tue, 31 May 2016 16:15:51 +0300",
        "date_updated": "Tue, 31 May 2016 16:19:35 +0300",
        "account_sid": "ACae6e420f425248d6a26948c17a9e2acf",
        "status": "COMPLETED",
        "api_version": "2012-04-24",
        "friendly_name": "1111",
        "uri": "/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Conferences/CF1e4a2e67ada54298a83b93818c0ea1e4.json",
        "subresource_uris": {
            "participants": "/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Conferences/CF1e4a2e67ada54298a83b93818c0ea1e4/Participants.json"
        }
    }]
}

The command below, using Limit parameter will return a list of 500 records in total

curl -X GET https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACCOUNT_SID/Conferences.json?PageSize=1&Limit=500  \
   -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';

request({
      method: 'GET',
      url: 'https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Conferences.json?PageSize=1&Limit=500',
      auth: { 'user': ACCOUNT_SID, 'pass': AUTH_TOKEN }
   },
   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

# Provide your Account Sid and Auth Token from your Console Account page
ACCOUNT_SID = 'my_ACCOUNT_SID'
AUTH_TOKEN = 'my_AUTH_TOKEN'

userAndPass = b64encode(bytes(ACCOUNT_SID + ':' + AUTH_TOKEN, 'utf-8')).decode("ascii")
headers = { 'Authorization' : 'Basic %s' %  userAndPass }

conn = HTTPSConnection('mycompany.restcomm.com')
conn.request("GET", '/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Conferences.json?PageSize=1&Limit=500',
      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";


   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.json?PageSize=1&Limit=500");
      HttpsURLConnection conn = (HttpsURLConnection)url.openConnection();
      conn.setRequestProperty("Authorization", "Basic " + encoded);
      conn.setRequestMethod("GET");

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

The result of the Limit parameter

{
    "page": 0,
    "num_pages": 0,
    "page_size": 1,
    "total": 1,
    "limit": 500,
    "start": "0",
    "end": "1",
    "uri": "/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Conferences",
    "first_page_uri": "/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Conferences?Page=0&PageSize=1&Limit=500",
    "previous_page_uri": "null",
    "next_page_uri": "null",
    "last_page_uri": "/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Conferences?Page=0&PageSize=1&Limit=500",
    "conferences": [{
        "sid": "CF1e4a2e67ada54298a83b93818c0ea1e4",
        "date_created": "Tue, 31 May 2016 16:15:51 +0300",
        "date_updated": "Tue, 31 May 2016 16:19:35 +0300",
        "account_sid": "ACae6e420f425248d6a26948c17a9e2acf",
        "status": "COMPLETED",
        "api_version": "2012-04-24",
        "friendly_name": "1111",
        "uri": "/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Conferences/CF1e4a2e67ada54298a83b93818c0ea1e4.json",
        "subresource_uris": {
            "participants": "/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Conferences/CF1e4a2e67ada54298a83b93818c0ea1e4/Participants.json"
        }
    }]
}

Additional Paging Information

The API returns URIs to the next, previous, first and last pages of the returned list as shown in the table below:

Request Parameters

Parameter	Description
Uri	The URI of the current page.
Firstpageuri	The URI for the first page of this list.
Nextpageuri	The URI for the next page of this list.
Previouspageuri	The URI for the previous page of this list.
Lastpageuri	The URI for the last page of this list.

Parameter

Description

Uri

The URI of the current page.

Firstpageuri

The URI for the first page of this list.

Nextpageuri

The URI for the next page of this list.

Previouspageuri

The URI for the previous page of this list.

Lastpageuri

The URI for the last page of this list.