whatsapp-api-js - v6.1.1
    Preparing search index...

    Interface API

    interface API {
        createQR(
            phoneID: string,
            message: string,
            format: "png" | "svg",
        ): Promise<ServerCreateQRResponse>;
        deleteQR(phoneID: string, id: string): Promise<ServerDeleteQRResponse>;
        retrieveQR(phoneID: string, id?: string): Promise<ServerRetrieveQRResponse>;
        updateQR(
            phoneID: string,
            id: string,
            message: string,
        ): Promise<ServerUpdateQRResponse>;
    }

    Implemented by

    Index

    Methods

    createQR deleteQR retrieveQR updateQR

    Methods

    • Generate a QR code for sharing the bot

      Parameters

      • phoneID: string

        The bot's phone ID

      • message: string

        The quick message on the QR code

      • format: "png" | "svg"

        The format of the QR code

      Returns Promise<ServerCreateQRResponse>

      The server response

    • Get one or many QR codes of the bot

      Parameters

      • phoneID: string

        The bot's phone ID

      • Optionalid: string

        The QR's id to find. If not specified, all QRs will be returned

      Returns Promise<ServerRetrieveQRResponse>

      The server response

    • Update a QR code of the bot

      Parameters

      • phoneID: string

        The bot's phone ID

      • id: string

        The QR's id to edit

      • message: string

        The new quick message for the QR code

      Returns Promise<ServerUpdateQRResponse>

      The server response

    Settings

    Member Visibility

    On This Page

    Methods