Documentation

SIPInboundTrunkInfo extends Message
in package

Generated from protobuf message <code>livekit.SIPInboundTrunkInfo</code>

Table of Contents

Properties

$auth_password  : mixed
Generated from protobuf field <code>string auth_password = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
$auth_username  : mixed
Username and password used to authenticate inbound SIP invites.
$include_headers  : mixed
Map SIP headers from INVITE to sip.h.* participant attributes automatically.
$krisp_enabled  : mixed
Generated from protobuf field <code>bool krisp_enabled = 13;</code>
$max_call_duration  : mixed
Max call duration.
$media_encryption  : mixed
Generated from protobuf field <code>.livekit.SIPMediaEncryption media_encryption = 16;</code>
$metadata  : mixed
User-defined metadata for the Trunk.
$name  : mixed
Human-readable name for the Trunk.
$ringing_timeout  : mixed
Max time for the caller to wait for track subscription.
$sip_trunk_id  : mixed
Generated from protobuf field <code>string sip_trunk_id = 1;</code>
$allowed_addresses  : mixed
CIDR or IPs that traffic is accepted from.
$allowed_numbers  : mixed
Numbers that are allowed to make calls to this Trunk.
$attributes_to_headers  : mixed
Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
$headers  : mixed
Include these SIP X-* headers in 200 OK responses.
$headers_to_attributes  : mixed
Map SIP X-* headers from INVITE to SIP participant attributes.
$numbers  : mixed
Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.

Methods

__construct()  : mixed
Constructor.
clearMaxCallDuration()  : mixed
clearRingingTimeout()  : mixed
getAllowedAddresses()  : RepeatedField<string|int, string>
CIDR or IPs that traffic is accepted from.
getAllowedNumbers()  : RepeatedField<string|int, string>
Numbers that are allowed to make calls to this Trunk.
getAttributesToHeaders()  : MapField
Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
getAuthPassword()  : string
Generated from protobuf field <code>string auth_password = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
getAuthUsername()  : string
Username and password used to authenticate inbound SIP invites.
getHeaders()  : MapField
Include these SIP X-* headers in 200 OK responses.
getHeadersToAttributes()  : MapField
Map SIP X-* headers from INVITE to SIP participant attributes.
getIncludeHeaders()  : int
Map SIP headers from INVITE to sip.h.* participant attributes automatically.
getKrispEnabled()  : bool
Generated from protobuf field <code>bool krisp_enabled = 13;</code>
getMaxCallDuration()  : Duration|null
Max call duration.
getMediaEncryption()  : int
Generated from protobuf field <code>.livekit.SIPMediaEncryption media_encryption = 16;</code>
getMetadata()  : string
User-defined metadata for the Trunk.
getName()  : string
Human-readable name for the Trunk.
getNumbers()  : RepeatedField<string|int, string>
Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.
getRingingTimeout()  : Duration|null
Max time for the caller to wait for track subscription.
getSipTrunkId()  : string
Generated from protobuf field <code>string sip_trunk_id = 1;</code>
hasMaxCallDuration()  : mixed
hasRingingTimeout()  : mixed
setAllowedAddresses()  : $this
CIDR or IPs that traffic is accepted from.
setAllowedNumbers()  : $this
Numbers that are allowed to make calls to this Trunk.
setAttributesToHeaders()  : $this
Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
setAuthPassword()  : $this
Generated from protobuf field <code>string auth_password = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
setAuthUsername()  : $this
Username and password used to authenticate inbound SIP invites.
setHeaders()  : $this
Include these SIP X-* headers in 200 OK responses.
setHeadersToAttributes()  : $this
Map SIP X-* headers from INVITE to SIP participant attributes.
setIncludeHeaders()  : $this
Map SIP headers from INVITE to sip.h.* participant attributes automatically.
setKrispEnabled()  : $this
Generated from protobuf field <code>bool krisp_enabled = 13;</code>
setMaxCallDuration()  : $this
Max call duration.
setMediaEncryption()  : $this
Generated from protobuf field <code>.livekit.SIPMediaEncryption media_encryption = 16;</code>
setMetadata()  : $this
User-defined metadata for the Trunk.
setName()  : $this
Human-readable name for the Trunk.
setNumbers()  : $this
Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.
setRingingTimeout()  : $this
Max time for the caller to wait for track subscription.
setSipTrunkId()  : $this
Generated from protobuf field <code>string sip_trunk_id = 1;</code>

Properties

$auth_password

Generated from protobuf field <code>string auth_password = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>

protected mixed $auth_password = ''

$auth_username

Username and password used to authenticate inbound SIP invites.

protected mixed $auth_username = ''

May be empty to have no authentication.

Generated from protobuf field string auth_username = 7 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

$include_headers

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

protected mixed $include_headers = 0

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.

Generated from protobuf field .livekit.SIPHeaderOptions include_headers = 15;

