Skip to main content

Send Link Preview

POST 
/api/v2/instance/:instanceId/send/link-preview

This endpoint allows sending link previews within a specific instance

Request​

Path Parameters

    instanceId stringrequired

    ID of the instance.

Body

required
    recipient Recipientrequired

    Contact number or group id

    options object
    delay Delay

    Defines the delay with which the message will be sent in milliseconds.

    presence Presence

    Default value: composing | recording | available | unavailable

    Defines the behavior of the connected number when sending the message in the chat.

    quoteMessageById Quote Message

    Enter the id of the message to be quoted.

    groupMention object

    Mention the participants of a group.

    hidden Hidden

    Default value: true

    This parameter allows mentioning all members of a group without directly referencing them.

    everyone Everyone

    Default value: true

    Use this attribute to explicitly mention all members of a group.

    externalAttributes External Attributes

    An external value of any type that will be sent in the webhook.

    linkPreview object
    link Linkrequired
    title Titlerequired
    description Description
    text Text

Responses​

ResponseSendMessage

Schema
    messageId stringrequired
    keyId stringrequired
    keyFromMe booleanrequired
    keyRemoteJid stringrequired
    keyParticipant string
    pushName stringrequired
    contentType stringrequired
    isGroup booleanrequired
    content objectrequired
    source stringrequired
    messageTimestamp numberrequired
    createdAt date-timerequired

    Default value: 2023-12-13T17:55:01.032Z

    instanceInstanceId stringrequired

    Default value: 2023-12-13T17:55:01.032Z

    externalAttributes stringrequired
Loading...