Class ConnectorServiceClient

  • All Implemented Interfaces:

    
    public final class ConnectorServiceClient
    extends ServiceClientBase
                        

    A client for interacting with the Connector service.

    The Connector service allows you to connect external communication platforms (like WhatsApp and Twilio MediaStreams) to LiveKit rooms.

    • Method Detail

      • dialWhatsAppCall

        @JvmOverloads() final Call<<Error class: unknown class>> dialWhatsAppCall(String whatsappPhoneNumberId, String whatsappToPhoneNumber, String whatsappApiKey, String whatsappCloudApiVersion, WhatsAppCallOptions options)

        Dial an outbound WhatsApp call.

        Parameters:
        whatsappPhoneNumberId - The phone number ID of the business initiating the call
        whatsappToPhoneNumber - The phone number of the user to call
        whatsappApiKey - The API key of the business initiating the call
        whatsappCloudApiVersion - WhatsApp Cloud API version (e.g., "23.0", "24.
        options - Additional options for the call
      • dialWhatsAppCall

        @JvmOverloads() final Call<<Error class: unknown class>> dialWhatsAppCall(String whatsappPhoneNumberId, String whatsappToPhoneNumber, String whatsappApiKey, String whatsappCloudApiVersion)

        Dial an outbound WhatsApp call.

        Parameters:
        whatsappPhoneNumberId - The phone number ID of the business initiating the call
        whatsappToPhoneNumber - The phone number of the user to call
        whatsappApiKey - The API key of the business initiating the call
        whatsappCloudApiVersion - WhatsApp Cloud API version (e.g., "23.0", "24.
      • disconnectWhatsAppCall

         final Call<<Error class: unknown class>> disconnectWhatsAppCall(String whatsappCallId, String whatsappApiKey)

        Disconnect an active WhatsApp call.

        Parameters:
        whatsappCallId - The call ID sent by Meta
        whatsappApiKey - The API key of the business disconnecting the call
      • connectWhatsAppCall

         final Call<<Error class: unknown class>> )>connectWhatsAppCall(String whatsappCallId, <Error class: unknown class> sdp)

        Connect a WhatsApp call with the provided SDP. This is used to provide the answer SDP for a business-initiated call.

        Parameters:
        whatsappCallId - The call ID sent by Meta
        sdp - The session description from Meta
      • acceptWhatsAppCall

        @JvmOverloads() final Call<<Error class: unknown class>> ,io.livekit.server.WhatsAppCallOptions)>acceptWhatsAppCall(String whatsappPhoneNumberId, String whatsappApiKey, String whatsappCloudApiVersion, String whatsappCallId, <Error class: unknown class> sdp, WhatsAppCallOptions options)

        Accept an incoming WhatsApp call (user-initiated call).

        Parameters:
        whatsappPhoneNumberId - The phone number ID of the business accepting the call
        whatsappApiKey - The API key of the business accepting the call
        whatsappCloudApiVersion - WhatsApp Cloud API version (e.g., "23.0", "24.
        whatsappCallId - The call ID sent by Meta
        sdp - The session description from Meta
        options - Additional options for the call
      • acceptWhatsAppCall

        @JvmOverloads() final Call<<Error class: unknown class>> ,io.livekit.server.WhatsAppCallOptions)>acceptWhatsAppCall(String whatsappPhoneNumberId, String whatsappApiKey, String whatsappCloudApiVersion, String whatsappCallId, <Error class: unknown class> sdp)

        Accept an incoming WhatsApp call (user-initiated call).

        Parameters:
        whatsappPhoneNumberId - The phone number ID of the business accepting the call
        whatsappApiKey - The API key of the business accepting the call
        whatsappCloudApiVersion - WhatsApp Cloud API version (e.g., "23.0", "24.
        whatsappCallId - The call ID sent by Meta
        sdp - The session description from Meta