Documentation

ConnectTwilioCallRequest extends Message
in package

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

Table of Contents

Properties

$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.
$participant_identity  : mixed
Optional identity of the participant in LiveKit room
$participant_metadata  : mixed
Optional user-defined metadata. Will be attached to a created Participant in the room.
$participant_name  : mixed
Optional name of the participant in LiveKit room
$room_name  : mixed
What LiveKit room should this call be connected to
$twilio_call_direction  : mixed
The Direction of the call
$agents  : mixed
Optional agents to dispatch the call to
$participant_attributes  : mixed
Optional user-defined attributes. Will be attached to a created Participant in the room.

Methods

__construct()  : mixed
Constructor.
getAgents()  : RepeatedField<string|int, RoomAgentDispatch>
Optional agents to dispatch the call to
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.
getParticipantAttributes()  : MapField
Optional user-defined attributes. Will be attached to a created Participant in the room.
getParticipantIdentity()  : string
Optional identity of the participant in LiveKit room
getParticipantMetadata()  : string
Optional user-defined metadata. Will be attached to a created Participant in the room.
getParticipantName()  : string
Optional name of the participant in LiveKit room
getRoomName()  : string
What LiveKit room should this call be connected to
getTwilioCallDirection()  : int
The Direction of the call
setAgents()  : $this
Optional agents to dispatch the call to
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.
setParticipantAttributes()  : $this
Optional user-defined attributes. Will be attached to a created Participant in the room.
setParticipantIdentity()  : $this
Optional identity of the participant in LiveKit room
setParticipantMetadata()  : $this
Optional user-defined metadata. Will be attached to a created Participant in the room.
setParticipantName()  : $this
Optional name of the participant in LiveKit room
setRoomName()  : $this
What LiveKit room should this call be connected to
setTwilioCallDirection()  : $this
The Direction of the call

Properties

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

$participant_identity

Optional identity of the participant in LiveKit room

protected mixed $participant_identity = ''

Generated from protobuf field string participant_identity = 4;

$participant_metadata

Optional user-defined metadata. Will be attached to a created Participant in the room.

protected mixed $participant_metadata = ''

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

$participant_name

Optional name of the participant in LiveKit room

protected mixed $participant_name = ''

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

$room_name

What LiveKit room should this call be connected to

protected mixed $room_name = ''

Generated from protobuf field string room_name = 2;

$twilio_call_direction

The Direction of the call

protected mixed $twilio_call_direction = 0

Generated from protobuf field .livekit.ConnectTwilioCallRequest.TwilioCallDirection twilio_call_direction = 1;

$agents

Optional agents to dispatch the call to

private mixed $agents

Generated from protobuf field repeated .livekit.RoomAgentDispatch agents = 3;

$participant_attributes

Optional user-defined attributes. Will be attached to a created Participant in the room.

private mixed $participant_attributes

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

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 int $twilio_call_direction
      The Direction of the call
@type string $room_name
      What LiveKit room should this call be connected to
@type \Livekit\RoomAgentDispatch[] $agents
      Optional agents to dispatch the call to
@type string $participant_identity
      Optional identity of the participant in LiveKit room
@type string $participant_name
      Optional name of the participant in LiveKit room
@type string $participant_metadata
      Optional user-defined metadata. Will be attached to a created Participant in the room.
@type array|\Google\Protobuf\Internal\MapField $participant_attributes
      Optional user-defined attributes. Will be attached to a created Participant in the room.
@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.

}

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

Return values
string

getParticipantAttributes()

Optional user-defined attributes. Will be attached to a created Participant in the room.

public getParticipantAttributes() : MapField

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

Return values
MapField

getParticipantIdentity()

Optional identity of the participant in LiveKit room

public getParticipantIdentity() : string

Generated from protobuf field string participant_identity = 4;

Return values
string

getParticipantMetadata()

Optional user-defined metadata. Will be attached to a created Participant in the room.

public getParticipantMetadata() : string

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

Return values
string

getParticipantName()

Optional name of the participant in LiveKit room

public getParticipantName() : string

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

Return values
string

getRoomName()

What LiveKit room should this call be connected to

public getRoomName() : string

Generated from protobuf field string room_name = 2;

Return values
string

getTwilioCallDirection()

The Direction of the call

public getTwilioCallDirection() : int

Generated from protobuf field .livekit.ConnectTwilioCallRequest.TwilioCallDirection twilio_call_direction = 1;

Return values
int

setAgents()

Optional agents to dispatch the call to

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

Generated from protobuf field repeated .livekit.RoomAgentDispatch agents = 3;

Parameters
$var : array<string|int, RoomAgentDispatch>
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 = 8;

Parameters
$var : string
Return values
$this

setParticipantAttributes()

Optional user-defined attributes. Will be attached to a created Participant in the room.

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

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

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

setParticipantIdentity()

Optional identity of the participant in LiveKit room

public setParticipantIdentity(string $var) : $this

Generated from protobuf field string participant_identity = 4;

Parameters
$var : string
Return values
$this

setParticipantMetadata()

Optional user-defined metadata. Will be attached to a created Participant in the room.

public setParticipantMetadata(string $var) : $this

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

Parameters
$var : string
Return values
$this

setParticipantName()

Optional name of the participant in LiveKit room

public setParticipantName(string $var) : $this

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

Parameters
$var : string
Return values
$this

setRoomName()

What LiveKit room should this call be connected to

public setRoomName(string $var) : $this

Generated from protobuf field string room_name = 2;

Parameters
$var : string
Return values
$this

setTwilioCallDirection()

The Direction of the call

public setTwilioCallDirection(int $var) : $this

Generated from protobuf field .livekit.ConnectTwilioCallRequest.TwilioCallDirection twilio_call_direction = 1;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results