Documentation

CreateSIPTrunkRequest extends Message
in package

Generated from protobuf message livekit.CreateSIPTrunkRequest

Table of Contents

Properties

$inbound_password  : mixed
Generated from protobuf field <code>string inbound_password = 6 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
$inbound_username  : mixed
Username and password used to authenticate inbound and outbound SIP invites May be empty to have no Authentication
$metadata  : mixed
Optional user-defined metadata for the Trunk.
$name  : mixed
Optional human-readable name for the Trunk.
$outbound_address  : mixed
IP that SIP INVITE is sent too
$outbound_number  : mixed
Number used to make outbound calls
$outbound_password  : mixed
Generated from protobuf field <code>string outbound_password = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
$outbound_username  : mixed
Generated from protobuf field <code>string outbound_username = 7 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
$inbound_addresses  : mixed
CIDR or IPs that traffic is accepted from An empty list means all inbound traffic is accepted.
$inbound_numbers  : mixed
Accepted `To` values. This Trunk will only accept a call made to these numbers. This allows you to have distinct Trunks for different phone numbers at the same provider.
$inbound_numbers_regex  : mixed
Generated from protobuf field <code>repeated string inbound_numbers_regex = 4 [deprecated = true];</code>

Methods

__construct()  : mixed
Constructor.
getInboundAddresses()  : RepeatedField<string|int, string>
CIDR or IPs that traffic is accepted from An empty list means all inbound traffic is accepted.
getInboundNumbers()  : RepeatedField<string|int, string>
Accepted `To` values. This Trunk will only accept a call made to these numbers. This allows you to have distinct Trunks for different phone numbers at the same provider.
getInboundNumbersRegex()  : RepeatedField<string|int, string>
Generated from protobuf field <code>repeated string inbound_numbers_regex = 4 [deprecated = true];</code>
getInboundPassword()  : string
Generated from protobuf field <code>string inbound_password = 6 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
getInboundUsername()  : string
Username and password used to authenticate inbound and outbound SIP invites May be empty to have no Authentication
getMetadata()  : string
Optional user-defined metadata for the Trunk.
getName()  : string
Optional human-readable name for the Trunk.
getOutboundAddress()  : string
IP that SIP INVITE is sent too
getOutboundNumber()  : string
Number used to make outbound calls
getOutboundPassword()  : string
Generated from protobuf field <code>string outbound_password = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
getOutboundUsername()  : string
Generated from protobuf field <code>string outbound_username = 7 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
setInboundAddresses()  : $this
CIDR or IPs that traffic is accepted from An empty list means all inbound traffic is accepted.
setInboundNumbers()  : $this
Accepted `To` values. This Trunk will only accept a call made to these numbers. This allows you to have distinct Trunks for different phone numbers at the same provider.
setInboundNumbersRegex()  : $this
Generated from protobuf field <code>repeated string inbound_numbers_regex = 4 [deprecated = true];</code>
setInboundPassword()  : $this
Generated from protobuf field <code>string inbound_password = 6 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
setInboundUsername()  : $this
Username and password used to authenticate inbound and outbound SIP invites May be empty to have no Authentication
setMetadata()  : $this
Optional user-defined metadata for the Trunk.
setName()  : $this
Optional human-readable name for the Trunk.
setOutboundAddress()  : $this
IP that SIP INVITE is sent too
setOutboundNumber()  : $this
Number used to make outbound calls
setOutboundPassword()  : $this
Generated from protobuf field <code>string outbound_password = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
setOutboundUsername()  : $this
Generated from protobuf field <code>string outbound_username = 7 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>

Properties

$inbound_password

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

protected mixed $inbound_password = ''

$inbound_username

Username and password used to authenticate inbound and outbound SIP invites May be empty to have no Authentication

protected mixed $inbound_username = ''

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

$metadata

Optional user-defined metadata for the Trunk.

protected mixed $metadata = ''

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

$name

Optional human-readable name for the Trunk.

protected mixed $name = ''

Generated from protobuf field string name = 10;

$outbound_address

IP that SIP INVITE is sent too

protected mixed $outbound_address = ''

Generated from protobuf field string outbound_address = 2;

$outbound_number

Number used to make outbound calls

protected mixed $outbound_number = ''

Generated from protobuf field string outbound_number = 3;

$outbound_password

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

protected mixed $outbound_password = ''

$outbound_username

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

protected mixed $outbound_username = ''

$inbound_addresses

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

private mixed $inbound_addresses

