Documentation

PhoneNumber extends Message
in package

PhoneNumber - Unified phone number type for inventory and purchased numbers

Generated from protobuf message livekit.PhoneNumber

Table of Contents

Properties

$area_code  : mixed
Area code (e.g., "415")
$assigned_at  : mixed
Assignment timestamp
$country_code  : mixed
Country code (e.g., "US")
$created_at  : mixed
Creation timestamp
$e164_format  : mixed
Phone number in E.164 format (e.g., "+14155552671")
$id  : mixed
Unique identifier
$locality  : mixed
City/locality (e.g., "San Francisco")
$number_type  : mixed
Number type (mobile, local, toll-free, unknown)
$region  : mixed
State/region (e.g., "CA")
$released_at  : mixed
Release timestamp (if applicable)
$sip_dispatch_rule_id  : mixed
Associated SIP dispatch rule ID (deprecated: use sip_dispatch_rule_ids instead)
$spam_score  : mixed
Spam score for fraud detection
$status  : mixed
Current status
$updated_at  : mixed
Last update timestamp
$capabilities  : mixed
Available capabilities (e.g., "voice", "sms")
$sip_dispatch_rule_ids  : mixed
Associated SIP dispatch rule IDs

Methods

__construct()  : mixed
Constructor.
clearAssignedAt()  : mixed
clearCreatedAt()  : mixed
clearReleasedAt()  : mixed
clearUpdatedAt()  : mixed
getAreaCode()  : string
Area code (e.g., "415")
getAssignedAt()  : Timestamp|null
Assignment timestamp
getCapabilities()  : RepeatedField<string|int, string>
Available capabilities (e.g., "voice", "sms")
getCountryCode()  : string
Country code (e.g., "US")
getCreatedAt()  : Timestamp|null
Creation timestamp
getE164Format()  : string
Phone number in E.164 format (e.g., "+14155552671")
getId()  : string
Unique identifier
getLocality()  : string
City/locality (e.g., "San Francisco")
getNumberType()  : int
Number type (mobile, local, toll-free, unknown)
getRegion()  : string
State/region (e.g., "CA")
getReleasedAt()  : Timestamp|null
Release timestamp (if applicable)
getSipDispatchRuleId()  : string
Associated SIP dispatch rule ID (deprecated: use sip_dispatch_rule_ids instead)
getSipDispatchRuleIds()  : RepeatedField<string|int, string>
Associated SIP dispatch rule IDs
getSpamScore()  : float
Spam score for fraud detection
getStatus()  : int
Current status
getUpdatedAt()  : Timestamp|null
Last update timestamp
hasAssignedAt()  : mixed
hasCreatedAt()  : mixed
hasReleasedAt()  : mixed
hasUpdatedAt()  : mixed
setAreaCode()  : $this
Area code (e.g., "415")
setAssignedAt()  : $this
Assignment timestamp
setCapabilities()  : $this
Available capabilities (e.g., "voice", "sms")
setCountryCode()  : $this
Country code (e.g., "US")
setCreatedAt()  : $this
Creation timestamp
setE164Format()  : $this
Phone number in E.164 format (e.g., "+14155552671")
setId()  : $this
Unique identifier
setLocality()  : $this
City/locality (e.g., "San Francisco")
setNumberType()  : $this
Number type (mobile, local, toll-free, unknown)
setRegion()  : $this
State/region (e.g., "CA")
setReleasedAt()  : $this
Release timestamp (if applicable)
setSipDispatchRuleId()  : $this
Associated SIP dispatch rule ID (deprecated: use sip_dispatch_rule_ids instead)
setSipDispatchRuleIds()  : $this
Associated SIP dispatch rule IDs
setSpamScore()  : $this
Spam score for fraud detection
setStatus()  : $this
Current status
setUpdatedAt()  : $this
Last update timestamp

Properties

$area_code

Area code (e.g., "415")

protected mixed $area_code = ''

Generated from protobuf field string area_code = 4;

$assigned_at

Assignment timestamp

protected mixed $assigned_at = null

Generated from protobuf field .google.protobuf.Timestamp assigned_at = 13;

$country_code

Country code (e.g., "US")

protected mixed $country_code = ''

Generated from protobuf field string country_code = 3;

$created_at

Creation timestamp

protected mixed $created_at = null

Generated from protobuf field .google.protobuf.Timestamp created_at = 9;

$e164_format

