Struct ServerMessagePhoneCallControl

pub struct ServerMessagePhoneCallControl {
    pub phone_number: Option<Box<ServerMessageAssistantRequestPhoneNumber>>,
    pub type: Type,
    pub request: Request,
    pub destination: Option<Box<ServerMessagePhoneCallControlDestination>>,
    pub timestamp: Option<String>,
    pub artifact: Option<Box<Artifact>>,
    pub assistant: Option<Box<CreateAssistantDto>>,
    pub customer: Option<Box<CreateCustomerDto>>,
    pub call: Option<Box<Call>>,
}

Fields

phone_number: Option<Box<ServerMessageAssistantRequestPhoneNumber>>

type: Type

This is the type of the message. "phone-call-control" is an advanced type of message. When it is requested in assistant.serverMessages, the hangup and forwarding responsibilities are delegated to your server. Vapi will no longer do the actual transfer and hangup.

request: Request

This is the request to control the phone call.

destination: Option<Box<ServerMessagePhoneCallControlDestination>>

timestamp: Option<String>

This is the ISO-8601 formatted timestamp of when the message was sent.

artifact: Option<Box<Artifact>>

This is a live version of the call.artifact. This matches what is stored on call.artifact after the call.

assistant: Option<Box<CreateAssistantDto>>

This is the assistant that is currently active. This is provided for convenience. This matches one of the following: - call.assistant, - call.assistantId, - call.squad[n].assistant, - call.squad[n].assistantId, - call.squadId->[n].assistant, - call.squadId->[n].assistantId.

customer: Option<Box<CreateCustomerDto>>

This is the customer associated with the call. This matches one of the following: - call.customer, - call.customerId.

call: Option<Box<Call>>

This is the call object. This matches what was returned in POST /call. Note: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.

Implementations

impl ServerMessagePhoneCallControl

pub fn new(type: Type, request: Request) -> ServerMessagePhoneCallControl

Trait Implementations

impl Clone for ServerMessagePhoneCallControl

fn clone(&self) -> ServerMessagePhoneCallControl

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServerMessagePhoneCallControl

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

Formats the value using the given formatter.

impl Default for ServerMessagePhoneCallControl

fn default() -> ServerMessagePhoneCallControl

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerMessagePhoneCallControl

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ServerMessagePhoneCallControl

fn eq(&self, other: &ServerMessagePhoneCallControl) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ServerMessagePhoneCallControl

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ServerMessagePhoneCallControl