Moderated Conference

Latest Legacy

A caller may join a conference room “My Room” and hear wait music, but the conference doesn’t start until the moderator joins the conference.

If the moderator sets endConferenceOnExit to true, then when the moderator hangs up, the conference will end and each participant will also exit the conference.

Response

<Response>
	<Conference startConferenceOnEnter="false" waitSound="https://<yourdomain>.com/waitmusic/">My Room</Conference>
</Response>

XML for the moderator:

<Response>
	<Conference startConferenceOnEnter="true" endConferenceOnExit="true">My Room</Conference>
</Response>

Example Request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
from plivo import plivoxml

response = plivoxml.ResponseElement()
response.add(
    plivoxml.ConferenceElement(
        'My Room',
        start_conference_on_enter=False,
        wait_sound='https://<yourdomain>.com/waitmusic/'))

print(response.to_string())

# Next, XML for moderator with endConferenceOnExit set to true

moderator_response = plivoxml.ResponseElement()
moderator_response.add(
    plivoxml.ConferenceElement(
        'My Room', start_conference_on_enter=True, end_conference_on_exit=
        True))

print(moderator_response.to_string())

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
require 'rubygems'
require 'plivo'

include Plivo::XML
include Plivo::Exceptions

begin
  response = Response.new

  params = {
    'startConferenceOnEnter' => "false",
    'waitSound' => "https://<yourdomain>.com/waitmusic/"
  }

  conference_name = "My Room"
  response.addConference(conference_name, params)

  xml = PlivoXML.new(response)
  puts xml.to_xml
rescue PlivoXMLError => e
  puts 'Exception: ' + e.message
end

begin
  response = Response.new

  params = {
    'startConferenceOnEnter' => "true",
    'endConferenceOnExit' => "true"
  }

  conference_name = "My Room"
  response.addConference(conference_name, params)

  xml = PlivoXML.new(response)
  puts xml.to_xml
rescue PlivoXMLError => e
  puts 'Exception: ' + e.message
end

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
var plivo = require('plivo');

var response = plivo.Response();

var params = {
    'startConferenceOnEnter': "false",
    'waitSound': "https://<yourdomain>.com/waitMusic/"
};
var conference_name = "My Room";
response.addConference(conference_name, params);

console.log(response.toXML());

/*
Sample Output
<Response>
    <Conference startConferenceOnEnter="false" waitSound="https://<yourdomain>.com/waitMusic/">My Room</Conference>
</Response>
*/


/* Code to generate XML to be returned from url at waitSound */
var plivo = require('plivo');

var response = plivo.Response();

var params = {
    'startConferenceOnEnter': "true",
    'endConferenceOnExit': "true"
};
var conference_name = "My Room";
response.addConference(conference_name, params);

console.log(response.toXML());

/*
Sample Output
<Response>
    <Conference startConferenceOnEnter="true" endConferenceOnExit="true">My Room</Conference>
</Response>
*/

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<?php
    require '../vendor/autoload.php';
    use Plivo\XML\Response;

    $response = new Response();

    $params = array(
        'startConferenceOnEnter' => "false",
        'waitSound' => "https://<yourdomain>.com/waitmusic/"
    );

    $conference_name = "My Room";
    $response->addConference($conference_name, $params);

    Header('Content-type: text/xml');
    echo($response->toXML());

    /*
    Sample Output

    <Response>
        <Conference startConferenceOnEnter="false" waitSound="https://<yourdomain>.com/waitmusic/">My Room</Conference>
    </Response>
    */
?>

<?php
    /*Code to generate XML to be returned from url at waitSound*/

    require '../vendor/autoload.php';
    use Plivo\XML\Response;

    $response = new Response();

    $params = array(
        'startConferenceOnEnter' => "true",
        'endConferenceOnExit' => "true"
    );

    $conference_name = "My Room";
    $response->addConference($conference_name, $params);

    Header('Content-type: text/xml');
    echo($response->toXML());

    /*
    Sample Output

    <Response>
        <Conference startConferenceOnEnter="true" endConferenceOnExit="true">My Room</Conference>
    </Response>
    */
 ?>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// Example for conference - moderated conference
package com.plivo.api.xml.samples.conference;

import com.plivo.api.exceptions.PlivoXmlException;
import com.plivo.api.xml.Conference;
import com.plivo.api.xml.Response;
import com.plivo.api.xml.Speak;


