open-wa v5 is alpha. Use v4.76.0 for mature production systems unless you are validating v5.
The Client APIAPI ExplorerLicensing

Messages Client API

Generated client method reference for the messages namespace.

Client Messages Methods Wally

Messages Client API

Generated file warning: this page is generated by packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.

This page documents 37 schema-registry client methods in the messages namespace.

deleteMessage

Deletes a message

Overview

PropValue
Namespacemessages
Actiondelete
Functionalityboth
Positional parameter orderchatId, messageId, onlyLocal
Aliasesmessages.delete
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryDELETE/api/messages/deletedeleteMessageActive
AliasDELETE/api/deleteMessagedeleteMessageActive

Usage

const result = await client.deleteMessage({
  chatId: "447123456789@c.us",
  messageId: ["false_447123456789@c.us_ABC123","false_447123456789@c.us_DEF456"],
  onlyLocal: true,
});
const result = await client.messages.delete({
  chatId: "447123456789@c.us",
  messageId: ["false_447123456789@c.us_ABC123","false_447123456789@c.us_DEF456"],
  onlyLocal: true,
});
curl -X DELETE "http://localhost:8080/api/messages/delete" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "chatId": "447123456789@c.us",
    "messageId": [
      "false_447123456789@c.us_ABC123",
      "false_447123456789@c.us_DEF456"
    ],
    "onlyLocal": true
  }'

Parameters

Prop

Type

Output

PropValue
Return typeboolean

forwardMessages

Forwards messages to a chat

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, messages, skipMyMessages
Aliasesmessages.forward
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/forwardforwardMessagesActive
AliasPOST/api/forwardMessagesforwardMessagesActive

Usage

const result = await client.forwardMessages({
  to: "447123456789@c.us",
  messages: ["false_447123456789@c.us_ABC123","false_447123456789@c.us_DEF456"],
  skipMyMessages: false,
});
const result = await client.messages.forward({
  to: "447123456789@c.us",
  messages: ["false_447123456789@c.us_ABC123","false_447123456789@c.us_DEF456"],
  skipMyMessages: false,
});
curl -X POST "http://localhost:8080/api/messages/forward" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "messages": [
      "false_447123456789@c.us_ABC123",
      "false_447123456789@c.us_DEF456"
    ],
    "skipMyMessages": false
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized }[] | boolean

getAllMessages

Retrieves all messages in the session

Overview

PropValue
Namespacemessages
Actionread
Functionalityboth
Positional parameter orderchatId, includeMe, includeNotifications
AliaseslistMessages, messages.all, messages.getAll, messages.list
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/messages/getAllgetAllMessagesActive
AliasGET/api/getAllMessagesgetAllMessagesActive
AliasGET/api/listMessageslistMessagesActive
AliasGET/api/messages/allmessages.allActive
AliasGET/api/messages/listmessages.listActive

Usage

const result = await client.getAllMessages({
  chatId: "447123456789@c.us",
  includeMe: true,
  includeNotifications: true,
});
const result = await client.messages.getAll({
  chatId: "447123456789@c.us",
  includeMe: true,
  includeNotifications: true,
});
curl -G "http://localhost:8080/api/messages/getAll" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "chatId=447123456789@c.us" \
  --data-urlencode "includeMe=true" \
  --data-urlencode "includeNotifications=true"

Parameters

Prop

Type

Output

PropValue
Return typeunknown[]

getMessageById

Retrieves a specific message by ID

Overview

PropValue
Namespacemessages
Actionread
Functionalityboth
Positional parameter ordermessageId
AliasesgetMessage, messages.get, messages.getById
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/messages/getgetMessageByIdActive
AliasGET/api/getMessagegetMessageActive
AliasGET/api/getMessageByIdgetMessageByIdActive
AliasGET/api/messages/getByIdmessages.getByIdActive

Usage