$krisp_enabled

Generated from protobuf field <code>bool krisp_enabled = 13;</code>

protected mixed $krisp_enabled = false

$max_call_duration

Max call duration.

protected mixed $max_call_duration = null

Generated from protobuf field .google.protobuf.Duration max_call_duration = 12;

$media_encryption

Generated from protobuf field <code>.livekit.SIPMediaEncryption media_encryption = 16;</code>

protected mixed $media_encryption = 0

$metadata

User-defined metadata for the Trunk.

protected mixed $metadata = ''

Generated from protobuf field string metadata = 3 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

$name

Human-readable name for the Trunk.

protected mixed $name = ''

Generated from protobuf field string name = 2;

$ringing_timeout

Max time for the caller to wait for track subscription.

protected mixed $ringing_timeout = null

Generated from protobuf field .google.protobuf.Duration ringing_timeout = 11;

$sip_trunk_id

Generated from protobuf field <code>string sip_trunk_id = 1;</code>

protected mixed $sip_trunk_id = ''

$allowed_addresses

CIDR or IPs that traffic is accepted from.

private mixed $allowed_addresses

An empty list means all inbound traffic is accepted.

Generated from protobuf field repeated string allowed_addresses = 5;

$allowed_numbers

Numbers that are allowed to make calls to this Trunk.

private mixed $allowed_numbers

An empty list means calls from any phone number is accepted.

Generated from protobuf field repeated string allowed_numbers = 6;

$attributes_to_headers

Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.

private mixed $attributes_to_headers

Keys are the names of attributes and values are the names of X-* headers they will be mapped to.

Generated from protobuf field map<string, string> attributes_to_headers = 14;

$headers

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

private mixed $headers

Generated from protobuf field map<string, string> headers = 9 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

$headers_to_attributes

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

private mixed $headers_to_attributes

Generated from protobuf field map<string, string> headers_to_attributes = 10;

$numbers

Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.

private mixed $numbers

Creating multiple Trunks with different phone numbers allows having different rules for a single provider.

Generated from protobuf field repeated string numbers = 4;

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type string $sip_trunk_id
@type string $name
      Human-readable name for the Trunk.
@type string $metadata
      User-defined metadata for the Trunk.
@type 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.
@type string[] $allowed_addresses
      CIDR or IPs that traffic is accepted from.
      An empty list means all inbound traffic is accepted.
@type string[] $allowed_numbers
      Numbers that are allowed to make calls to this Trunk.
      An empty list means calls from any phone number is accepted.
@type string $auth_username
      Username and password used to authenticate inbound SIP invites.
      May be empty to have no authentication.
@type string $auth_password
@type array|\Google\Protobuf\Internal\MapField $headers
      Include these SIP X-* headers in 200 OK responses.
@type array|\Google\Protobuf\Internal\MapField $headers_to_attributes
      Map SIP X-* headers from INVITE to SIP participant attributes.
@type array|\Google\Protobuf\Internal\MapField $attributes_to_headers
      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.
@type int $include_headers
      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.
@type \Google\Protobuf\Duration $ringing_timeout
      Max time for the caller to wait for track subscription.
@type \Google\Protobuf\Duration $max_call_duration
      Max call duration.
@type bool $krisp_enabled
@type int $media_encryption

}

getAllowedAddresses()

CIDR or IPs that traffic is accepted from.

public getAllowedAddresses() : RepeatedField<string|int, string>

An empty list means all inbound traffic is accepted.

Generated from protobuf field repeated string allowed_addresses = 5;

Return values
RepeatedField<string|int, string>

getAllowedNumbers()

Numbers that are allowed to make calls to this Trunk.

public getAllowedNumbers() : RepeatedField<string|int, string>

An empty list means calls from any phone number is accepted.

Generated from protobuf field repeated string allowed_numbers = 6;

Return values
RepeatedField<string|int, string>

getAttributesToHeaders()

Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.

public getAttributesToHeaders() : MapField

Keys are the names of attributes and values are the names of X-* headers they will be mapped to.

Generated from protobuf field map<string, string> attributes_to_headers = 14;

Return values
MapField

getAuthPassword()

Generated from protobuf field <code>string auth_password = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>

public getAuthPassword() : string
Return values
string

getAuthUsername()

Username and password used to authenticate inbound SIP invites.

public getAuthUsername() : string

May be empty to have no authentication.

Generated from protobuf field string auth_username = 7 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
string

getHeaders()

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

public getHeaders() : MapField

Generated from protobuf field map<string, string> headers = 9 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
MapField

getHeadersToAttributes()

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

public getHeadersToAttributes() : MapField

Generated from protobuf field map<string, string> headers_to_attributes = 10;

Return values
MapField

getIncludeHeaders()

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

public getIncludeHeaders() : int

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.

Generated from protobuf field .livekit.SIPHeaderOptions include_headers = 15;

