Class SIPOutboundTrunkInfo

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.dll

public sealed class SIPOutboundTrunkInfo : IMessage<SIPOutboundTrunkInfo>, IEquatable<SIPOutboundTrunkInfo>, IDeepCloneable<SIPOutboundTrunkInfo>, IBufferMessage, IMessage

Inheritance

object

SIPOutboundTrunkInfo

Implements

IMessage<SIPOutboundTrunkInfo>

IEquatable<SIPOutboundTrunkInfo>

IDeepCloneable<SIPOutboundTrunkInfo>

IBufferMessage

IMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SIPOutboundTrunkInfo()

public SIPOutboundTrunkInfo()

SIPOutboundTrunkInfo(SIPOutboundTrunkInfo)

public SIPOutboundTrunkInfo(SIPOutboundTrunkInfo other)

Parameters

other SIPOutboundTrunkInfo

Properties

Address

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.

public string Address { get; set; }

Property Value

string

AttributesToHeaders

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.

public MapField<string, string> AttributesToHeaders { get; }

Property Value

MapField<string, string>

AuthPassword

public string AuthPassword { get; set; }

Property Value

string

AuthUsername

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

public string AuthUsername { get; set; }

Property Value

string

CreatedAt

public Timestamp CreatedAt { get; set; }

Property Value

Timestamp

DestinationCountry

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.

public string DestinationCountry { get; set; }

Property Value

string

FromHost

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.

public string FromHost { get; set; }

Property Value

string

Headers

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.

public MapField<string, string> Headers { get; }

Property Value

MapField<string, string>

HeadersToAttributes

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.

public MapField<string, string> HeadersToAttributes { get; }

Property Value

MapField<string, string>

IncludeHeaders

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.

public SIPHeaderOptions IncludeHeaders { get; set; }

Property Value

SIPHeaderOptions

Media

public SIPMediaConfig Media { get; set; }

Property Value

SIPMediaConfig

MediaEncryption

[Obsolete]
public SIPMediaEncryption MediaEncryption { get; set; }

Property Value

SIPMediaEncryption

Metadata

User-defined metadata for the Trunk.

public string Metadata { get; set; }

Property Value

string

Name

Human-readable name for the Trunk.

public string Name { get; set; }

Property Value

string

Numbers

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

public RepeatedField<string> Numbers { get; }

Property Value

RepeatedField<string>

SipTrunkId

public string SipTrunkId { get; set; }

Property Value

string

Transport

SIP Transport used for outbound call.

public SIPTransport Transport { get; set; }

Property Value

SIPTransport

UpdatedAt

public Timestamp UpdatedAt { get; set; }

Property Value

Timestamp