Phone number in E.164 format (e.g., "+14155552671")

protected mixed $e164_format = ''

Generated from protobuf field string e164_format = 2;

$id

Unique identifier

protected mixed $id = ''

Generated from protobuf field string id = 1;

$locality

City/locality (e.g., "San Francisco")

protected mixed $locality = ''

Generated from protobuf field string locality = 6;

$number_type

Number type (mobile, local, toll-free, unknown)

protected mixed $number_type = 0

Generated from protobuf field .livekit.PhoneNumberType number_type = 5;

$region

State/region (e.g., "CA")

protected mixed $region = ''

Generated from protobuf field string region = 7;

$released_at

Release timestamp (if applicable)

protected mixed $released_at = null

Generated from protobuf field .google.protobuf.Timestamp released_at = 14;

$sip_dispatch_rule_id

Associated SIP dispatch rule ID (deprecated: use sip_dispatch_rule_ids instead)

protected mixed $sip_dispatch_rule_id = ''

Generated from protobuf field string sip_dispatch_rule_id = 15 [deprecated = true];

$spam_score

Spam score for fraud detection

protected mixed $spam_score = 0.0

Generated from protobuf field double spam_score = 8;

$status

Current status

protected mixed $status = 0

Generated from protobuf field .livekit.PhoneNumberStatus status = 12;

$updated_at

Last update timestamp

protected mixed $updated_at = null

Generated from protobuf field .google.protobuf.Timestamp updated_at = 10;

$capabilities

Available capabilities (e.g., "voice", "sms")

private mixed $capabilities

Generated from protobuf field repeated string capabilities = 11;

$sip_dispatch_rule_ids

Associated SIP dispatch rule IDs

private mixed $sip_dispatch_rule_ids

Generated from protobuf field repeated string sip_dispatch_rule_ids = 16;

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 $id
      Unique identifier
@type string $e164_format
      Phone number in E.164 format (e.g., "+14155552671")
@type string $country_code
      Country code (e.g., "US")
@type string $area_code
      Area code (e.g., "415")
@type int $number_type
      Number type (mobile, local, toll-free, unknown)
@type string $locality
      City/locality (e.g., "San Francisco")
@type string $region
      State/region (e.g., "CA")
@type float $spam_score
      Spam score for fraud detection
@type \Google\Protobuf\Timestamp $created_at
      Creation timestamp
@type \Google\Protobuf\Timestamp $updated_at
      Last update timestamp
@type string[] $capabilities
      Available capabilities (e.g., "voice", "sms")
@type int $status
      Current status
@type \Google\Protobuf\Timestamp $assigned_at
      Assignment timestamp
@type \Google\Protobuf\Timestamp $released_at
      Release timestamp (if applicable)
@type string $sip_dispatch_rule_id
      Associated SIP dispatch rule ID (deprecated: use sip_dispatch_rule_ids instead)
@type string[] $sip_dispatch_rule_ids
      Associated SIP dispatch rule IDs

}

getAreaCode()

Area code (e.g., "415")

public getAreaCode() : string

Generated from protobuf field string area_code = 4;

Return values
string

getAssignedAt()

Assignment timestamp

public getAssignedAt() : Timestamp|null

Generated from protobuf field .google.protobuf.Timestamp assigned_at = 13;

Return values
Timestamp|null

getCapabilities()

Available capabilities (e.g., "voice", "sms")

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

Generated from protobuf field repeated string capabilities = 11;

Return values
RepeatedField<string|int, string>

getCountryCode()

Country code (e.g., "US")

public getCountryCode() : string

Generated from protobuf field string country_code = 3;

Return values
string

getCreatedAt()

Creation timestamp

public getCreatedAt() : Timestamp|null

Generated from protobuf field .google.protobuf.Timestamp created_at = 9;

Return values
Timestamp|null

getE164Format()

Phone number in E.164 format (e.g., "+14155552671")

public getE164Format() : string

Generated from protobuf field string e164_format = 2;

Return values
string

getId()

Unique identifier

public getId() : string

Generated from protobuf field string id = 1;

Return values
string

getLocality()

City/locality (e.g., "San Francisco")

public getLocality() : string

Generated from protobuf field string locality = 6;

Return values
string

getNumberType()

Number type (mobile, local, toll-free, unknown)

public getNumberType() : int

Generated from protobuf field .livekit.PhoneNumberType number_type = 5;

Return values
int

getRegion()

State/region (e.g., "CA")

