Struct Realtime 

pub struct Realtime<'c, C: Config> { /* private fields */ }

Available on crate feature realtime only.

Realtime API for creating sessions, managing calls, and handling WebRTC connections. Related guide: Realtime API

Implementations

impl<'c, C: Config> Realtime<'c, C>

pub fn new(client: &'c Client<C>) -> Self

pub async fn create_call( &self, request: RealtimeCallCreateRequest, ) -> Result<RealtimeCallCreateResponse, OpenAIError>

Create a new Realtime API call over WebRTC and receive the SDP answer needed to complete the peer connection.

Returns the SDP answer in the response body and the call ID in the Location header.

pub async fn accept_call( &self, call_id: &str, request: RealtimeCallAcceptRequest, ) -> Result<(), OpenAIError>

Accept an incoming SIP call and configure the realtime session that will handle the call. Accept an incoming SIP call and configure the realtime session that will handle the call.

pub async fn accept_call_byot<T0: Display, T1: Serialize, R: DeserializeOwned>( &self, call_id: T0, request: T1, ) -> Result<R, OpenAIError>

Accept an incoming SIP call and configure the realtime session that will handle the call.

pub async fn hangup_call(&self, call_id: &str) -> Result<(), OpenAIError>

End an active Realtime API call, whether it was initiated over SIP or WebRTC. End an active Realtime API call, whether it was initiated over SIP or WebRTC.

pub async fn hangup_call_byot<T0: Display, R: DeserializeOwned>( &self, call_id: T0, ) -> Result<R, OpenAIError>

End an active Realtime API call, whether it was initiated over SIP or WebRTC.

pub async fn refer_call( &self, call_id: &str, request: RealtimeCallReferRequest, ) -> Result<(), OpenAIError>

Transfer a SIP call to a new destination using the Realtime API. Transfer a SIP call to a new destination using the Realtime API.

pub async fn refer_call_byot<T0: Display, T1: Serialize, R: DeserializeOwned>( &self, call_id: T0, request: T1, ) -> Result<R, OpenAIError>

Transfer a SIP call to a new destination using the Realtime API.

pub async fn reject_call( &self, call_id: &str, request: RealtimeCallRejectRequest, ) -> Result<(), OpenAIError>

Decline an incoming SIP call handled by the Realtime API. Decline an incoming SIP call handled by the Realtime API.

pub async fn reject_call_byot<T0: Display, T1: Serialize, R: DeserializeOwned>( &self, call_id: T0, request: T1, ) -> Result<R, OpenAIError>

Decline an incoming SIP call handled by the Realtime API.

pub async fn create_client_secret( &self, request: RealtimeCreateClientSecretRequest, ) -> Result<RealtimeCreateClientSecretResponse, OpenAIError>

Create a Realtime client secret with an associated session configuration. Create a Realtime client secret with an associated session configuration.

pub async fn create_client_secret_byot<T0: Serialize, R: DeserializeOwned>( &self, request: T0, ) -> Result<R, OpenAIError>

Create a Realtime client secret with an associated session configuration.

Trait Implementations

impl<'c, C: Config> RequestOptionsBuilder for Realtime<'c, C>

Available on crate feature _api only.

fn options_mut(&mut self) -> &mut RequestOptions

Get mutable reference to RequestOptions (for building)

fn options(&self) -> &RequestOptions

Get reference to RequestOptions

fn headers(self, headers: HeaderMap) -> Self

Add headers to RequestOptions

fn header<K, V>(self, key: K, value: V) -> Result<Self, OpenAIError>

where K: IntoHeaderName, V: TryInto<HeaderValue>, V::Error: Into<InvalidHeaderValue>,

Add a single header to RequestOptions

fn query<Q: Serialize + ?Sized>(self, query: &Q) -> Result<Self, OpenAIError>

Add query parameters to RequestOptions

fn path<P: Into<String>>(self, path: P) -> Result<Self, OpenAIError>

Add a path to RequestOptions