const result = await client.getMessageById({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
const result = await client.messages.get({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
curl -G "http://localhost:8080/api/messages/get" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "messageId=false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB"

Parameters

Prop

Type

Output

PropValue
Return typeunknown

getMessageInfo

Get message delivery info

Overview

PropValue
Namespacemessages
Actionread
Functionalityboth
Positional parameter ordermessageId
Aliasesmessages.getInfo
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/messages/getInfogetMessageInfoActive
AliasGET/api/getMessageInfogetMessageInfoActive

Usage

const result = await client.getMessageInfo({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
const result = await client.messages.getInfo({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
curl -G "http://localhost:8080/api/messages/getInfo" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "messageId=false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB"

Parameters

Prop

Type

Output

PropValue
Return typeunknown

getMessagesForLLM

Get messages formatted for LLMs

Overview

PropValue
Namespacemessages
Actionread
Functionalityboth
Positional parameter orderchatId, last
AliasesgetGptArray, messages.getForLLM, messages.getGptArray
Deprecated aliasesgetGptArray, messages.getGptArray
Licensenone
WAPI overridegetGptArray
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/messages/getForLLMgetMessagesForLLMActive
Deprecated aliasGET/api/getGptArraygetGptArrayDeprecated
AliasGET/api/getMessagesForLLMgetMessagesForLLMActive
Deprecated aliasGET/api/messages/getGptArraymessages.getGptArrayDeprecated

Usage

const result = await client.getMessagesForLLM({
  chatId: "447123456789@c.us",
  last: 1,
});
const result = await client.messages.getForLLM({
  chatId: "447123456789@c.us",
  last: 1,
});
curl -G "http://localhost:8080/api/messages/getForLLM" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "chatId=447123456789@c.us" \
  --data-urlencode "last=1"

Parameters

Prop

Type

Output

PropValue
Return typeunknown

getMyLastMessage

Get last message sent by host

Overview

PropValue
Namespacemessages
Actionread
Functionalityboth
Positional parameter orderchatId
Aliasesmessages.getMyLast
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/messages/getMyLastgetMyLastMessageActive
AliasGET/api/getMyLastMessagegetMyLastMessageActive

Usage

const result = await client.getMyLastMessage({
  chatId: "447123456789@c.us",
});
const result = await client.messages.getMyLast({
  chatId: "447123456789@c.us",
});
curl -G "http://localhost:8080/api/messages/getMyLast" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "chatId=447123456789@c.us"

Parameters

Prop

Type

Output

PropValue
Return typeunknown

getStarredMessagesInsiders

Get starred messages

Overview

PropValue
Namespacemessages
Actionread
Functionalityboth
Positional parameter orderchatId
Aliasesmessages.getStarred
Deprecated aliases-
Licenseinsiders
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/messages/getStarredgetStarredMessagesActive
AliasGET/api/getStarredMessagesgetStarredMessagesActive

Usage

const result = await client.getStarredMessages({
  chatId: "447123456789@c.us",
});
const result = await client.messages.getStarred({
  chatId: "447123456789@c.us",
});
curl -G "http://localhost:8080/api/messages/getStarred" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "chatId=447123456789@c.us"

Parameters

Prop

Type

Output

PropValue
Return typeunknown[]

getUnsentMessages

Get unsent/pending messages

Overview

PropValue
Namespacemessages
Actionread
Functionalityboth
Positional parameter order-
Aliasesmessages.getUnsent
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/messages/getUnsentgetUnsentMessagesActive
AliasGET/api/getUnsentMessagesgetUnsentMessagesActive

Usage

const result = await client.getUnsentMessages({});
const result = await client.messages.getUnsent({});
curl -X GET "http://localhost:8080/api/messages/getUnsent" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

PropValue
Return typeunknown[]

getVCards

Extract vCards from message

Overview

PropValue
Namespacemessages
Actionread
Functionalityboth
Positional parameter ordermessageId
Aliasesmessages.getVCards
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/messages/getVCardsgetVCardsActive
AliasGET/api/getVCardsgetVCardsActive

Usage

const result = await client.getVCards({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
const result = await client.messages.getVCards({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
curl -G "http://localhost:8080/api/messages/getVCards" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "messageId=false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB"

Parameters

Prop

Type

Output

PropValue
Return typestring[]

loadEarlierMessages

Loads earlier messages from a chat

Overview

PropValue
Namespacemessages
Actionread
Functionalityboth
Positional parameter orderchatId, count, includeMe
AliasesloadOlderMessages, messages.loadEarlier, messages.loadOlder
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/loadEarlierloadEarlierMessagesActive
AliasPOST/api/loadEarlierMessagesloadEarlierMessagesActive
AliasPOST/api/loadOlderMessagesloadOlderMessagesActive
AliasPOST/api/messages/loadOldermessages.loadOlderActive

Usage

const result = await client.loadEarlierMessages({
  chatId: "447123456789@c.us",
  count: 1,
  includeMe: true,
});
const result = await client.messages.loadEarlier({
  chatId: "447123456789@c.us",
  count: 1,
  includeMe: true,
});
curl -X POST "http://localhost:8080/api/messages/loadEarlier" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "chatId": "447123456789@c.us",
    "count": 1,
    "includeMe": true
  }'

Parameters

Prop

Type

Output

PropValue
Return typeunknown[]

react

React to message with emoji

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter ordermessageId, emoji
Aliasesmessages.react
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/reactreactActive
AliasPOST/api/reactreactActive

Usage

const result = await client.react({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
  emoji: "emoji",
});
const result = await client.messages.react({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
  emoji: "emoji",
});
curl -X POST "http://localhost:8080/api/messages/react" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "messageId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
    "emoji": "emoji"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeboolean

sendAdvancedButtonsInsiders

Sends an advanced button message with media (deprecated)

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, body, buttons, text, footer, filename
Aliasesmessages.sendAdvancedButtons
Deprecated aliases-
Licenseinsiders
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendAdvancedButtonssendAdvancedButtonsActive
AliasPOST/api/sendAdvancedButtonssendAdvancedButtonsActive

Usage

const result = await client.sendAdvancedButtons({
  to: "447123456789@c.us",
  body: "body",
  buttons: [],
  text: "text",
  footer: "footer",
  filename: "filename",
});
const result = await client.messages.sendAdvancedButtons({
  to: "447123456789@c.us",
  body: "body",
  buttons: [],
  text: "text",
  footer: "footer",
  filename: "filename",
});
curl -X POST "http://localhost:8080/api/messages/sendAdvancedButtons" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "body": "body",
    "buttons": [],
    "text": "text",
    "footer": "footer",
    "filename": "filename"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendAudio

Sends an audio file to a chat

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, file, filename, quotedMsgId
Aliasesmessages.sendAudio
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendAudiosendAudioActive
AliasPOST/api/sendAudiosendAudioActive

Usage

const result = await client.sendAudio({
  to: "447123456789@c.us",
  file: "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA...",
  filename: "document.pdf",
  quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
const result = await client.messages.sendAudio({
  to: "447123456789@c.us",
  file: "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA...",
  filename: "document.pdf",
  quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
curl -X POST "http://localhost:8080/api/messages/sendAudio" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "file": "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA...",
    "filename": "document.pdf",
    "quotedMsgId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendBanner

Sends a banner image

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, base64
Aliasesmessages.sendBanner
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendBannersendBannerActive
AliasPOST/api/sendBannersendBannerActive

Usage

const result = await client.sendBanner({
  to: "447123456789@c.us",
  base64: "base64",
});
const result = await client.messages.sendBanner({
  to: "447123456789@c.us",
  base64: "base64",
});
curl -X POST "http://localhost:8080/api/messages/sendBanner" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "base64": "base64"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendButtonsInsiders

Sends a button message (deprecated)

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, body, buttons, title, footer
Aliasesmessages.sendButtons
Deprecated aliases-
Licenseinsiders
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendButtonssendButtonsActive
AliasPOST/api/sendButtonssendButtonsActive

Usage

const result = await client.sendButtons({
  to: "447123456789@c.us",
  body: "body",
  buttons: [],
  title: "title",
  footer: "footer",
});
const result = await client.messages.sendButtons({
  to: "447123456789@c.us",
  body: "body",
  buttons: [],
  title: "title",
  footer: "footer",
});
curl -X POST "http://localhost:8080/api/messages/sendButtons" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "body": "body",
    "buttons": [],
    "title": "title",
    "footer": "footer"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendContact

Sends a single contact

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, contactId
Aliasesmessages.sendContact
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendContactsendContactActive
AliasPOST/api/sendContactsendContactActive

Usage

const result = await client.sendContact({
  to: "447123456789@c.us",
  contactId: [],
});
const result = await client.messages.sendContact({
  to: "447123456789@c.us",
  contactId: [],
});
curl -X POST "http://localhost:8080/api/messages/sendContact" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "contactId": []
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendFile

Sends a file or document to a chat

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, file, filename, caption
Aliasesmessages.sendFile
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendFilesendFileActive
AliasPOST/api/sendFilesendFileActive

Usage

const result = await client.sendFile({
  to: "447123456789@c.us",
  file: "data:application/pdf;base64,JVBERi0xLjQK...",
  filename: "document.pdf",
  caption: "Check out this image!",
});
const result = await client.messages.sendFile({
  to: "447123456789@c.us",
  file: "data:application/pdf;base64,JVBERi0xLjQK...",
  filename: "document.pdf",
  caption: "Check out this image!",
});
curl -X POST "http://localhost:8080/api/messages/sendFile" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "file": "data:application/pdf;base64,JVBERi0xLjQK...",
    "filename": "document.pdf",
    "caption": "Check out this image!"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | string

sendFileFromUrl

Downloads a file from a URL and sends it to a chat

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, url, filename, caption, headers
Aliasesmessages.sendFileFromUrl
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendFileFromUrlsendFileFromUrlActive
AliasPOST/api/sendFileFromUrlsendFileFromUrlActive

Usage

const result = await client.sendFileFromUrl({
  to: "447123456789@c.us",
  url: "url",
  filename: "filename",
  caption: "caption",
  headers: {},
});
const result = await client.messages.sendFileFromUrl({
  to: "447123456789@c.us",
  url: "url",
  filename: "filename",
  caption: "caption",
  headers: {},
});
curl -X POST "http://localhost:8080/api/messages/sendFileFromUrl" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "url": "url",
    "filename": "filename",
    "caption": "caption",
    "headers": {}
  }'

Parameters

Prop

Type

Output

PropValue
Return typestring | boolean

sendImage

Sends an image to a chat

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, imgData, filename, caption, id, waitForId
Aliasesmessages.sendImage
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendImagesendImageActive
AliasPOST/api/sendImagesendImageActive

Usage

const result = await client.sendImage({
  to: "447123456789@c.us",
  imgData: "data:image/png;base64,iVBORw0KGgo...",
  filename: "document.pdf",
  caption: "Check out this image!",
  id: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
  waitForId: true,
});
const result = await client.messages.sendImage({
  to: "447123456789@c.us",
  imgData: "data:image/png;base64,iVBORw0KGgo...",
  filename: "document.pdf",
  caption: "Check out this image!",
  id: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
  waitForId: true,
});
curl -X POST "http://localhost:8080/api/messages/sendImage" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "imgData": "data:image/png;base64,iVBORw0KGgo...",
    "filename": "document.pdf",
    "caption": "Check out this image!",
    "id": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
    "waitForId": true
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean | string

sendLinkWithAutoPreview

Sends a link with auto-generated preview

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, url, text, thumbnail, quotedMsgId, customSize
Aliasesmessages.sendLink, messages.sendLinkWithAutoPreview, sendLink
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendLinkWithAutoPreviewsendLinkWithAutoPreviewActive
AliasPOST/api/messages/sendLinkmessages.sendLinkActive
AliasPOST/api/sendLinksendLinkActive
AliasPOST/api/sendLinkWithAutoPreviewsendLinkWithAutoPreviewActive

Usage

const result = await client.sendLinkWithAutoPreview({
  to: "447123456789@c.us",
  url: "url",
  text: "Hello, world!",
  thumbnail: "thumbnail",
  quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
  customSize: {},
});
const result = await client.messages.sendLinkWithAutoPreview({
  to: "447123456789@c.us",
  url: "url",
  text: "Hello, world!",
  thumbnail: "thumbnail",
  quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
  customSize: {},
});
curl -X POST "http://localhost:8080/api/messages/sendLinkWithAutoPreview" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "url": "url",
    "text": "Hello, world!",
    "thumbnail": "thumbnail",
    "quotedMsgId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
    "customSize": {}
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendListMessageInsiders

Sends a list/menu message (deprecated)

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, sections, title, description, actionText
Aliasesmessages.sendList, sendList
Deprecated aliases-
Licenseinsiders
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendListsendListMessageActive
AliasPOST/api/sendListsendListActive
AliasPOST/api/sendListMessagesendListMessageActive

Usage

const result = await client.sendListMessage({
  to: "447123456789@c.us",
  sections: [],
  title: "title",
  description: "description",
  actionText: "actionText",
});
const result = await client.messages.sendList({
  to: "447123456789@c.us",
  sections: [],
  title: "title",
  description: "description",
  actionText: "actionText",
});
curl -X POST "http://localhost:8080/api/messages/sendList" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "sections": [],
    "title": "title",
    "description": "description",
    "actionText": "actionText"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendLocation

Sends a location to a chat

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, lat, lng, loc, address, url
Aliasesmessages.sendLocation
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendLocationsendLocationActive
AliasPOST/api/sendLocationsendLocationActive

Usage

const result = await client.sendLocation({
  to: "447123456789@c.us",
  lat: 51.5074,
  lng: -0.1278,
  loc: "London, UK",
  address: "address",
  url: "url",
});
const result = await client.messages.sendLocation({
  to: "447123456789@c.us",
  lat: 51.5074,
  lng: -0.1278,
  loc: "London, UK",
  address: "address",
  url: "url",
});
curl -X POST "http://localhost:8080/api/messages/sendLocation" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "lat": 51.5074,
    "lng": -0.1278,
    "loc": "London, UK",
    "address": "address",
    "url": "url"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendMessageWithThumb

Sends a link preview message with custom thumbnail

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderthumb, url, title, description, content, to, quotedMsgId, customSize
Aliasesmessages.sendLinkWithThumbnail, messages.sendWithThumb, sendLinkWithThumbnail
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendLinkWithThumbnailsendMessageWithThumbActive
AliasPOST/api/messages/sendWithThumbmessages.sendWithThumbActive
AliasPOST/api/sendLinkWithThumbnailsendLinkWithThumbnailActive
AliasPOST/api/sendMessageWithThumbsendMessageWithThumbActive

Usage

const result = await client.sendMessageWithThumb({
  thumb: "thumb",
  url: "url",
  title: "title",
  description: "description",
  content: "Hello, world!",
  to: "447123456789@c.us",
  quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
  customSize: {},
});
const result = await client.messages.sendLinkWithThumbnail({
  thumb: "thumb",
  url: "url",
  title: "title",
  description: "description",
  content: "Hello, world!",
  to: "447123456789@c.us",
  quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
  customSize: {},
});
curl -X POST "http://localhost:8080/api/messages/sendLinkWithThumbnail" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "thumb": "thumb",
    "url": "url",
    "title": "title",
    "description": "description",
    "content": "Hello, world!",
    "to": "447123456789@c.us",
    "quotedMsgId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
    "customSize": {}
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendMultipleContacts

Sends multiple contacts

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, contactIds
Aliasesmessages.sendContacts, messages.sendMultipleContacts, sendContacts
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendContactssendMultipleContactsActive
AliasPOST/api/messages/sendMultipleContactsmessages.sendMultipleContactsActive
AliasPOST/api/sendContactssendContactsActive
AliasPOST/api/sendMultipleContactssendMultipleContactsActive

Usage

const result = await client.sendMultipleContacts({
  to: "447123456789@c.us",
  contactIds: "447123456789@c.us",
});
const result = await client.messages.sendContacts({
  to: "447123456789@c.us",
  contactIds: "447123456789@c.us",
});
curl -X POST "http://localhost:8080/api/messages/sendContacts" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "contactIds": "447123456789@c.us"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendPaymentRequest

Sends a payment request message

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, amount, currency, message
Aliasesmessages.sendPaymentRequest
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendPaymentRequestsendPaymentRequestActive
AliasPOST/api/sendPaymentRequestsendPaymentRequestActive

Usage

const result = await client.sendPaymentRequest({
  to: "447123456789@c.us",
  amount: 1,
  currency: "currency",
  message: "message",
});
const result = await client.messages.sendPaymentRequest({
  to: "447123456789@c.us",
  amount: 1,
  currency: "currency",
  message: "message",
});
curl -X POST "http://localhost:8080/api/messages/sendPaymentRequest" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "amount": 1,
    "currency": "currency",
    "message": "message"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendPoll

Sends a poll message

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, name, options, selectableCount
Aliasesmessages.sendPoll
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendPollsendPollActive
AliasPOST/api/sendPollsendPollActive

Usage

const result = await client.sendPoll({
  to: "447123456789@c.us",
  name: "name",
  options: [],
  selectableCount: 1,
});
const result = await client.messages.sendPoll({
  to: "447123456789@c.us",
  name: "name",
  options: [],
  selectableCount: 1,
});
curl -X POST "http://localhost:8080/api/messages/sendPoll" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "name": "name",
    "options": [],
    "selectableCount": 1
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendPtt

Sends a voice note (push-to-talk) to a chat

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, file, quotedMsgId
Aliasesmessages.sendPtt, messages.sendVoiceNote, sendVoiceNote
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendPttsendPttActive
AliasPOST/api/messages/sendVoiceNotemessages.sendVoiceNoteActive
AliasPOST/api/sendPttsendPttActive
AliasPOST/api/sendVoiceNotesendVoiceNoteActive

Usage

const result = await client.sendPtt({
  to: "447123456789@c.us",
  file: "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA...",
  quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
const result = await client.messages.sendPtt({
  to: "447123456789@c.us",
  file: "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA...",
  quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
curl -X POST "http://localhost:8080/api/messages/sendPtt" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "file": "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA...",
    "quotedMsgId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendReplyWithMentions

Sends a reply to a message that includes @mentions

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, content, replyMessageId, hideTags, mentions
Aliasesmessages.sendReplyWithMentions
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendReplyWithMentionssendReplyWithMentionsActive
AliasPOST/api/sendReplyWithMentionssendReplyWithMentionsActive

Usage

const result = await client.sendReplyWithMentions({
  to: "447123456789@c.us",
  content: "Hello, world!",
  replyMessageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
  hideTags: true,
  mentions: ["447123456789@c.us","441234567890@c.us"],
});
const result = await client.messages.sendReplyWithMentions({
  to: "447123456789@c.us",
  content: "Hello, world!",
  replyMessageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
  hideTags: true,
  mentions: ["447123456789@c.us","441234567890@c.us"],
});
curl -X POST "http://localhost:8080/api/messages/sendReplyWithMentions" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "content": "Hello, world!",
    "replyMessageId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
    "hideTags": true,
    "mentions": [
      "447123456789@c.us",
      "441234567890@c.us"
    ]
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendSeen

Mark message as seen

Overview

PropValue
Namespacemessages
Actionupdate
Functionalityboth
Positional parameter orderchatId
Aliasesmessages.sendSeen
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPUT/api/messages/sendSeensendSeenActive
AliasPUT/api/sendSeensendSeenActive

Usage

const result = await client.sendSeen({
  chatId: "447123456789@c.us",
});
const result = await client.messages.sendSeen({
  chatId: "447123456789@c.us",
});
curl -X PUT "http://localhost:8080/api/messages/sendSeen" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "chatId": "447123456789@c.us"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeboolean

sendText

Sends a text message to a chat

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, content, options
Aliasesmessages.sendText
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendTextsendTextActive
AliasPOST/api/sendTextsendTextActive

Usage

const result = await client.sendText({
  to: "447123456789@c.us",
  content: "Hello, world!",
  options: {"quotedMsg":"messageId","mentionedJidList":["447123456789@c.us"]},
});
const result = await client.messages.sendText({
  to: "447123456789@c.us",
  content: "Hello, world!",
  options: {"quotedMsg":"messageId","mentionedJidList":["447123456789@c.us"]},
});
curl -X POST "http://localhost:8080/api/messages/sendText" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "content": "Hello, world!",
    "options": {
      "quotedMsg": "messageId",
      "mentionedJidList": [
        "447123456789@c.us"
      ]
    }
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean | string

sendTextWithMentions

Sends a text message that includes @mentions

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, content, hideTags, mentions
Aliasesmessages.sendTextWithMentions
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendTextWithMentionssendTextWithMentionsActive
AliasPOST/api/sendTextWithMentionssendTextWithMentionsActive

Usage

const result = await client.sendTextWithMentions({
  to: "447123456789@c.us",
  content: "Hello, world!",
  hideTags: true,
  mentions: ["447123456789@c.us","441234567890@c.us"],
});
const result = await client.messages.sendTextWithMentions({
  to: "447123456789@c.us",
  content: "Hello, world!",
  hideTags: true,
  mentions: ["447123456789@c.us","441234567890@c.us"],
});
curl -X POST "http://localhost:8080/api/messages/sendTextWithMentions" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "content": "Hello, world!",
    "hideTags": true,
    "mentions": [
      "447123456789@c.us",
      "441234567890@c.us"
    ]
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

sendVCard

Sends a contact card (vCard)

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, vcard, contactName, contactNumber
Aliasesmessages.sendVCard
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendVCardsendVCardActive
AliasPOST/api/sendVCardsendVCardActive

Usage

const result = await client.sendVCard({
  to: "447123456789@c.us",
  vcard: "vcard",
  contactName: "contactName",
  contactNumber: "contactNumber",
});
const result = await client.messages.sendVCard({
  to: "447123456789@c.us",
  vcard: "vcard",
  contactName: "contactName",
  contactNumber: "contactNumber",
});
curl -X POST "http://localhost:8080/api/messages/sendVCard" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "vcard": "vcard",
    "contactName": "contactName",
    "contactNumber": "contactNumber"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeboolean

sendVideoAsGif

Sends a video as an animated GIF

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, file, filename, caption, quotedMsgId
Aliasesmessages.sendVideoAsGif
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendVideoAsGifsendVideoAsGifActive
AliasPOST/api/sendVideoAsGifsendVideoAsGifActive

Usage

const result = await client.sendVideoAsGif({
  to: "447123456789@c.us",
  file: "data:video/mp4;base64,AAAAIGZ0eXBpc29tAAACAGlzb21...",
  filename: "document.pdf",
  caption: "Check out this image!",
  quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
const result = await client.messages.sendVideoAsGif({
  to: "447123456789@c.us",
  file: "data:video/mp4;base64,AAAAIGZ0eXBpc29tAAACAGlzb21...",
  filename: "document.pdf",
  caption: "Check out this image!",
  quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
curl -X POST "http://localhost:8080/api/messages/sendVideoAsGif" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "file": "data:video/mp4;base64,AAAAIGZ0eXBpc29tAAACAGlzb21...",
    "filename": "document.pdf",
    "caption": "Check out this image!",
    "quotedMsgId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

Sends a YouTube link with auto-generated preview

Overview

PropValue
Namespacemessages
Actionsend
Functionalityboth
Positional parameter orderto, url, text, thumbnail, quotedMsgId, customSize
Aliasesmessages.sendYoutubeLink, messages.sendYouTubeLink, sendYoutubeLink
Deprecated aliasesmessages.sendYoutubeLink, sendYoutubeLink
Licensenone
WAPI overridesendYoutubeLink
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPOST/api/messages/sendYouTubeLinksendYouTubeLinkActive
Deprecated aliasPOST/api/messages/sendYoutubeLinkmessages.sendYoutubeLinkDeprecated
Deprecated aliasPOST/api/sendYoutubeLinksendYoutubeLinkDeprecated
AliasPOST/api/sendYouTubeLinksendYouTubeLinkActive

Usage

const result = await client.sendYouTubeLink({
  to: "447123456789@c.us",
  url: "url",
  text: "Hello, world!",
  thumbnail: "thumbnail",
  quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
  customSize: {},
});
const result = await client.messages.sendYouTubeLink({
  to: "447123456789@c.us",
  url: "url",
  text: "Hello, world!",
  thumbnail: "thumbnail",
  quotedMsgId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
  customSize: {},
});
curl -X POST "http://localhost:8080/api/messages/sendYouTubeLink" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "to": "447123456789@c.us",
    "url": "url",
    "text": "Hello, world!",
    "thumbnail": "thumbnail",
    "quotedMsgId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
    "customSize": {}
  }'

Parameters

Prop

Type

Output

PropValue
Return typeobject { _serialized } | boolean

starMessage

Star a message

Overview

PropValue
Namespacemessages
Actionupdate
Functionalityboth
Positional parameter ordermessageId
Aliasesmessages.star
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPUT/api/messages/starstarMessageActive
AliasPUT/api/starMessagestarMessageActive

Usage

const result = await client.starMessage({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
const result = await client.messages.star({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
curl -X PUT "http://localhost:8080/api/messages/star" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "messageId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeboolean

unstarMessage

Unstar a message

Overview

PropValue
Namespacemessages
Actionupdate
Functionalityboth
Positional parameter ordermessageId
Aliasesmessages.unstar
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPUT/api/messages/unstarunstarMessageActive
AliasPUT/api/unstarMessageunstarMessageActive

Usage

const result = await client.unstarMessage({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
const result = await client.messages.unstar({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});
curl -X PUT "http://localhost:8080/api/messages/unstar" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "messageId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeboolean
Wally the Walrus typing

Was this helpful?

Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!

On this page

Messages Client APIdeleteMessageOverviewRoutesUsageParametersOutputforwardMessagesOverviewRoutesUsageParametersOutputgetAllMessagesOverviewRoutesUsageParametersOutputgetMessageByIdOverviewRoutesUsageParametersOutputgetMessageInfoOverviewRoutesUsageParametersOutputgetMessagesForLLMOverviewRoutesUsageParametersOutputgetMyLastMessageOverviewRoutesUsageParametersOutputgetStarredMessages - insidersOverviewRoutesUsageParametersOutputgetUnsentMessagesOverviewRoutesUsageParametersOutputgetVCardsOverviewRoutesUsageParametersOutputloadEarlierMessagesOverviewRoutesUsageParametersOutputreactOverviewRoutesUsageParametersOutputsendAdvancedButtons - insidersOverviewRoutesUsageParametersOutputsendAudioOverviewRoutesUsageParametersOutputsendBannerOverviewRoutesUsageParametersOutputsendButtons - insidersOverviewRoutesUsageParametersOutputsendContactOverviewRoutesUsageParametersOutputsendFileOverviewRoutesUsageParametersOutputsendFileFromUrlOverviewRoutesUsageParametersOutputsendImageOverviewRoutesUsageParametersOutputsendLinkWithAutoPreviewOverviewRoutesUsageParametersOutputsendListMessage - insidersOverviewRoutesUsageParametersOutputsendLocationOverviewRoutesUsageParametersOutputsendMessageWithThumbOverviewRoutesUsageParametersOutputsendMultipleContactsOverviewRoutesUsageParametersOutputsendPaymentRequestOverviewRoutesUsageParametersOutputsendPollOverviewRoutesUsageParametersOutputsendPttOverviewRoutesUsageParametersOutputsendReplyWithMentionsOverviewRoutesUsageParametersOutputsendSeenOverviewRoutesUsageParametersOutputsendTextOverviewRoutesUsageParametersOutputsendTextWithMentionsOverviewRoutesUsageParametersOutputsendVCardOverviewRoutesUsageParametersOutputsendVideoAsGifOverviewRoutesUsageParametersOutputsendYouTubeLinkOverviewRoutesUsageParametersOutputstarMessageOverviewRoutesUsageParametersOutputunstarMessageOverviewRoutesUsageParametersOutput