Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

TwiML™ Voice: <Connect>

<Connect> is a TwiML verb that instructs Twilio to connect a phone call to Autopilot or a Programmable Video Room. The phone call can be over PSTN or SIP.

Connect Nouns

The nouns that you can nest inside of <Connect> are:

Noun Description
<Autopilot>

Describes an Autopilot assistant. Connects the active caller to an Autopilot assistant.

See the Autopilot doumentation for a walkthrough of how to use Autopilot to build intelligent assistants and conversational IVRs.

<Room> A nested XML element that describes a Programmable Video Room to connect to with some attributes.

Autopilot

Autopilot assistants are represented in TwiML through a new noun, <Autopilot>. The <Autopilot> noun allows you to connect to a named Autopilot intelligent assistant and talk with other participants who have also connected to that Room.

To connect a Programmable Voice call to Autopilot, use the <Autopilot> noun with the AssistantSid for the Autopilot assistant:

<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Connect>
    <Autopilot>UAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</Autopilot>
  </Connect>
</Response>
        
        
        
        
        Connect a Programmable Voice call to an Autopilot Assistant

        Connect a Call to a Autopilot

        Connect a Programmable Voice call to an Autopilot Assistant

        Room

        Programmable Video Rooms are represented in TwiML through a new noun, <Room>. The <Room> noun allows you to connect to a named video conference Room and talk with other participants who have also connected to that Room.

        To connect a Programmable Voice call to a Room, use the <Room> noun with the UniqueName for the Room:

        <?xml version="1.0" encoding="UTF-8"?>
        <Response>
          <Connect>
            <Room>DailyStandup</Room>
          </Connect>
        </Response>
        
              
              
              
              
              Connect a Programmable Voice call to a named Programmable Video Room

              Connect a Call to a Room

              Connect a Programmable Voice call to a named Programmable Video Room

              To connect a Programmable Voice call to a Room, use the <Room> noun with the UniqueName for the Room.

              You may choose the name of the Room. It is namespaced to your account only.

              Note: Ensure, your room type is 'group' or 'group-small'. Connecting voice calls to a 'peer-to-peer' Room is NOT possible.

              Connect to a Room

              When an incoming phone call is made to a Twilio Phone Number, a developer can connect the call to a Twilio Video Room.

              Room and Connect Usage

              <?xml version="1.0" encoding="UTF-8"?>
              <Response>
                <Connect>
                  <Room>DailyStandup</Room>
                </Connect>
              </Response>
              

              Setting the participantIdentity

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

              <?xml version="1.0" encoding="UTF-8"?>
              <Response>
                <Connect>
                  <Room participantIdentity='alice'>DailyStandup</Room>
                </Connect>
              </Response>
              

              Note: If you don't set the participantIdentity, then Twilio will set a unique value as the Participant identity.

              Rate this page:

              Need some help?

              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.