Connectors

The connectors resource bridges inbound calls from a telephony provider (Twilio, Plivo, or Telnyx) into a room. Create a connector and configure its webhook URL at the provider. Calls then flow into VideoSDK.

For provider-specific setup, see the Twilio Connector, Plivo Connector, and Telnyx Connector guides.

Create a connector

Node.js

const connector = await client.connectors.create({ provider: "twilio", roomId });
connector.webhookUrl; // set this at the provider

Go

connector, err := client.Connectors.Create(ctx, videosdk.CreateConnectorParams{
	Provider: videosdk.ConnectorTwilio,
	RoomID:   roomID,
})
fmt.Println(connector.WebhookURL) // set this at the provider

Rust

let connector = client.connectors().create(videosdk::CreateConnectorParams {
    provider: Some(videosdk::ConnectorProvider::TWILIO),
    room_id: Some(room_id),
    ..Default::default()
}).await?;
println!("{:?}", connector.webhook_url); // set this at the provider

Options: provider (required, one of twilio, plivo, or telnyx), name, roomId (fallback room), defaultRuleId, region.

Manage

Node.js

await client.connectors.list();
await client.connectors.get(connectorId);
await client.connectors.rotateKey(connectorId); // invalidates the old webhook URL
await client.connectors.delete(connectorId);

Go

client.Connectors.List(ctx)
client.Connectors.Get(ctx, connectorID)
client.Connectors.RotateKey(ctx, connectorID) // invalidates the old webhook URL
client.Connectors.Delete(ctx, connectorID)

Rust

client.connectors().list().await?;
client.connectors().get(connector_id).await?;
client.connectors().rotate_key(connector_id).await?; // invalidates the old webhook URL
client.connectors().delete(connector_id).await?;

The connector object

Returned by connectors.create, list, and get.

Field	Type	Description
id	string	Unique connector id.
provider	string	Telephony provider (twilio, plivo, telnyx).
name	string	Display name.
webhookUrl	string	Public webhook URL to configure at the provider.
defaultRoomId	string	Fallback room used when no routing rule resolves.
defaultRuleId	string	Routing rule applied by default.
region	string	Region call ingestion is pinned to.
createdAt	string	Creation timestamp (ISO-8601).