Struct ConnectorClient

Source

pub struct ConnectorClient { /* private fields */ }

Implementations§

Source §

impl ConnectorClient

Source

pub fn with_api_key(host: &str, api_key: &str, api_secret: &str) -> Self

Authenticates with an API key and secret, signing a short-lived token per request.

Source

pub fn with_token(host: &str, token: &str) -> Self

Authenticates with a pre-signed token, sent verbatim on every request.

Source

pub fn new(host: &str) -> ServiceResult<Self>

Reads the API key and secret from the LIVEKIT_API_KEY and LIVEKIT_API_SECRET environment variables.

Source

pub fn with_failover(self, enabled: bool) -> Self

Enables or disables region failover (enabled by default). Failover only engages for LiveKit Cloud hosts.

Source

pub fn with_request_timeout(self, timeout: Duration) -> Self

Overrides the default per-request timeout (10s) for calls on this client.

Source

pub async fn dial_whatsapp_call( &self, phone_number_id: impl Into<String>, to_phone_number: impl Into<String>, api_key: impl Into<String>, cloud_api_version: impl Into<String>, options: DialWhatsAppCallOptions, ) -> ServiceResult<DialWhatsAppCallResponse>

Dials a WhatsApp call

§Arguments

phone_number_id - The identifier of the number for business initiating the call
to_phone_number - The number of the user that should receive the call
api_key - The API key of the business initiating the call
cloud_api_version - WhatsApp Cloud API version (e.g., “23.0”, “24.0”)
options - Additional options for the call

§Returns

Information about the dialed call including the WhatsApp call ID and room name

Source

pub async fn disconnect_whatsapp_call( &self, call_id: impl Into<String>, api_key: impl Into<String>, ) -> ServiceResult<DisconnectWhatsAppCallResponse>

Disconnects a WhatsApp call initiated by the business.

This is the BusinessInitiated case; use disconnect_whatsapp_call_with_reason to disconnect with a different DisconnectReason.

§Arguments

call_id - Call ID sent by Meta
api_key - The API key of the business disconnecting the call

§Returns

Empty response on success

Source

pub async fn disconnect_whatsapp_call_with_reason( &self, call_id: impl Into<String>, api_key: impl Into<String>, reason: DisconnectReason, ) -> ServiceResult<DisconnectWhatsAppCallResponse>

Disconnects a WhatsApp call, specifying why it is being disconnected.

§Arguments

call_id - Call ID sent by Meta
api_key - The API key of the business disconnecting the call. Required when reason is BusinessInitiated; optional for UserInitiated.
reason - Why the call is being disconnected

§Returns

Empty response on success

Source

pub async fn connect_whatsapp_call( &self, call_id: impl Into<String>, sdp: SessionDescription, ) -> ServiceResult<ConnectWhatsAppCallResponse>

Connects a WhatsApp call (handles the SDP exchange)

§Arguments

call_id - Call ID sent by Meta
sdp - The SDP from Meta (answer SDP for business-initiated call)

§Returns

Empty response on success

Source

pub async fn accept_whatsapp_call( &self, phone_number_id: impl Into<String>, api_key: impl Into<String>, cloud_api_version: impl Into<String>, call_id: impl Into<String>, sdp: SessionDescription, options: AcceptWhatsAppCallOptions, ) -> ServiceResult<AcceptWhatsAppCallResponse>

Accepts an incoming WhatsApp call

§Arguments

phone_number_id - The identifier of the number for business initiating the call
api_key - The API key of the business connecting the call
cloud_api_version - WhatsApp Cloud API version (e.g., “23.0”, “24.0”)
call_id - Call ID sent by Meta
sdp - The SDP from Meta (for user-initiated call)
options - Additional options for the call