Struct TransferPlan

pub struct TransferPlan {
    pub mode: Mode,
    pub message: Option<Box<TransferPlanMessage>>,
    pub sip_verb: Option<SipVerb>,
    pub twiml: Option<String>,
    pub summary_plan: Option<Box<SummaryPlan>>,
}

Fields

mode: Mode

This configures how transfer is executed and the experience of the destination party receiving the call. Usage: - blind-transfer: The assistant forwards the call to the destination without any message or summary. - blind-transfer-add-summary-to-sip-header: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary. - warm-transfer-say-message: The assistant dials the destination, delivers the message to the destination party, connects the customer, and leaves the call. - warm-transfer-say-summary: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call. - warm-transfer-wait-for-operator-to-speak-first-and-then-say-message: The assistant dials the destination, waits for the operator to speak, delivers the message to the destination party, and then connects the customer. - warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer. - warm-transfer-twiml: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call. @default ‘blind-transfer’

message: Option<Box<TransferPlanMessage>>

sip_verb: Option<SipVerb>

This specifies the SIP verb to use while transferring the call. - ‘refer’: Uses SIP REFER to transfer the call (default) - ‘bye’: Ends current call with SIP BYE - ‘dial’: Uses SIP DIAL to transfer the call

twiml: Option<String>

This is the TwiML instructions to execute on the destination call leg before connecting the customer. Usage: - Used only when mode is warm-transfer-twiml. - Supports only Play, Say, Gather, Hangup and Pause verbs. - Maximum length is 4096 characters. Example: <Say voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.</Say> <Pause length=\"2\"/> <Say>They called about billing questions.</Say>

summary_plan: Option<Box<SummaryPlan>>

This is the plan for generating a summary of the call to present to the destination party. Usage: - Used only when mode is blind-transfer-add-summary-to-sip-header or warm-transfer-say-summary or warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary.

Implementations

impl TransferPlan

pub fn new(mode: Mode) -> TransferPlan

Trait Implementations

impl Clone for TransferPlan

fn clone(&self) -> TransferPlan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransferPlan

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

Formats the value using the given formatter.

impl Default for TransferPlan

fn default() -> TransferPlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransferPlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TransferPlan

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

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 TransferPlan