Class SIPInboundTrunkInfo

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.dll

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

Inheritance

object

SIPInboundTrunkInfo

Implements

IMessage<SIPInboundTrunkInfo>

IEquatable<SIPInboundTrunkInfo>

IDeepCloneable<SIPInboundTrunkInfo>

IBufferMessage

IMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SIPInboundTrunkInfo()

public SIPInboundTrunkInfo()

SIPInboundTrunkInfo(SIPInboundTrunkInfo)

public SIPInboundTrunkInfo(SIPInboundTrunkInfo other)

Parameters

other SIPInboundTrunkInfo

Properties

AllowedAddresses

CIDR or IPs that traffic is accepted from. An empty list means all inbound traffic is accepted.

public RepeatedField<string> AllowedAddresses { get; }

Property Value

RepeatedField<string>

AllowedNumbers

Numbers that are allowed to make calls to this Trunk. An empty list means calls from any phone number is accepted.

public RepeatedField<string> AllowedNumbers { get; }

Property Value

RepeatedField<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

AuthRealm

public string AuthRealm { get; set; }

Property Value

string

AuthUsername

Username and password used to authenticate inbound SIP invites. May be empty to have no authentication.

public string AuthUsername { get; set; }

Property Value

string

CreatedAt

public Timestamp CreatedAt { get; set; }

Property Value

Timestamp

Headers

Include these SIP X-* headers in 200 OK responses.

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

Property Value

MapField<string, string>

HeadersToAttributes

Map SIP X-* headers from INVITE to SIP participant attributes.

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

Property Value

MapField<string, string>

IncludeHeaders

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

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

When mapping INVITE headers to response 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

KrispEnabled

public bool KrispEnabled { get; set; }

Property Value

bool

MaxCallDuration

Max call duration.

public Duration MaxCallDuration { get; set; }

Property Value

Duration

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 associated with LiveKit SIP. The Trunk will only accept calls made to these numbers. Creating multiple Trunks with different phone numbers allows having different rules for a single provider.

public RepeatedField<string> Numbers { get; }

Property Value

RepeatedField<string>

RingingTimeout

Max time for the caller to wait for track subscription.

public Duration RingingTimeout { get; set; }

Property Value

Duration

RingingTimeoutStatus

SIP status code if ringing_timeout elapses. Unset means using system default.

public SIPStatusCode RingingTimeoutStatus { get; set; }

Property Value

SIPStatusCode

SipTrunkId

public string SipTrunkId { get; set; }

Property Value

string

UpdatedAt

public Timestamp UpdatedAt { get; set; }

Property Value

Timestamp