Documentation

SIPOutboundTrunkInfo extends Message
in package

Application

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

Properties

$address : mixed: Hostname or IP that SIP INVITE is sent too.
$auth_password : mixed: Generated from protobuf field <code>string auth_password = 8 [(.logger.redact) = true];</code>
$auth_username : mixed: Username and password used to authenticate with SIP server.
$created_at : mixed: Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 16;</code>
$destination_country : mixed: 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.
$from_host : mixed: Optional custom hostname for the 'From' SIP header in outbound INVITEs.
$include_headers : mixed: Map SIP headers from 200 OK to sip.h.* participant attributes automatically.
$media_encryption : mixed: Generated from protobuf field <code>.livekit.SIPMediaEncryption media_encryption = 13;</code>
$metadata : mixed: User-defined metadata for the Trunk.
$name : mixed: Human-readable name for the Trunk.
$sip_trunk_id : mixed: Generated from protobuf field <code>string sip_trunk_id = 1 [(.logger.name) = "sipTrunkID"];</code>
$transport : mixed: SIP Transport used for outbound call.
$updated_at : mixed: Generated from protobuf field <code>.google.protobuf.Timestamp updated_at = 17;</code>
$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 INVITE request.
$headers_to_attributes : mixed: Map SIP X-* headers from 200 OK to SIP participant attributes.
$numbers : mixed: Numbers used to make the calls. Random one from this list will be selected.

Methods

__construct() : mixed: Constructor.
clearCreatedAt() : mixed
clearUpdatedAt() : mixed
getAddress() : string: Hostname or IP that SIP INVITE is sent too.
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];</code>
getAuthUsername() : string: Username and password used to authenticate with SIP server.
getCreatedAt() : Timestamp|null: Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 16;</code>
getDestinationCountry() : 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.
getFromHost() : string: Optional custom hostname for the 'From' SIP header in outbound INVITEs.
getHeaders() : MapField: Include these SIP X-* headers in INVITE request.
getHeadersToAttributes() : MapField: Map SIP X-* headers from 200 OK to SIP participant attributes.
getIncludeHeaders() : int: Map SIP headers from 200 OK to sip.h.* participant attributes automatically.
getMediaEncryption() : int: Generated from protobuf field <code>.livekit.SIPMediaEncryption media_encryption = 13;</code>
getMetadata() : string: User-defined metadata for the Trunk.
getName() : string: Human-readable name for the Trunk.
getNumbers() : RepeatedField<string|int, string>: Numbers used to make the calls. Random one from this list will be selected.
getSipTrunkId() : string: Generated from protobuf field <code>string sip_trunk_id = 1 [(.logger.name) = "sipTrunkID"];</code>
getTransport() : int: SIP Transport used for outbound call.
getUpdatedAt() : Timestamp|null: Generated from protobuf field <code>.google.protobuf.Timestamp updated_at = 17;</code>
hasCreatedAt() : mixed
hasUpdatedAt() : mixed
setAddress() : $this: Hostname or IP that SIP INVITE is sent too.
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];</code>
setAuthUsername() : $this: Username and password used to authenticate with SIP server.
setCreatedAt() : $this: Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 16;</code>
setDestinationCountry() : $this: 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.
setFromHost() : $this: Optional custom hostname for the 'From' SIP header in outbound INVITEs.
setHeaders() : $this: Include these SIP X-* headers in INVITE request.
setHeadersToAttributes() : $this: Map SIP X-* headers from 200 OK to SIP participant attributes.
setIncludeHeaders() : $this: Map SIP headers from 200 OK to sip.h.* participant attributes automatically.
setMediaEncryption() : $this: Generated from protobuf field <code>.livekit.SIPMediaEncryption media_encryption = 13;</code>
setMetadata() : $this: User-defined metadata for the Trunk.
setName() : $this: Human-readable name for the Trunk.
setNumbers() : $this: Numbers used to make the calls. Random one from this list will be selected.
setSipTrunkId() : $this: Generated from protobuf field <code>string sip_trunk_id = 1 [(.logger.name) = "sipTrunkID"];</code>
setTransport() : $this: SIP Transport used for outbound call.
setUpdatedAt() : $this: Generated from protobuf field <code>.google.protobuf.Timestamp updated_at = 17;</code>

$address

Hostname or IP that SIP INVITE is sent too.


        protected
            mixed
    $address
     = ''

Note that this is not a SIP URI and should not contain the 'sip:' protocol prefix.

Generated from protobuf field string address = 4;

$auth_password

Generated from protobuf field <code>string auth_password = 8 [(.logger.redact) = true];</code>


        protected
            mixed
    $auth_password
     = ''

