ConnectorClient

livekit_api::services::connector

Struct ConnectorClient

pub struct ConnectorClient { /* private fields */ }

Implementations§

impl ConnectorClient

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

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

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

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

Disconnects a WhatsApp call

§Arguments

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

§Returns

Empty response on success

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

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

§Returns

Information about the accepted call including the room name

pub async fn connect_twilio_call( &self, direction: TwilioCallDirection, room_name: impl Into<String>, options: ConnectTwilioCallOptions, ) -> ServiceResult<ConnectTwilioCallResponse>

Connects a Twilio call

§Arguments

direction - The direction of the call (inbound or outbound)
room_name - What LiveKit room should this call be connected to
options - Additional options for the call

§Returns

The WebSocket URL which Twilio media stream should connect to

Trait Implementations§

impl Debug for ConnectorClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for ConnectorClient

impl !RefUnwindSafe for ConnectorClient

impl Send for ConnectorClient

impl Sync for ConnectorClient

impl Unpin for ConnectorClient

impl !UnwindSafe for ConnectorClient

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more