Struct SipOutboundTrunkInfo 

pub struct SipOutboundTrunkInfo {

    pub sip_trunk_id: String,
    pub name: String,
    pub metadata: String,
    pub address: String,
    pub destination_country: String,
    pub transport: i32,
    pub numbers: Vec<String>,
    pub auth_username: String,
    pub auth_password: String,
    pub headers: HashMap<String, String>,
    pub headers_to_attributes: HashMap<String, String>,
    pub attributes_to_headers: HashMap<String, String>,
    pub include_headers: i32,
    pub media_encryption: i32,
    pub from_host: String,
    pub created_at: Option<Timestamp>,
    pub updated_at: Option<Timestamp>,
}

Fields

sip_trunk_id: String

name: String

Human-readable name for the Trunk.

metadata: String

User-defined metadata for the Trunk.

address: String

Hostname or IP that SIP INVITE is sent too. Note that this is not a SIP URI and should not contain the ‘sip:’ protocol prefix.

destination_country: String

country where the call terminates as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will be used by the livekit infrastructure to route calls.

transport: i32

SIP Transport used for outbound call.

numbers: Vec<String>

Numbers used to make the calls. Random one from this list will be selected.

auth_username: String

Username and password used to authenticate with SIP server. May be empty to have no authentication.

auth_password: String

headers: HashMap<String, String>

Include these SIP X-* headers in INVITE request. These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.

headers_to_attributes: HashMap<String, String>

Map SIP X-* headers from 200 OK to SIP participant attributes. Keys are the names of X-* headers and values are the names of attributes they will be mapped to.

attributes_to_headers: HashMap<String, String>

Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests. Keys are the names of attributes and values are the names of X-* headers they will be mapped to.

include_headers: i32

Map SIP headers from 200 OK to sip.h.* participant attributes automatically.

When the names of required headers is known, using headers_to_attributes is strongly recommended.

When mapping 200 OK headers to follow-up request headers with attributes_to_headers map, lowercase header names should be used, for example: sip.h.x-custom-header.

media_encryption: i32

from_host: String

Optional custom hostname for the ‘From’ SIP header in outbound INVITEs. When set, outbound calls from this trunk will use this host instead of the default project SIP domain. Enables originating calls from custom domains.

created_at: Option<Timestamp>

updated_at: Option<Timestamp>

Implementations

impl SipOutboundTrunkInfo

pub fn transport(&self) -> SipTransport

Returns the enum value of transport, or the default if the field is set to an invalid enum value.

pub fn set_transport(&mut self, value: SipTransport)

Sets transport to the provided enum value.

pub fn include_headers(&self) -> SipHeaderOptions

Returns the enum value of include_headers, or the default if the field is set to an invalid enum value.

pub fn set_include_headers(&mut self, value: SipHeaderOptions)

Sets include_headers to the provided enum value.

pub fn media_encryption(&self) -> SipMediaEncryption

Returns the enum value of media_encryption, or the default if the field is set to an invalid enum value.

pub fn set_media_encryption(&mut self, value: SipMediaEncryption)

Sets media_encryption to the provided enum value.

Trait Implementations

impl Clone for SipOutboundTrunkInfo

fn clone(&self) -> SipOutboundTrunkInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SipOutboundTrunkInfo

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

Formats the value using the given formatter.

impl Default for SipOutboundTrunkInfo

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SipOutboundTrunkInfo

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SipOutboundTrunkInfo

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SipOutboundTrunkInfo

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

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 SipOutboundTrunkInfo