Struct CreateSipCallParams 

pub struct CreateSipCallParams {

    pub call_to: String,
    pub call_from: Option<String>,
    pub room_id: Option<String>,
    pub participant_id: Option<String>,
    pub gateway_id: Option<String>,
    pub routing_rule_id: Option<String>,
    pub participant: Option<Map<String, Value>>,
    pub metadata: Option<Map<String, Value>>,
    pub record_audio: Option<bool>,
    pub wait_until_answered: Option<bool>,
    pub ringing_timeout: Option<u32>,
    pub dtmf: Option<bool>,
    pub max_call_duration: Option<u32>,
    pub media_encryption: Option<SipMediaEncryption>,
    pub hide_phone_number: Option<bool>,
    pub headers: HashMap<String, String>,
    pub include_headers: Option<SipIncludeHeaders>,
}

The parameters for SipCallsResource::create.

When the call originates from a provisioned phone number — call_from is a provisioned number, typically with routing_rule_id — then record_audio, dtmf, hide_phone_number, headers, include_headers and media_encryption are taken from the matching routing rule and gateway, so the per-call values here are ignored. When the call is placed directly through an outbound gateway (gateway_id), the per-call values apply.

Fields

call_to: String

The destination number. Required.

call_from: Option<String>

The source number. Required unless derivable from gateway_id.

room_id: Option<String>

The destination room.

participant_id: Option<String>

The id to assign the call’s participant in the destination room.

Ignored when participant is set.

gateway_id: Option<String>

The outbound gateway to place the call through.

routing_rule_id: Option<String>

The outbound routing rule to place the call through.

participant: Option<Map<String, Value>>

The full participant configuration, overriding participant_id.

metadata: Option<Map<String, Value>>

Free-form metadata.

record_audio: Option<bool>

Whether to record the call’s audio.

wait_until_answered: Option<bool>

Whether to block until the call is answered.

ringing_timeout: Option<u32>

How long to ring before giving up, in seconds.

dtmf: Option<bool>

Whether to enable DTMF.

max_call_duration: Option<u32>

The maximum call duration, in seconds.

media_encryption: Option<SipMediaEncryption>

Whether to encrypt media.

hide_phone_number: Option<bool>

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

headers: HashMap<String, String>

Headers to add to the outbound call.

include_headers: Option<SipIncludeHeaders>

Which SIP headers to forward.

Trait Implementations

impl Clone for CreateSipCallParams

fn clone(&self) -> CreateSipCallParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateSipCallParams

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

Formats the value using the given formatter.

impl Default for CreateSipCallParams

fn default() -> CreateSipCallParams

Returns the “default value” for a type.