Message

Send a text message

Changed on

Sends a text message to a WhatsApp number via the specified instance

post/v1/message/sendText/{instance}

Request

  • Base URL
    http://localhost:8080
  • Auth
    API key in header apikey

Path parameters

instancestring required

Instance ID

Request body

delayinteger
linkPreviewboolean
linkPreviewDescriptionstring

Card description.

linkPreviewImagestring

Card image as an http(s) URL or base64 (raw or data URI). When any of linkPreviewImage/Title/Description is set (with linkPreview=true), the card is built from these values and the page is not fetched.

linkPreviewLargeboolean

Upload the image so clients render the big card (default true). false sends the small card with only the embedded thumbnail.

linkPreviewTitlestring

Card title. Empty with linkPreviewImage set sends an image-only card.

mentionedstring[]
mentionsEveryOneboolean
numberstring required

JID

textstring required

Response

OK

instanceIdstring
messageTimestampinteger
messageTypestring
pushNamestring
sourcestring
statusstring

Changes