$auth_username

Username and password used to authenticate with SIP server.


        protected
            mixed
    $auth_username
     = ''

May be empty to have no authentication.

Generated from protobuf field string auth_username = 7 [(.logger.redact) = true];

$created_at

Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 16;</code>


        protected
            mixed
    $created_at
     = null

$destination_country

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.


        protected
            mixed
    $destination_country
     = ''

Generated from protobuf field string destination_country = 14;

$from_host

Optional custom hostname for the 'From' SIP header in outbound INVITEs.


        protected
            mixed
    $from_host
     = ''

When set, outbound calls from this trunk will use this host instead of the default project SIP domain. Enables originating calls from custom domains.

Generated from protobuf field string from_host = 15;

$include_headers

Map SIP headers from 200 OK 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 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.

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

$media_encryption

Generated from protobuf field <code>.livekit.SIPMediaEncryption media_encryption = 13;</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;

$sip_trunk_id

Generated from protobuf field <code>string sip_trunk_id = 1 [(.logger.name) = "sipTrunkID"];</code>


        protected
            mixed
    $sip_trunk_id
     = ''

$transport

SIP Transport used for outbound call.


        protected
            mixed
    $transport
     = 0

Generated from protobuf field .livekit.SIPTransport transport = 5;

$updated_at

Generated from protobuf field <code>.google.protobuf.Timestamp updated_at = 17;</code>


        protected
            mixed
    $updated_at
     = null

$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 = 11;

$headers

Include these SIP X-* headers in INVITE request.


        private
            mixed
    $headers

These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.

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 200 OK to SIP participant attributes.


        private
            mixed
    $headers_to_attributes

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

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

$numbers

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


        private
            mixed
    $numbers

Generated from protobuf field repeated string numbers = 6;

__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 $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.
@type string $destination_country
      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.
@type int $transport
      SIP Transport used for outbound call.
@type string[] $numbers
      Numbers used to make the calls. Random one from this list will be selected.
@type string $auth_username
      Username and password used to authenticate with SIP server.
      May be empty to have no authentication.
@type string $auth_password
@type array|\Google\Protobuf\Internal\MapField $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.
@type array|\Google\Protobuf\Internal\MapField $headers_to_attributes
      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.
@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 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.
@type int $media_encryption
@type string $from_host
      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.
@type \Google\Protobuf\Timestamp $created_at
@type \Google\Protobuf\Timestamp $updated_at

}

clearCreatedAt()


    public
                    clearCreatedAt() : mixed

clearUpdatedAt()


    public
                    clearUpdatedAt() : mixed

getAddress()

Hostname or IP that SIP INVITE is sent too.


    public
                    getAddress() : string

Note that this is not a SIP URI and should not contain the 'sip:' protocol prefix.

Generated from protobuf field string address = 4;

Return values

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 = 11;

Return values

MapField

getAuthPassword()

Generated from protobuf field <code>string auth_password = 8 [(.logger.redact) = true];</code>


    public
                    getAuthPassword() : string

Return values

string

getAuthUsername()

Username and password used to authenticate with SIP server.


    public
                    getAuthUsername() : string

May be empty to have no authentication.

Generated from protobuf field string auth_username = 7 [(.logger.redact) = true];

Return values

string

getCreatedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 16;</code>


    public
                    getCreatedAt() : Timestamp|null

Return values

Timestamp|null

getDestinationCountry()

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
                    getDestinationCountry() : string

Generated from protobuf field string destination_country = 14;

Return values

string

getFromHost()

Optional custom hostname for the 'From' SIP header in outbound INVITEs.


    public
                    getFromHost() : string

When set, outbound calls from this trunk will use this host instead of the default project SIP domain. Enables originating calls from custom domains.

Generated from protobuf field string from_host = 15;

Return values

string

getHeaders()

Include these SIP X-* headers in INVITE request.


    public
                    getHeaders() : MapField

These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.

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 200 OK to SIP participant attributes.


    public
                    getHeadersToAttributes() : MapField

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

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

Return values

MapField

getIncludeHeaders()

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


    public
                    getIncludeHeaders() : int

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

Return values

int

getMediaEncryption()

Generated from protobuf field <code>.livekit.SIPMediaEncryption media_encryption = 13;</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 used to make the calls. Random one from this list will be selected.


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

Generated from protobuf field repeated string numbers = 6;

Return values

RepeatedField<string|int, string>

getSipTrunkId()

Generated from protobuf field <code>string sip_trunk_id = 1 [(.logger.name) = "sipTrunkID"];</code>


    public
                    getSipTrunkId() : string

