Skip to main content

Connect

Beta

The Connect verb is currently in Beta and is used to connect calls to Endpoints created via the BRTC APIs. To learn more about BRTC or to get access, please contact support@bandwidth.com.

The Connect verb is used to connect a call to an Endpoint.

Text Content

There is no text content available to be set for the <Connect> verb.

Attributes

AttributeDescription
eventCallbackUrl(optional) URL to send events to during the connection lifecycle. May be a relative URL.

Nestable Verbs

The following verbs may be nested inside of a <Connect> verb to define the connection destination:

VerbDescription
EndpointAn Endpoint ID to connect the call to.

Endpoint

The <Endpoint> verb is used within the <Connect> verb to specify an endpoint destination.

Text Content

NameDescription
Endpoint IDString containing the endpoint ID to connect to.

Attributes

The <Endpoint> verb has no attributes.

Examples

Connect to an Endpoint

This shows how to use Bandwidth XML to connect a call to an endpoint.

note

SDK support for the <Connect> verb is currently under development for the BRTC beta. Please use XML directly for now.

<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Connect eventCallbackUrl="https://example.com/callback">
<Endpoint>endpoint-abc123</Endpoint>
</Connect>
</Response>