Documentation

DisconnectWhatsAppCallRequest extends Message
in package

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

Table of Contents

Properties

$disconnect_reason  : mixed
The reason for disconnecting the call
$whatsapp_api_key  : mixed
The API key of the whatsapp business.
$whatsapp_call_id  : mixed
Required - Call ID sent by Meta

Methods

__construct()  : mixed
Constructor.
getDisconnectReason()  : int
The reason for disconnecting the call
getWhatsappApiKey()  : string
The API key of the whatsapp business.
getWhatsappCallId()  : string
Required - Call ID sent by Meta
setDisconnectReason()  : $this
The reason for disconnecting the call
setWhatsappApiKey()  : $this
The API key of the whatsapp business.
setWhatsappCallId()  : $this
Required - Call ID sent by Meta

Properties

$disconnect_reason

The reason for disconnecting the call

protected mixed $disconnect_reason = 0

Generated from protobuf field .livekit.DisconnectWhatsAppCallRequest.DisconnectReason disconnect_reason = 3;

$whatsapp_api_key

The API key of the whatsapp business.

protected mixed $whatsapp_api_key = ''

Required if the DisconnectReason is BUSINESS_INITIATED. Optional for USER_INITIATED as no API call to WhatsApp is needed.

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

$whatsapp_call_id

Required - Call ID sent by Meta

protected mixed $whatsapp_call_id = ''

Generated from protobuf field string whatsapp_call_id = 1;

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_call_id
      Required - Call ID sent by Meta
@type string $whatsapp_api_key
      The API key of the whatsapp business.
      Required if the DisconnectReason is BUSINESS_INITIATED.
      Optional for  USER_INITIATED as no API call to WhatsApp is needed.
@type int $disconnect_reason
      The reason for disconnecting the call

}

getDisconnectReason()

The reason for disconnecting the call

public getDisconnectReason() : int

Generated from protobuf field .livekit.DisconnectWhatsAppCallRequest.DisconnectReason disconnect_reason = 3;

Return values
int

getWhatsappApiKey()

The API key of the whatsapp business.

public getWhatsappApiKey() : string

Required if the DisconnectReason is BUSINESS_INITIATED. Optional for USER_INITIATED as no API call to WhatsApp is needed.

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

Return values
string

getWhatsappCallId()

Required - Call ID sent by Meta

public getWhatsappCallId() : string

Generated from protobuf field string whatsapp_call_id = 1;

Return values
string

setDisconnectReason()

The reason for disconnecting the call

public setDisconnectReason(int $var) : $this

Generated from protobuf field .livekit.DisconnectWhatsAppCallRequest.DisconnectReason disconnect_reason = 3;

Parameters
$var : int
Return values
$this

setWhatsappApiKey()

The API key of the whatsapp business.

public setWhatsappApiKey(string $var) : $this

Required if the DisconnectReason is BUSINESS_INITIATED. Optional for USER_INITIATED as no API call to WhatsApp is needed.

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

Parameters
$var : string
Return values
$this

setWhatsappCallId()

Required - Call ID sent by Meta

public setWhatsappCallId(string $var) : $this

Generated from protobuf field string whatsapp_call_id = 1;

Parameters
$var : string
Return values
$this

        
On this page

Search results