Table of Contents

Class DialWhatsAppCallRequest

Namespace
LiveKit.Proto
Assembly
LiveKit.AspNetCore.ServerSdk.Abstractions.dll
public sealed class DialWhatsAppCallRequest : IMessage<DialWhatsAppCallRequest>, IEquatable<DialWhatsAppCallRequest>, IDeepCloneable<DialWhatsAppCallRequest>, IBufferMessage, IMessage
Inheritance
DialWhatsAppCallRequest
Implements
IDeepCloneable<DialWhatsAppCallRequest>
IBufferMessage
IMessage
Inherited Members

Constructors

DialWhatsAppCallRequest() 

public DialWhatsAppCallRequest()

DialWhatsAppCallRequest(DialWhatsAppCallRequest) 

public DialWhatsAppCallRequest(DialWhatsAppCallRequest other)

Parameters

other DialWhatsAppCallRequest

Fields

AgentsFieldNumber

Field number for the "agents" field.

public const int AgentsFieldNumber = 6

Field Value

int

DestinationCountryFieldNumber

Field number for the "destination_country" field.

public const int DestinationCountryFieldNumber = 11

Field Value

int

ParticipantAttributesFieldNumber

Field number for the "participant_attributes" field.

public const int ParticipantAttributesFieldNumber = 10

Field Value

int

ParticipantIdentityFieldNumber

Field number for the "participant_identity" field.

public const int ParticipantIdentityFieldNumber = 7

Field Value

int

ParticipantMetadataFieldNumber

Field number for the "participant_metadata" field.

public const int ParticipantMetadataFieldNumber = 9

Field Value

int

ParticipantNameFieldNumber

Field number for the "participant_name" field.

public const int ParticipantNameFieldNumber = 8

Field Value

int

RingingTimeoutFieldNumber

Field number for the "ringing_timeout" field.

public const int RingingTimeoutFieldNumber = 13

Field Value

int

RoomNameFieldNumber

Field number for the "room_name" field.

public const int RoomNameFieldNumber = 5

Field Value

int

WhatsappApiKeyFieldNumber

Field number for the "whatsapp_api_key" field.

public const int WhatsappApiKeyFieldNumber = 3

Field Value

int

WhatsappBizOpaqueCallbackDataFieldNumber

Field number for the "whatsapp_biz_opaque_callback_data" field.

public const int WhatsappBizOpaqueCallbackDataFieldNumber = 4

Field Value

int

WhatsappCloudApiVersionFieldNumber

Field number for the "whatsapp_cloud_api_version" field.

public const int WhatsappCloudApiVersionFieldNumber = 12

Field Value

int

WhatsappPhoneNumberIdFieldNumber

Field number for the "whatsapp_phone_number_id" field.

public const int WhatsappPhoneNumberIdFieldNumber = 1

Field Value

int

WhatsappToPhoneNumberFieldNumber

Field number for the "whatsapp_to_phone_number" field.

public const int WhatsappToPhoneNumberFieldNumber = 2

Field Value

int

Properties

Agents

Optional - Agents to dispatch the call to

public RepeatedField<RoomAgentDispatch> Agents { get; }

Property Value

RepeatedField<RoomAgentDispatch>

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

DestinationCountry

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 string DestinationCountry { get; set; }

Property Value

string

Parser 

public static MessageParser<DialWhatsAppCallRequest> Parser { get; }

Property Value

MessageParser<DialWhatsAppCallRequest>

ParticipantAttributes

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

public MapField<string, string> ParticipantAttributes { get; }

Property Value

MapField<string, string>

ParticipantIdentity

Optional - Identity of the participant in LiveKit room This is used for logging purposes, so it is advised to not put PII in this field.

public string ParticipantIdentity { get; set; }

Property Value

string

ParticipantMetadata

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

public string ParticipantMetadata { get; set; }

Property Value

string

ParticipantName

Optional - Name of the participant in LiveKit room

public string ParticipantName { get; set; }

Property Value

string

RingingTimeout

Max time for the callee to answer the call.

public Duration RingingTimeout { get; set; }

Property Value

Duration

RoomName

Optional - What LiveKit room should this participant be connected too

public string RoomName { get; set; }

Property Value

string

WhatsappApiKey

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

public string WhatsappApiKey { get; set; }

Property Value

string

WhatsappBizOpaqueCallbackData

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

public string WhatsappBizOpaqueCallbackData { get; set; }

Property Value

string

WhatsappCloudApiVersion

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

public string WhatsappCloudApiVersion { get; set; }

Property Value

string

WhatsappPhoneNumberId

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

public string WhatsappPhoneNumberId { get; set; }

Property Value

string

WhatsappToPhoneNumber

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

public string WhatsappToPhoneNumber { get; set; }

Property Value

string

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public DialWhatsAppCallRequest Clone()

Returns

DialWhatsAppCallRequest

A deep clone of this object.

Equals(DialWhatsAppCallRequest) 

public bool Equals(DialWhatsAppCallRequest other)

Parameters

other DialWhatsAppCallRequest

Returns

bool

Equals(object) 

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode() 

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(DialWhatsAppCallRequest)

Merges the given message into this one.

public void MergeFrom(DialWhatsAppCallRequest other)

Parameters

other DialWhatsAppCallRequest

Remarks

See the user guide for precise merge semantics.

ToString() 

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.

Edit this page