Generated from protobuf field repeated string inbound_addresses = 1;

$inbound_numbers

Accepted `To` values. This Trunk will only accept a call made to these numbers. This allows you to have distinct Trunks for different phone numbers at the same provider.

private mixed $inbound_numbers

Generated from protobuf field repeated string inbound_numbers = 9;

$inbound_numbers_regex

Generated from protobuf field <code>repeated string inbound_numbers_regex = 4 [deprecated = true];</code>

private mixed $inbound_numbers_regex

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[] $inbound_addresses
      CIDR or IPs that traffic is accepted from
      An empty list means all inbound traffic is accepted.
@type string $outbound_address
      IP that SIP INVITE is sent too
@type string $outbound_number
      Number used to make outbound calls
@type string[] $inbound_numbers_regex
@type string[] $inbound_numbers
      Accepted `To` values. This Trunk will only accept a call made to
      these numbers. This allows you to have distinct Trunks for different phone
      numbers at the same provider.
@type string $inbound_username
      Username and password used to authenticate inbound and outbound SIP invites
      May be empty to have no Authentication
@type string $inbound_password
@type string $outbound_username
@type string $outbound_password
@type string $name
      Optional human-readable name for the Trunk.
@type string $metadata
      Optional user-defined metadata for the Trunk.

}

getInboundAddresses()

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

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

Generated from protobuf field repeated string inbound_addresses = 1;

Return values
RepeatedField<string|int, string>

getInboundNumbers()

Accepted `To` values. This Trunk will only accept a call made to these numbers. This allows you to have distinct Trunks for different phone numbers at the same provider.

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

Generated from protobuf field repeated string inbound_numbers = 9;

Return values
RepeatedField<string|int, string>

getInboundNumbersRegex()

Generated from protobuf field <code>repeated string inbound_numbers_regex = 4 [deprecated = true];</code>

public getInboundNumbersRegex() : RepeatedField<string|int, string>
Return values
RepeatedField<string|int, string>

getInboundPassword()

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

public getInboundPassword() : string
Return values
string

getInboundUsername()

Username and password used to authenticate inbound and outbound SIP invites May be empty to have no Authentication

public getInboundUsername() : string

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

Return values
string

getMetadata()

Optional user-defined metadata for the Trunk.

public getMetadata() : string

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

Return values
string

getName()

Optional human-readable name for the Trunk.

public getName() : string

Generated from protobuf field string name = 10;

Return values
string

getOutboundAddress()

IP that SIP INVITE is sent too

public getOutboundAddress() : string

Generated from protobuf field string outbound_address = 2;

Return values
string

getOutboundNumber()

Number used to make outbound calls

public getOutboundNumber() : string

Generated from protobuf field string outbound_number = 3;

Return values
string

getOutboundPassword()

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

public getOutboundPassword() : string
Return values
string

getOutboundUsername()

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

public getOutboundUsername() : string
Return values
string

setInboundAddresses()

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

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

Generated from protobuf field repeated string inbound_addresses = 1;

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

setInboundNumbers()

Accepted `To` values. This Trunk will only accept a call made to these numbers. This allows you to have distinct Trunks for different phone numbers at the same provider.

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

Generated from protobuf field repeated string inbound_numbers = 9;

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

setInboundNumbersRegex()

Generated from protobuf field <code>repeated string inbound_numbers_regex = 4 [deprecated = true];</code>

public setInboundNumbersRegex(array<string|int, string> $var) : $this
Parameters
$var : array<string|int, string>
Return values
$this

setInboundPassword()

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

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

setInboundUsername()

Username and password used to authenticate inbound and outbound SIP invites May be empty to have no Authentication

public setInboundUsername(string $var) : $this

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

Parameters
$var : string
Return values
$this

setMetadata()

Optional user-defined metadata for the Trunk.

public setMetadata(string $var) : $this

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

Parameters
$var : string
Return values
$this

setName()

Optional human-readable name for the Trunk.

public setName(string $var) : $this

Generated from protobuf field string name = 10;

Parameters
$var : string
Return values
$this

setOutboundAddress()

IP that SIP INVITE is sent too

public setOutboundAddress(string $var) : $this

Generated from protobuf field string outbound_address = 2;

Parameters
$var : string
Return values
$this

setOutboundNumber()

Number used to make outbound calls

public setOutboundNumber(string $var) : $this

Generated from protobuf field string outbound_number = 3;

Parameters
$var : string
Return values
$this

setOutboundPassword()

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

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

setOutboundUsername()

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results