Class ConnectorClient

Client to access Connector APIs for WhatsApp and Twilio integrations

Hierarchy

ServiceBase
- ConnectorClient

Index

Constructors

Methods

acceptWhatsAppCall authHeader connectTwilioCall connectWhatsAppCall dialWhatsAppCall disconnectWhatsAppCall

Constructors

constructor

new ConnectorClient(
    host: string,
    apiKey?: string,
    secret?: string,
    options?: ClientOptions,
): ConnectorClient
Parameters
- host: string
  hostname including protocol. i.e. 'https://.livekit.cloud'
- OptionalapiKey: string
  API Key, can be set in env var LIVEKIT_API_KEY
- Optionalsecret: string
  API Secret, can be set in env var LIVEKIT_API_SECRET
- Optionaloptions: ClientOptions
  client options
Returns ConnectorClient
Overrides ServiceBase.constructor
- Defined in packages/livekit-server-sdk/src/ConnectorClient.ts:128

Methods

acceptWhatsAppCall

acceptWhatsAppCall(
options: AcceptWhatsAppCallOptions,
): Promise<AcceptWhatsAppCallResponse>
Accept an inbound WhatsApp call
Parameters
- options: AcceptWhatsAppCallOptions
  WhatsApp call accept options
Returns Promise<AcceptWhatsAppCallResponse>
Promise containing the room name
- Defined in packages/livekit-server-sdk/src/ConnectorClient.ts:183

authHeader

authHeader(grant: VideoGrant, sip?: SIPGrant): Promise<Record<string, string>>
Parameters
- grant: VideoGrant
- Optionalsip: SIPGrant
Returns Promise<Record<string, string>>
Inherited from ServiceBase.authHeader
- Defined in packages/livekit-server-sdk/src/ServiceBase.ts:55

connectTwilioCall

connectTwilioCall(
options: ConnectTwilioCallOptions,
): Promise<ConnectTwilioCallResponse>
Connect a Twilio call to a LiveKit room
Parameters
- options: ConnectTwilioCallOptions
  Twilio call connection options
Returns Promise<ConnectTwilioCallResponse>
Promise containing the WebSocket connect URL for Twilio media stream
- Defined in packages/livekit-server-sdk/src/ConnectorClient.ts:285

connectWhatsAppCall

connectWhatsAppCall(
whatsappCallId: string,
sdp: SessionDescription,
): Promise<ConnectWhatsAppCallResponse>
Connect an established WhatsApp call (used for business-initiated calls)
Parameters
- whatsappCallId: string
  Call ID sent by Meta
- sdp: SessionDescription
  Session description from Meta
Returns Promise<ConnectWhatsAppCallResponse>
- Defined in packages/livekit-server-sdk/src/ConnectorClient.ts:233

dialWhatsAppCall

dialWhatsAppCall(
options: DialWhatsAppCallOptions,
): Promise<DialWhatsAppCallResponse>
Initiate an outbound WhatsApp call
Parameters
- options: DialWhatsAppCallOptions
  WhatsApp call options
Returns Promise<DialWhatsAppCallResponse>
Promise containing the WhatsApp call ID and room name
- Defined in packages/livekit-server-sdk/src/ConnectorClient.ts:142

disconnectWhatsAppCall

disconnectWhatsAppCall(
    whatsappCallId: string,
    whatsappApiKey: string,
    disconnectReason?: DisconnectWhatsAppCallRequest_DisconnectReason,
): Promise<DisconnectWhatsAppCallResponse>
Disconnect an active WhatsApp call
Parameters
- whatsappCallId: string
  Call ID sent by Meta
- whatsappApiKey: string
  The API key of the business that is disconnecting the call. Required when disconnectReason is BUSINESS_INITIATED, optional for USER_INITIATED.
- OptionaldisconnectReason: DisconnectWhatsAppCallRequest_DisconnectReason
  Optional reason for disconnecting the call. Defaults to BUSINESS_INITIATED.
Returns Promise<DisconnectWhatsAppCallResponse>
- Defined in packages/livekit-server-sdk/src/ConnectorClient.ts:259