Menu

Expand
Rate this page:

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.

<Stream>

Begins a bi-directional MediaStream for the active call.

<VirtualAgent>

Connects a Programmable Voice call to a Dialogflow Essentials (ES) agent.

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.

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.

              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>

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

              Stream

              MediaStreams are represented in TwiML with the noun <Stream>.

              To connect a Programmable Voice call to a bi-directional Media Stream, use the <Stream> noun with the url attribute set to a secure websocket server (wss):

              <?xml version="1.0" encoding="UTF-8"?>
              <Response>
                 <Connect>
                     <Stream url="wss://mystream.ngrok.io/audiostream" />
                 </Connect>
              </Response>
                    
                    
                    

                    VirtualAgent

                    The <VirtualAgent> noun will connect a Programmable Voice call to a Google Dialogflow Essentials (ES) agent. The Dialogflow ES agent provides callers with conversational experiences through Interactive Voice Response (IVR).

                    <?xml version="1.0" encoding="UTF-8"?>
                    <Response>
                      <Connect>
                        <VirtualAgent connectorName="project" />
                      </Connect>
                    </Response>
                          
                          
                          
                          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 by visiting Twilio's Community Forums or browsing the Twilio tag on Stack Overflow.

                                
                                
                                

                                Thank you for your feedback!

                                We are always striving to improve our documentation quality, and your feedback is valuable to us. Please select the reason(s) for your feedback or provide additional information about how we can improve:

                                Sending your feedback...
                                🎉 Thank you for your feedback!
                                Something went wrong. Please try again.

                                Thanks for your feedback!

                                Refer us and get $10 in 3 simple steps!

                                Step 1

                                Get link

                                Get a free personal referral link here

                                Step 2

                                Give $10

                                Your user signs up and upgrade using link

                                Step 3

                                Get $10

                                1,250 free SMSes
                                OR 1,000 free voice mins
                                OR 12,000 chats
                                OR more