class ModeratedConference {
    public static void main(String[] args) throws PlivoXmlException {
        Response response = new Response()
                .children(


                        new Speak("You will now be placed into a demo conference"),


                        new Conference("demo")
                                .endConferenceOnExit(true)
                                .startConferenceOnEnter(false)
                                .waitSound("https://<yourdomain>.com/waitmusic/")

                );
        System.out.println(response.toXmlString());
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
using System;
using System.Collections.Generic;
using Plivo.XML;

namespace Plivo
{
	class MainClass
	{
		public static void Main(string[] args)
		{
			Plivo.XML.Response resp = new Plivo.XML.Response();
			resp.AddConference("My room", 
               new Dictionary<string, string>()
			{
				{"startConferenceOnEnter", "true"},
				{"endConferenceOnExit", "true"},
				{"waitSound", "https://<yourdomain>.com/waitmusic/"}
			});
			var output = resp.ToString();
			Console.WriteLine(output);

		}
	}
}



//<Response>
//    <Conference startConferenceOnEnter = "true" 
//     endConferenceOnExit="true" 
//     waitSound="https://<yourdomain>.com/waitmusic/">
//         My room
//    </Conference>
//</Response>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Example for conference - moderated conference
package main

import "github.com/plivo/plivo-go/v7/xml"

func main() {
	response := xml.ResponseElement{
		Contents: []interface{}{

			new(xml.SpeakElement).
				SetContents("You will now be placed into a demo conference"),

			new(xml.ConferenceElement).
				SetEndConferenceOnExit(true).
				SetStartConferenceOnEnter(false).
				SetWaitSound("https://<yourdomain>.com/waitmusic/").
				SetContents("demo"),
		},
	}
	print(response.String())
}

Example Request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
from flask import Flask, Response, request
import plivoxml

app=Flask(__name__)

@app.route('/conference/moderated/', methods=['GET','POST'])
def moderated_conference():
	response = plivoxml.Response()
	params = {
	'startConferenceOnEnter' : "false",
	'endConferenceOnExit' : "true",
    'waitSound' : "https://www.foo.com/waitmusic/"
	}
	conference_name = "demo" # Conference Room name
	response.addConference(conference_name, **params)
	return Response(str(response), mimetype='text/xml')



if __name__ == "__main__":
	app.run(host='0.0.0.0', debug=True)

# Sample Conference XML
# <Response>
# 	<Speak>
#		You will now be placed into a demo conference. 
#		This is brought to you by Plivo. 
#		To know more visit us at plivo.com
#	</Speak>
#   <Conference startConferenceOnEnter="false" 
#	endConferenceOnExit="true" 
#	waitSound="https://www.foo.com/waitmusic/">
#		demo
#   </Conference>
# </Response>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
require 'rubygems'
require 'plivo'
include Plivo

response = Response.new()

params = {
    'startConferenceOnEnter' => "false",
    'waitSound' => "https://www.foo.com/waitmusic/"
}

conference_name = "My Room"
response.addConference(conference_name, params)

puts response.to_xml()

=begin
Sample Output
<Response>
    <Conference startConferenceOnEnter='false' waitSound='https://www.foo.com/waitmusic/'>My Room</Conference>
</Response>
=end


=begin
Code to generate XML to be returned from url at waitSound
=end

response = Response.new()

params = {
    'startConferenceOnEnter' => "true",
    'endConferenceOnExit' => "true"
}

conference_name = "My Room"
response.addConference(conference_name, params)

puts response.to_xml()

=begin
Sample Output
<Response>
    <Conference endConferenceOnExit='true' startConferenceOnEnter='true'>My Room</Conference>
</Response>
=end

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
var plivo = require('plivo');

var response = plivo.Response();

var params = {
    'startConferenceOnEnter': "false",
    'waitSound': "https://www.foo.com/waitMusic/"
};
var conference_name = "My Room";
response.addConference(conference_name, params);

console.log(response.toXML());

/*
Sample Output
<Response>
    <Conference startConferenceOnEnter="false" waitSound="https://www.foo.com/waitMusic/">My Room</Conference>
</Response>
*/


/* Code to generate XML to be returned from url at waitSound */
var plivo = require('plivo');

var response = plivo.Response();

var params = {
    'startConferenceOnEnter': "true",
    'endConferenceOnExit': "true"
};
var conference_name = "My Room";
response.addConference(conference_name, params);

console.log(response.toXML());

/*
Sample Output
<Response>
    <Conference startConferenceOnEnter="true" endConferenceOnExit="true">My Room</Conference>
</Response>
*/

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<?php
    require '../vendor/autoload.php';
    use Plivo\Response;

    $response = new Response();

    $params = array(
        'startConferenceOnEnter' => "false",
        'waitSound' => "https://www.foo.com/waitmusic/"
    );

    $conference_name = "My Room";
    $response->addConference($conference_name, $params);

    Header('Content-type: text/xml');
    echo($response->toXML());

    /*
    Sample Output

    <Response>
        <Conference startConferenceOnEnter="false" waitSound="https://www.foo.com/waitmusic/">My Room</Conference>
    </Response>
    */
?>

<?php
    /*Code to generate XML to be returned from url at waitSound*/

    require '../vendor/autoload.php';
    use Plivo\Response;

    $response = new Response();

    $params = array(
        'startConferenceOnEnter' => "true",
        'endConferenceOnExit' => "true"
    );

    $conference_name = "My Room";
    $response->addConference($conference_name, $params);

    Header('Content-type: text/xml');
    echo($response->toXML());

    /*
    Sample Output

    <Response>
        <Conference startConferenceOnEnter="true" endConferenceOnExit="true">My Room</Conference>
    </Response>
    */
 ?>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
import java.io.IOException;

import com.plivo.helper.exception.PlivoException;
import com.plivo.helper.xml.elements.Conference;
import com.plivo.helper.xml.elements.PlivoResponse;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.servlet.ServletContextHandler;
import org.eclipse.jetty.servlet.ServletHolder;

public class moderatedConference extends HttpServlet {
    private static final long serialVersionUID = 1L;    
    @Override
    protected void doGet(HttpServletRequest req, 
        HttpServletResponse resp) 
            throws ServletException, IOException {
        
        PlivoResponse response = new PlivoResponse();
        Conference conference = new Conference("My Room");
        conference.setEnterSound("");
        conference.setStartConferenceOnEnter(true);
        conference.setEndConferenceOnExit(true);
        conference.setWaitSound("https://www.foo.com/music/");
        
        try {
            response.append(conference);
            System.out.println(response.toXML());
            resp.addHeader("Content-Type", "text/xml");
            resp.getWriter().print(response.toXML());;
        } catch (PlivoException e) {
            e.printStackTrace();
        }       
    }

    public static void main(String[] args) throws Exception {
        String port = System.getenv("PORT");
        if(port==null)
            port ="8000";
        Server server = new Server(Integer.valueOf(port));
        ServletContextHandler context = new 
        ServletContextHandler(ServletContextHandler.SESSIONS);
        context.setContextPath("/");
        server.setHandler(context);
        context.addServlet(new ServletHolder(new 
            moderatedConference()),"/conference/moderated");
        server.start();
        server.join();
    }
}

/*
Sample Output
<Response>
    <Conference startConferenceOnEnter="true" 
    enterSound="" 
    waitSound="https://www.foo.com/waitmusic/" 
    endConferenceOnExit="true">My Room</Conference>
</Response>
*/

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
using System;
using System.Collections.Generic;
using Plivo.XML;

namespace Plivo
{
	class MainClass
	{
		public static void Main(string[] args)
		{
			Plivo.XML.Response resp = new Plivo.XML.Response();
			resp.AddConference("My room", 
               new Dictionary<string, string>()
			{
				{"startConferenceOnEnter", "true"},
				{"endConferenceOnExit", "true"},
				{"waitSound", "https://www.foo.com/waitmusic/"}
			});
			var output = resp.ToString();
			Console.WriteLine(output);

		}
	}
}



//<Response>
//    <Conference startConferenceOnEnter = "true" 
//     endConferenceOnExit="true" 
//     waitSound="https://www.foo.com/waitmusic/">
//         My room
//    </Conference>
//</Response>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
    // Example for conference - moderated conference
package main

import "github.com/plivo/plivo-go/v7/xml"

func main() {
	response := xml.ResponseElement{
		Contents: []interface{}{

			new(xml.SpeakElement).
				SetContents("You will now be placed into a demo conference"),

			new(xml.ConferenceElement).
				SetEndConferenceOnExit(true).
				SetStartConferenceOnEnter(false).
				SetWaitSound("https://<yourdomain>.com/waitmusic/").
				SetContents("demo"),
		},
	}
	print(response.String())
}

Rate this page

🥳 Thank you! It means a lot to us!