Struct VapiPhoneNumber

pub struct VapiPhoneNumber {

    pub fallback_destination: Option<Box<ImportTwilioPhoneNumberDtoFallbackDestination>>,
    pub provider: Provider,
    pub id: String,
    pub org_id: String,
    pub created_at: String,
    pub updated_at: String,
    pub status: Option<Status>,
    pub number: Option<String>,
    pub name: Option<String>,
    pub assistant_id: Option<String>,
    pub squad_id: Option<String>,
    pub server: Option<Box<Server>>,
    pub number_desired_area_code: Option<String>,
    pub sip_uri: Option<String>,
    pub authentication: Option<Box<SipAuthentication>>,
}

Fields

fallback_destination: Option<Box<ImportTwilioPhoneNumberDtoFallbackDestination>>

provider: Provider

This is to create free SIP phone numbers on Vapi.

id: String

This is the unique identifier for the phone number.

org_id: String

This is the unique identifier for the org that this phone number belongs to.

created_at: String

This is the ISO 8601 date-time string of when the phone number was created.

updated_at: String

This is the ISO 8601 date-time string of when the phone number was last updated.

status: Option<Status>

This is the status of the phone number.

number: Option<String>

These are the digits of the phone number you purchased from Vapi.

name: Option<String>

This is the name of the phone number. This is just for your own reference.

assistant_id: Option<String>

This is the assistant that will be used for incoming calls to this phone number. If neither assistantId nor squadId is set, assistant-request will be sent to your Server URL. Check ServerMessage and ServerMessageResponse for the shape of the message and response that is expected.

squad_id: Option<String>

This is the squad that will be used for incoming calls to this phone number. If neither assistantId nor squadId is set, assistant-request will be sent to your Server URL. Check ServerMessage and ServerMessageResponse for the shape of the message and response that is expected.

server: Option<Box<Server>>

This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. The order of precedence is: 1. assistant.server 2. phoneNumber.server 3. org.server

number_desired_area_code: Option<String>

This is the area code of the phone number to purchase.

sip_uri: Option<String>

This is the SIP URI of the phone number. You can SIP INVITE this. The assistant attached to this number will answer. This is case-insensitive.

authentication: Option<Box<SipAuthentication>>

This enables authentication for incoming SIP INVITE requests to the sipUri. If not set, any username/password to the 401 challenge of the SIP INVITE will be accepted.

Implementations

impl VapiPhoneNumber

pub fn new( provider: Provider, id: String, org_id: String, created_at: String, updated_at: String, ) -> VapiPhoneNumber

Trait Implementations

impl Clone for VapiPhoneNumber

fn clone(&self) -> VapiPhoneNumber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VapiPhoneNumber

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

Formats the value using the given formatter.

impl Default for VapiPhoneNumber

fn default() -> VapiPhoneNumber

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VapiPhoneNumber

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VapiPhoneNumber

fn eq(&self, other: &VapiPhoneNumber) -> 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 VapiPhoneNumber

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 VapiPhoneNumber