@wppconnect-team/wppconnect - v1.37.8
    Preparing search index...

    Interface AudioMessageOptions

    Send an audio message as a PTT, like a recorded message

    // PTT audio
    WPP.chat.sendFileMessage(
     '[number]@c.us',
     'data:audio/mp3;base64,<a long base64 file...>',
     {
       type: 'audio',
       isPtt: true // false for common audio
     }
    );
    interface AudioMessageOptions {
        caption?: string;
        createChat?: boolean;
        delay?: number;
        detectMentioned?: boolean;
        filename?: string;
        footer?: string;
        isPtt?: boolean;
        isViewOnce?: boolean;
        markIsRead?: boolean;
        mentionedList?: (string | WAJS.whatsapp.Wid)[];
        messageId?: string | MsgKey;
        mimetype?: string;
        quotedMsg?: string | MsgKey | MsgModel;
        quotedMsgPayload?: string;
        type: "audio";
        waitForAck?: boolean;
        waveform?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    caption? createChat? delay? detectMentioned? filename? footer? isPtt? isViewOnce? markIsRead? mentionedList? messageId? mimetype? quotedMsg? quotedMsgPayload? type waitForAck? waveform?

    Properties

    caption?: string
    createChat?: boolean

    Create a new chat to a new contact

    This option is no longer used. Chats are automatically created when sending messages.

    false

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    0

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    true

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    filename?: string
    footer?: string
    isPtt?: boolean
    isViewOnce?: boolean
    markIsRead?: boolean

    Automatically mark chat is read after send a message

    true

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    mentionedList?: (string | WAJS.whatsapp.Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    messageId?: string | MsgKey
    mimetype?: string
    quotedMsg?: string | MsgKey | MsgModel

    Quote a message, like a reply message

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    quotedMsgPayload?: string

    Quote a message using a previously saved payload. The payload must be the JSON string representation of a raw message. Raw messages can be obtained when using getMessageById or getMessages When provided it has priority over quotedMsg.

    type: "audio"
    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    true

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })
    waveform?: boolean

    Send an audio message as a PTT with waveform

    // Enable waveform
    WPP.chat.sendFileMessage(
     '[number]@c.us',
     'data:audio/mp3;base64,<a long base64 file...>',
     {
       type: 'audio',
       isPtt: true,
       waveform: true // false to disable
     }
    );
    // Disable waveform
    WPP.chat.sendFileMessage(
     '[number]@c.us',
     'data:audio/mp3;base64,<a long base64 file...>',
     {
       type: 'audio',
       isPtt: true,
       waveform: false
     }
    );

    Settings

    Member Visibility

    On This Page

    Properties