Return values
int

getKrispEnabled()

Generated from protobuf field <code>bool krisp_enabled = 13;</code>

public getKrispEnabled() : bool
Return values
bool

getMaxCallDuration()

Max call duration.

public getMaxCallDuration() : Duration|null

Generated from protobuf field .google.protobuf.Duration max_call_duration = 12;

Return values
Duration|null

getMediaEncryption()

Generated from protobuf field <code>.livekit.SIPMediaEncryption media_encryption = 16;</code>

public getMediaEncryption() : int
Return values
int

getMetadata()

User-defined metadata for the Trunk.

public getMetadata() : string

Generated from protobuf field string metadata = 3 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
string

getName()

Human-readable name for the Trunk.

public getName() : string

Generated from protobuf field string name = 2;

Return values
string

getNumbers()

Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.

public getNumbers() : RepeatedField<string|int, string>

Creating multiple Trunks with different phone numbers allows having different rules for a single provider.

Generated from protobuf field repeated string numbers = 4;

Return values
RepeatedField<string|int, string>

getRingingTimeout()

Max time for the caller to wait for track subscription.

public getRingingTimeout() : Duration|null

Generated from protobuf field .google.protobuf.Duration ringing_timeout = 11;

Return values
Duration|null

getSipTrunkId()

Generated from protobuf field <code>string sip_trunk_id = 1;</code>

public getSipTrunkId() : string
Return values
string

setAllowedAddresses()

CIDR or IPs that traffic is accepted from.

public setAllowedAddresses(array<string|int, string> $var) : $this

An empty list means all inbound traffic is accepted.

Generated from protobuf field repeated string allowed_addresses = 5;

Parameters
$var : array<string|int, string>
Return values
$this

setAllowedNumbers()

Numbers that are allowed to make calls to this Trunk.

public setAllowedNumbers(array<string|int, string> $var) : $this

An empty list means calls from any phone number is accepted.

Generated from protobuf field repeated string allowed_numbers = 6;

Parameters
$var : array<string|int, string>
Return values
$this

setAttributesToHeaders()

Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.

public setAttributesToHeaders(array<string|int, mixed>|MapField $var) : $this

Keys are the names of attributes and values are the names of X-* headers they will be mapped to.

Generated from protobuf field map<string, string> attributes_to_headers = 14;

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this

setAuthPassword()

Generated from protobuf field <code>string auth_password = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>

public setAuthPassword(string $var) : $this
Parameters
$var : string
Return values
$this

setAuthUsername()

Username and password used to authenticate inbound SIP invites.

public setAuthUsername(string $var) : $this

May be empty to have no authentication.

Generated from protobuf field string auth_username = 7 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : string
Return values
$this

setHeaders()

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

public setHeaders(array<string|int, mixed>|MapField $var) : $this

Generated from protobuf field map<string, string> headers = 9 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this

setHeadersToAttributes()

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

public setHeadersToAttributes(array<string|int, mixed>|MapField $var) : $this

Generated from protobuf field map<string, string> headers_to_attributes = 10;

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this

setIncludeHeaders()

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

public setIncludeHeaders(int $var) : $this

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.

Generated from protobuf field .livekit.SIPHeaderOptions include_headers = 15;

Parameters
$var : int
Return values
$this

setKrispEnabled()

Generated from protobuf field <code>bool krisp_enabled = 13;</code>

public setKrispEnabled(bool $var) : $this
Parameters
$var : bool
Return values
$this

setMaxCallDuration()

Max call duration.

public setMaxCallDuration(Duration $var) : $this

Generated from protobuf field .google.protobuf.Duration max_call_duration = 12;

Parameters
$var : Duration
Return values
$this

setMediaEncryption()

Generated from protobuf field <code>.livekit.SIPMediaEncryption media_encryption = 16;</code>

public setMediaEncryption(int $var) : $this
Parameters
$var : int
Return values
$this

setMetadata()

User-defined metadata for the Trunk.

public setMetadata(string $var) : $this

Generated from protobuf field string metadata = 3 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : string
Return values
$this

setName()

Human-readable name for the Trunk.

public setName(string $var) : $this

Generated from protobuf field string name = 2;

Parameters
$var : string
Return values
$this

setNumbers()

Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.

public setNumbers(array<string|int, string> $var) : $this

Creating multiple Trunks with different phone numbers allows having different rules for a single provider.

Generated from protobuf field repeated string numbers = 4;

Parameters
$var : array<string|int, string>
Return values
$this

setRingingTimeout()

Max time for the caller to wait for track subscription.

public setRingingTimeout(Duration $var) : $this

Generated from protobuf field .google.protobuf.Duration ringing_timeout = 11;

Parameters
$var : Duration
Return values
$this

setSipTrunkId()

Generated from protobuf field <code>string sip_trunk_id = 1;</code>

public setSipTrunkId(string $var) : $this
Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results