Struct CreateRoutingRuleParams 

pub struct CreateRoutingRuleParams {

    pub name: String,
    pub direction: Option<SipDirection>,
    pub phone_numbers: Vec<String>,
    pub rule: Option<RoutingRuleTarget>,
    pub room: Option<SipRoomConfig>,
    pub agent_id: Option<String>,
    pub agent_metadata: Option<Map<String, Value>>,
    pub include_headers: Option<SipIncludeHeaders>,
    pub headers: HashMap<String, String>,
    pub headers_to_attributes: HashMap<String, String>,
    pub allowed_numbers: Vec<String>,
    pub allowed_ip_addresses: Vec<String>,
    pub tags: Vec<String>,
    pub recording: Option<bool>,
    pub dtmf: Option<bool>,
    pub noise_cancellation: Option<bool>,
    pub hide_phone_number: Option<bool>,
    pub api_key: Option<String>,
}

The parameters for SipRoutingRulesResource::create.

Fields

name: String

The display name. Required.

direction: Option<SipDirection>

The direction. Required.

phone_numbers: Vec<String>

The provisioned phone numbers to bind.

rule: Option<RoutingRuleTarget>

Where to route matching calls. Friendly sugar over room.

room: Option<SipRoomConfig>

An explicit room configuration. Used only when rule is omitted.

agent_id: Option<String>

The agent to dispatch for matching calls.

agent_metadata: Option<Map<String, Value>>

Metadata handed to the dispatched agent. Applied on create only when agent_id is also set.

include_headers: Option<SipIncludeHeaders>

Which SIP headers to forward.

headers: HashMap<String, String>

Headers to add. Outbound rules only — the server rejects this on an inbound rule.

headers_to_attributes: HashMap<String, String>

Inbound headers to map onto participant attributes. Inbound rules only — the server rejects this on an outbound rule.

allowed_numbers: Vec<String>

The allowed caller-number patterns.

allowed_ip_addresses: Vec<String>

The allowed source IP addresses.

tags: Vec<String>

Free-form tags.

recording: Option<bool>

Whether to record matching calls.

dtmf: Option<bool>

Whether to enable DTMF.

noise_cancellation: Option<bool>

Whether to apply noise cancellation.

hide_phone_number: Option<bool>

Whether to hide the caller’s number from the room.

api_key: Option<String>

The API key that should own this rule.

Trait Implementations

impl Clone for CreateRoutingRuleParams

fn clone(&self) -> CreateRoutingRuleParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateRoutingRuleParams

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

Formats the value using the given formatter.

impl Default for CreateRoutingRuleParams

fn default() -> CreateRoutingRuleParams

Returns the “default value” for a type.