Documentation

DialWhatsAppCallRequest extends Message
in package

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

Table of Contents

Properties

$destination_country  : mixed
Optional - 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
Optional - What LiveKit room should this participant be connected too
$whatsapp_api_key  : mixed
Required - The API key of the business that is initiating the call
$whatsapp_biz_opaque_callback_data  : mixed
Optional - An arbitrary string you can pass in that is useful for tracking and logging purposes.
$whatsapp_cloud_api_version  : mixed
Required - WhatsApp Cloud API version, eg: 23.0, 24.0, etc.
$whatsapp_phone_number_id  : mixed
Required - The number of the business that is initiating the call
$whatsapp_to_phone_number  : mixed
Required - The number of the user that is supossed to receive 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
Optional - 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
Optional - What LiveKit room should this participant be connected too
getWhatsappApiKey()  : string
Required - The API key of the business that is initiating the call
getWhatsappBizOpaqueCallbackData()  : string
Optional - An arbitrary string you can pass in that is useful for tracking and logging purposes.
getWhatsappCloudApiVersion()  : string
Required - WhatsApp Cloud API version, eg: 23.0, 24.0, etc.
getWhatsappPhoneNumberId()  : string
Required - The number of the business that is initiating the call
getWhatsappToPhoneNumber()  : string
Required - The number of the user that is supossed to receive the call
setAgents()  : $this
Optional - Agents to dispatch the call to
setDestinationCountry()  : $this
Optional - 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
Optional - What LiveKit room should this participant be connected too
setWhatsappApiKey()  : $this
Required - The API key of the business that is initiating the call
setWhatsappBizOpaqueCallbackData()  : $this
Optional - An arbitrary string you can pass in that is useful for tracking and logging purposes.
setWhatsappCloudApiVersion()  : $this
Required - WhatsApp Cloud API version, eg: 23.0, 24.0, etc.
setWhatsappPhoneNumberId()  : $this
Required - The number of the business that is initiating the call
setWhatsappToPhoneNumber()  : $this
Required - The number of the user that is supossed to receive the call

Properties

$destination_country

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

$participant_identity

Optional - Identity of the participant in LiveKit room

protected mixed $participant_identity = ''

Generated from protobuf field string participant_identity = 7;

$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 = 9 [(.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 = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

$room_name

Optional - What LiveKit room should this participant be connected too

protected mixed $room_name = ''

Generated from protobuf field string room_name = 5;

$whatsapp_api_key

Required - The API key of the business that is initiating the call

protected mixed $whatsapp_api_key = ''

Generated from protobuf field string whatsapp_api_key = 3 [(.logger.redact) = true];

$whatsapp_biz_opaque_callback_data

Optional - An arbitrary string you can pass in that is useful for tracking and logging purposes.

protected mixed $whatsapp_biz_opaque_callback_data = ''

Generated from protobuf field string whatsapp_biz_opaque_callback_data = 4;

$whatsapp_cloud_api_version

Required - WhatsApp Cloud API version, eg: 23.0, 24.0, etc.

protected mixed $whatsapp_cloud_api_version = ''

Generated from protobuf field string whatsapp_cloud_api_version = 12;

$whatsapp_phone_number_id

Required - The number of the business that is initiating the call

protected mixed $whatsapp_phone_number_id = ''

Generated from protobuf field string whatsapp_phone_number_id = 1;

$whatsapp_to_phone_number

Required - The number of the user that is supossed to receive the call

protected mixed $whatsapp_to_phone_number = ''

Generated from protobuf field string whatsapp_to_phone_number = 2;

$agents

Optional - Agents to dispatch the call to

private mixed $agents

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

$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 = 10 [(.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 string $whatsapp_phone_number_id
      Required - The number of the business that is initiating the call
@type string $whatsapp_to_phone_number
      Required - The number of the user that is supossed to receive the call
@type string $whatsapp_api_key
      Required - The API key of the business that is initiating the call
@type string $whatsapp_cloud_api_version
      Required - WhatsApp Cloud API version, eg: 23.0, 24.0, etc.
@type string $whatsapp_biz_opaque_callback_data
      Optional - An arbitrary string you can pass in that is useful for tracking and logging purposes.
@type string $room_name
      Optional - What LiveKit room should this participant be connected too
@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
      Optional - 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()

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

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 = 10 [(.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 = 7;

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 = 9 [(.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 = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
string

getRoomName()

Optional - What LiveKit room should this participant be connected too

public getRoomName() : string

Generated from protobuf field string room_name = 5;

Return values
string

getWhatsappApiKey()

Required - The API key of the business that is initiating the call

public getWhatsappApiKey() : string

Generated from protobuf field string whatsapp_api_key = 3 [(.logger.redact) = true];

Return values
string

getWhatsappBizOpaqueCallbackData()

Optional - An arbitrary string you can pass in that is useful for tracking and logging purposes.

public getWhatsappBizOpaqueCallbackData() : string

Generated from protobuf field string whatsapp_biz_opaque_callback_data = 4;

Return values
string

getWhatsappCloudApiVersion()

Required - WhatsApp Cloud API version, eg: 23.0, 24.0, etc.

public getWhatsappCloudApiVersion() : string

Generated from protobuf field string whatsapp_cloud_api_version = 12;

Return values
string

getWhatsappPhoneNumberId()

Required - The number of the business that is initiating the call

public getWhatsappPhoneNumberId() : string

Generated from protobuf field string whatsapp_phone_number_id = 1;

Return values
string

getWhatsappToPhoneNumber()

Required - The number of the user that is supossed to receive the call

public getWhatsappToPhoneNumber() : string

Generated from protobuf field string whatsapp_to_phone_number = 2;

Return values
string

setAgents()

Optional - Agents to dispatch the call to

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

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

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

setDestinationCountry()

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

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 = 10 [(.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 = 7;

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 = 9 [(.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 = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : string
Return values
$this

setRoomName()

Optional - What LiveKit room should this participant be connected too

public setRoomName(string $var) : $this

Generated from protobuf field string room_name = 5;

Parameters
$var : string
Return values
$this

setWhatsappApiKey()

Required - The API key of the business that is initiating the call

public setWhatsappApiKey(string $var) : $this

Generated from protobuf field string whatsapp_api_key = 3 [(.logger.redact) = true];

Parameters
$var : string
Return values
$this

setWhatsappBizOpaqueCallbackData()

Optional - An arbitrary string you can pass in that is useful for tracking and logging purposes.

public setWhatsappBizOpaqueCallbackData(string $var) : $this

Generated from protobuf field string whatsapp_biz_opaque_callback_data = 4;

Parameters
$var : string
Return values
$this

setWhatsappCloudApiVersion()

Required - WhatsApp Cloud API version, eg: 23.0, 24.0, etc.

public setWhatsappCloudApiVersion(string $var) : $this

Generated from protobuf field string whatsapp_cloud_api_version = 12;

Parameters
$var : string
Return values
$this

setWhatsappPhoneNumberId()

Required - The number of the business that is initiating the call

public setWhatsappPhoneNumberId(string $var) : $this

Generated from protobuf field string whatsapp_phone_number_id = 1;

Parameters
$var : string
Return values
$this

setWhatsappToPhoneNumber()

Required - The number of the user that is supossed to receive the call

public setWhatsappToPhoneNumber(string $var) : $this

Generated from protobuf field string whatsapp_to_phone_number = 2;

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results