On this page

TwiML™ Voice: <Room>

(warning)

Warning

This documentation is for reference only. We are no longer onboarding new customers to Programmable Video. For additional information see here.

(warning)

Warning

This TwiML Verb is not currently available when using Twilio Regions Ireland (IE1) or Australia (AU1). This is currently only supported with the default US1 region. A full list of unsupported products and features with Twilio Regions is documented here.

Programmable Video Rooms are represented in TwiML through the <Room> noun, which you can specify while using the <Connect> verb.

The <Room> noun allows you to connect to a named Programmable Video Room and talk with other participants who are connected to that Room.

Note that only Group Rooms support PSTN Participants.

To connect a Programmable Voice call to a Room, use the <Room> noun and provide the UniqueName for the Room you would like to connect to. If an in-progress Video Room with that unique name does not exist for your account, Twilio will move to the next set of TwiML instructions you have provided, or disconnect the call if the <Room> is the final TwiML instruction.

<Room> and <Connect> usage examples

1<?xml version="1.0" encoding="UTF-8"?>
2<Response>
3  <Connect>
4    <Room>DailyStandup</Room>
5  </Connect>
6</Response>

(warning)

Warning

Ensure, your room type is group. Connecting voice calls to a Peer-to-Peer Room is not possible.

Connect a Programmable Voice call to a Room

1const VoiceResponse = require('twilio').twiml.VoiceResponse;
2
3const response = new VoiceResponse();
4const connect = response.connect();
5connect.room('DailyStandup');
6
7console.log(response.toString());

Output

1<?xml version="1.0" encoding="UTF-8"?>
2<Response>
3  <Connect>
4    <Room>DailyStandup</Room>
5  </Connect>
6</Response>

Set the Participant's identity

You can set a unique identity on the incoming caller using an optional property called participantIdentity.

If you don't set the participantIdentity, then Twilio will assign a unique string value to the Participant's identity.

1<?xml version="1.0" encoding="UTF-8"?>
2<Response>
3  <Connect>
4    <Room participantIdentity='alice'>DailyStandup</Room>
5  </Connect>
6</Response>

Connect a Programmable Voice call to a Room with a unique participant identity

1const VoiceResponse = require('twilio').twiml.VoiceResponse;
2
3const response = new VoiceResponse();
4const connect = response.connect();
5connect.room({
6    participantIdentity: 'alice'
7}, 'DailyStandup');
8
9console.log(response.toString());

Output

1<?xml version="1.0" encoding="UTF-8"?>
2<Response>
3  <Connect>
4    <Room participantIdentity="alice">DailyStandup</Room>
5  </Connect>
6</Response>

Visit the Programmable Video documentation for more information about adding PSTN participants to Video Rooms.