LiveKit JS Server SDK - v2.15.0
    Preparing search index...

    Interface DialWhatsAppCallOptions

    interface DialWhatsAppCallOptions {
        agents?: RoomAgentDispatch[];
        destinationCountry?: string;
        participantAttributes?: { [key: string]: string };
        participantIdentity?: string;
        participantMetadata?: string;
        participantName?: string;
        roomName?: string;
        whatsappApiKey: string;
        whatsappBizOpaqueCallbackData?: string;
        whatsappCloudApiVersion: string;
        whatsappPhoneNumberId: string;
        whatsappToPhoneNumber: string;
    }
    Index

    Properties

    agents? destinationCountry? participantAttributes? participantIdentity? participantMetadata? participantName? roomName? whatsappApiKey whatsappBizOpaqueCallbackData? whatsappCloudApiVersion whatsappPhoneNumberId whatsappToPhoneNumber

    Properties

    agents?: RoomAgentDispatch[]

    Optional - Agents to dispatch the call to

    destinationCountry?: string

    Optional - Country where the call terminates as ISO 3166-1 alpha-2

    participantAttributes?: { [key: string]: string }

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

    participantIdentity?: string

    Optional - Identity of the participant in LiveKit room

    participantMetadata?: string

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

    participantName?: string

    Optional - Name of the participant in LiveKit room

    roomName?: string

    Optional - What LiveKit room should this participant be connected to

    whatsappApiKey: string

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

    whatsappBizOpaqueCallbackData?: string

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

    whatsappCloudApiVersion: string

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

    whatsappPhoneNumberId: string

    Required - The identifier of the WhatsApp phone number that is initiating the call

    whatsappToPhoneNumber: string

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

    Settings

    Member Visibility

    On This Page

    Properties