vapi_client/models/
create_vapi_phone_number_dto.rs

1/*
2 * Vapi API
3 *
4 * Voice AI for developers.
5 *
6 * The version of the OpenAPI document: 1.0
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct CreateVapiPhoneNumberDto {
16    #[serde(rename = "fallbackDestination", skip_serializing_if = "Option::is_none")]
17    pub fallback_destination: Option<models::ImportTwilioPhoneNumberDtoFallbackDestination>,
18    /// This is the hooks that will be used for incoming calls to this phone number.
19    #[serde(rename = "hooks", skip_serializing_if = "Option::is_none")]
20    pub hooks: Option<Vec<serde_json::Value>>,
21    /// This is to create free SIP phone numbers on Vapi.
22    #[serde(rename = "provider")]
23    pub provider: Provider,
24    /// This is the area code of the phone number to purchase.
25    #[serde(rename = "numberDesiredAreaCode", skip_serializing_if = "Option::is_none")]
26    pub number_desired_area_code: Option<String>,
27    /// 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.
28    #[serde(rename = "sipUri", skip_serializing_if = "Option::is_none")]
29    pub sip_uri: Option<String>,
30    /// 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.
31    #[serde(rename = "authentication", skip_serializing_if = "Option::is_none")]
32    pub authentication: Option<models::SipAuthentication>,
33    /// This is the name of the phone number. This is just for your own reference.
34    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
35    pub name: Option<String>,
36    /// 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.
37    #[serde(rename = "assistantId", skip_serializing_if = "Option::is_none")]
38    pub assistant_id: Option<String>,
39    /// 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.
40    #[serde(rename = "squadId", skip_serializing_if = "Option::is_none")]
41    pub squad_id: Option<String>,
42    /// 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
43    #[serde(rename = "server", skip_serializing_if = "Option::is_none")]
44    pub server: Option<models::Server>,
45}
46
47impl CreateVapiPhoneNumberDto {
48    pub fn new(provider: Provider) -> CreateVapiPhoneNumberDto {
49        CreateVapiPhoneNumberDto {
50            fallback_destination: None,
51            hooks: None,
52            provider,
53            number_desired_area_code: None,
54            sip_uri: None,
55            authentication: None,
56            name: None,
57            assistant_id: None,
58            squad_id: None,
59            server: None,
60        }
61    }
62}
63/// This is to create free SIP phone numbers on Vapi.
64#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
65pub enum Provider {
66    #[serde(rename = "vapi")]
67    Vapi,
68}
69
70impl Default for Provider {
71    fn default() -> Provider {
72        Self::Vapi
73    }
74}
75
vapi_client/models/create_vapi_phone_number_dto.rs

vapi_client/models/
create_vapi_phone_number_dto.rs