public getRegion() : string

Generated from protobuf field string region = 7;

Return values
string

getReleasedAt()

Release timestamp (if applicable)

public getReleasedAt() : Timestamp|null

Generated from protobuf field .google.protobuf.Timestamp released_at = 14;

Return values
Timestamp|null

getSipDispatchRuleId()

Associated SIP dispatch rule ID (deprecated: use sip_dispatch_rule_ids instead)

public getSipDispatchRuleId() : string

Generated from protobuf field string sip_dispatch_rule_id = 15 [deprecated = true];

Return values
string

getSipDispatchRuleIds()

Associated SIP dispatch rule IDs

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

Generated from protobuf field repeated string sip_dispatch_rule_ids = 16;

Return values
RepeatedField<string|int, string>

getSpamScore()

Spam score for fraud detection

public getSpamScore() : float

Generated from protobuf field double spam_score = 8;

Return values
float

getStatus()

Current status

public getStatus() : int

Generated from protobuf field .livekit.PhoneNumberStatus status = 12;

Return values
int

getUpdatedAt()

Last update timestamp

public getUpdatedAt() : Timestamp|null

Generated from protobuf field .google.protobuf.Timestamp updated_at = 10;

Return values
Timestamp|null

setAreaCode()

Area code (e.g., "415")

public setAreaCode(string $var) : $this

Generated from protobuf field string area_code = 4;

Parameters
$var : string
Return values
$this

setAssignedAt()

Assignment timestamp

public setAssignedAt(Timestamp $var) : $this

Generated from protobuf field .google.protobuf.Timestamp assigned_at = 13;

Parameters
$var : Timestamp
Return values
$this

setCapabilities()

Available capabilities (e.g., "voice", "sms")

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

Generated from protobuf field repeated string capabilities = 11;

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

setCountryCode()

Country code (e.g., "US")

public setCountryCode(string $var) : $this

Generated from protobuf field string country_code = 3;

Parameters
$var : string
Return values
$this

setCreatedAt()

Creation timestamp

public setCreatedAt(Timestamp $var) : $this

Generated from protobuf field .google.protobuf.Timestamp created_at = 9;

Parameters
$var : Timestamp
Return values
$this

setE164Format()

Phone number in E.164 format (e.g., "+14155552671")

public setE164Format(string $var) : $this

Generated from protobuf field string e164_format = 2;

Parameters
$var : string
Return values
$this

setId()

Unique identifier

public setId(string $var) : $this

Generated from protobuf field string id = 1;

Parameters
$var : string
Return values
$this

setLocality()

City/locality (e.g., "San Francisco")

public setLocality(string $var) : $this

Generated from protobuf field string locality = 6;

Parameters
$var : string
Return values
$this

setNumberType()

Number type (mobile, local, toll-free, unknown)

public setNumberType(int $var) : $this

Generated from protobuf field .livekit.PhoneNumberType number_type = 5;

Parameters
$var : int
Return values
$this

setRegion()

State/region (e.g., "CA")

public setRegion(string $var) : $this

Generated from protobuf field string region = 7;

Parameters
$var : string
Return values
$this

setReleasedAt()

Release timestamp (if applicable)

public setReleasedAt(Timestamp $var) : $this

Generated from protobuf field .google.protobuf.Timestamp released_at = 14;

Parameters
$var : Timestamp
Return values
$this

setSipDispatchRuleId()

Associated SIP dispatch rule ID (deprecated: use sip_dispatch_rule_ids instead)

public setSipDispatchRuleId(string $var) : $this

Generated from protobuf field string sip_dispatch_rule_id = 15 [deprecated = true];

Parameters
$var : string
Return values
$this

setSipDispatchRuleIds()

Associated SIP dispatch rule IDs

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

Generated from protobuf field repeated string sip_dispatch_rule_ids = 16;

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

setSpamScore()

Spam score for fraud detection

public setSpamScore(float $var) : $this

Generated from protobuf field double spam_score = 8;

Parameters
$var : float
Return values
$this

setStatus()

Current status

public setStatus(int $var) : $this

Generated from protobuf field .livekit.PhoneNumberStatus status = 12;

Parameters
$var : int
Return values
$this

setUpdatedAt()

Last update timestamp

public setUpdatedAt(Timestamp $var) : $this

Generated from protobuf field .google.protobuf.Timestamp updated_at = 10;

Parameters
$var : Timestamp
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results