Return values

string

getTransport()

SIP Transport used for outbound call.


    public
                    getTransport() : int

Generated from protobuf field .livekit.SIPTransport transport = 5;

Return values

int

getUpdatedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp updated_at = 17;</code>


    public
                    getUpdatedAt() : Timestamp|null

Return values

Timestamp|null

hasCreatedAt()


    public
                    hasCreatedAt() : mixed

hasUpdatedAt()


    public
                    hasUpdatedAt() : mixed

setAddress()

Hostname or IP that SIP INVITE is sent too.


    public
                    setAddress(string $var) : $this

Note that this is not a SIP URI and should not contain the 'sip:' protocol prefix.

Generated from protobuf field string address = 4;

Parameters

$var : 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 = 11;

Parameters

$var : array<string|int, mixed>|MapField

Return values

$this

setAuthPassword()

Generated from protobuf field <code>string auth_password = 8 [(.logger.redact) = true];</code>


    public
                    setAuthPassword(string $var) : $this

Parameters

$var : string

Return values

$this

setAuthUsername()

Username and password used to authenticate with SIP server.


    public
                    setAuthUsername(string $var) : $this

May be empty to have no authentication.

Generated from protobuf field string auth_username = 7 [(.logger.redact) = true];

Parameters

$var : string

Return values

$this

setCreatedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 16;</code>


    public
                    setCreatedAt(Timestamp $var) : $this

Parameters

$var : Timestamp

Return values

$this

setDestinationCountry()

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
                    setDestinationCountry(string $var) : $this

Generated from protobuf field string destination_country = 14;

Parameters

$var : string

Return values

$this

setFromHost()

Optional custom hostname for the 'From' SIP header in outbound INVITEs.


    public
                    setFromHost(string $var) : $this

When set, outbound calls from this trunk will use this host instead of the default project SIP domain. Enables originating calls from custom domains.

Generated from protobuf field string from_host = 15;

Parameters

$var : string

Return values

$this

setHeaders()

Include these SIP X-* headers in INVITE request.


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

These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.

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 200 OK to SIP participant attributes.


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

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

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 200 OK to sip.h.* participant attributes automatically.


    public
                    setIncludeHeaders(int $var) : $this

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

Parameters

$var : int

Return values

$this

setMediaEncryption()

Generated from protobuf field <code>.livekit.SIPMediaEncryption media_encryption = 13;</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 used to make the calls. Random one from this list will be selected.


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

Generated from protobuf field repeated string numbers = 6;

Parameters

$var : array<string|int, string>

Return values

$this

setSipTrunkId()

Generated from protobuf field <code>string sip_trunk_id = 1 [(.logger.name) = "sipTrunkID"];</code>


    public
                    setSipTrunkId(string $var) : $this

Parameters

$var : string

Return values

$this

setTransport()

SIP Transport used for outbound call.


    public
                    setTransport(int $var) : $this

Generated from protobuf field .livekit.SIPTransport transport = 5;

Parameters

$var : int

Return values

$this

setUpdatedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp updated_at = 17;</code>


    public
                    setUpdatedAt(Timestamp $var) : $this

Parameters

$var : Timestamp

Return values

$this

SIPOutboundTrunkInfo extends Message in package Application

Table of Contents

Properties

Methods

Properties

$address

$auth_password

$auth_username

$created_at

$destination_country

$from_host

$include_headers

$media_encryption

$metadata

$name

$sip_trunk_id

$transport

$updated_at

$attributes_to_headers

$headers

$headers_to_attributes

$numbers

Methods

__construct()

Parameters

clearCreatedAt()

clearUpdatedAt()

getAddress()

Return values

getAttributesToHeaders()

Return values

getAuthPassword()

Return values

getAuthUsername()

Return values

getCreatedAt()

Return values

getDestinationCountry()

Return values

getFromHost()

Return values

getHeaders()

Return values

getHeadersToAttributes()

Return values

getIncludeHeaders()

Return values

getMediaEncryption()

Return values

getMetadata()

Return values

getName()

Return values

getNumbers()

Return values

getSipTrunkId()

Return values

getTransport()

Return values

getUpdatedAt()

Return values

hasCreatedAt()

hasUpdatedAt()

setAddress()

Parameters

Return values

setAttributesToHeaders()

Parameters

Return values

setAuthPassword()

Parameters

Return values

setAuthUsername()

Parameters

Return values

setCreatedAt()

Parameters

Return values

setDestinationCountry()

Parameters

SIPOutboundTrunkInfo extends Message
in package

Application