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

    Interface AcceptWhatsAppCallOptions

    interface AcceptWhatsAppCallOptions {
        agents?: RoomAgentDispatch[];
        destinationCountry?: string;
        participantAttributes?: { [key: string]: string };
        participantIdentity?: string;
        participantMetadata?: string;
        participantName?: string;
        roomName?: string;
        sdp: SessionDescription;
        timeout?: number;
        waitUntilAnswered?: boolean;
        whatsappApiKey: string;
        whatsappBizOpaqueCallbackData?: string;
        whatsappCallId: string;
        whatsappCloudApiVersion: string;
        whatsappPhoneNumberId: string;
    }
    Index

    Properties

    agents? destinationCountry? participantAttributes? participantIdentity? participantMetadata? participantName? roomName? sdp timeout? waitUntilAnswered? whatsappApiKey whatsappBizOpaqueCallbackData? whatsappCallId whatsappCloudApiVersion whatsappPhoneNumberId

    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

    sdp: SessionDescription

    Required - The call accept webhook comes with SDP from Meta

    timeout?: number

    Optional - Request timeout in seconds. When waitUntilAnswered is set it defaults to the standard ring window; otherwise the client default applies.

    waitUntilAnswered?: boolean

    Optional - Wait until the inbound party joins before returning.

    whatsappApiKey: string

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

    whatsappBizOpaqueCallbackData?: string

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

    whatsappCallId: string

    Required - Call ID sent by Meta

    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 connecting the call

    Settings

    Member Visibility

    On This Page

    Properties