Skip to main content
GET
/
api
/
{session}
/
chats
/
{chatId}
/
messages
Get messages in conversation
curl --request GET \
  --url https://{host}/api/{session}/chats/{chatId}/messages \
  --header 'apikey: <api-key>'
[
  {
    "id": "false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAA",
    "timestamp": 1666943582,
    "from": "5511999999999@c.us",
    "fromMe": true,
    "source": "api",
    "to": "5511999999999@c.us",
    "participant": "<string>",
    "body": "<string>",
    "hasMedia": true,
    "media": {
      "url": "http://localhost:3000/api/files/false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAA.oga",
      "mimetype": "audio/jpeg",
      "filename": "example.pdf",
      "s3": {
        "Bucket": "my-bucket",
        "Key": "default/false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAA.oga"
      },
      "error": null
    },
    "ack": -1,
    "ackName": "<string>",
    "author": "<string>",
    "location": {
      "description": "<string>",
      "latitude": "<string>",
      "longitude": "<string>"
    },
    "vCards": [
      "<string>"
    ],
    "_data": {},
    "replyTo": {
      "id": "AAAAAAAAAAAAAAAAAAAA",
      "participant": "5511999999999@c.us",
      "body": "Hello!",
      "_data": {}
    }
  }
]

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
session
string
required

Session name (instanceName)

​
chatId
string
required

Conversation ID

Query Parameters

​
downloadMedia
boolean
default:true

Download media for messages

​
limit
number
default:10
required
​
offset
number
​
filter.timestamp.lte
number

Filter messages before this timestamp (inclusive)

​
filter.timestamp.gte
number

Filter messages after this timestamp (inclusive)

​
filter.fromMe
boolean

From me filter (by default shows all messages)

​
filter.ack
enum<string>

Filter messages by acknowledgement status

Available options:
ERROR,
PENDING,
SERVER,
DEVICE,
READ,
PLAYED

Response

200 - application/json
​
id
string
required

Message ID

Example:

"false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAA"

​
timestamp
number
required

Unix timestamp of when the message was created

Example:

1666943582

​
from
string
required

Chat ID to which this message was sent

Example:

"5511999999999@c.us"

​
fromMe
boolean
required

Indicates if the message was sent by the current user

​
source
enum<string>
required

The device that sent the message - either API or APP. Available in events (webhooks/websockets) only and only "fromMe: true" messages.

Available options:
api,
app
Example:

"api"

​
to
string
required
  • ID for who this message is for.
  • If the message is sent by the current user, it will be the Chat to which the message is being sent.
  • If the message is sent by another user, it will be the ID for the current user.
Example:

"5511999999999@c.us"

​
participant
string
required

For groups - participant who sent the message

​
body
string
required

Message content

​
hasMedia
boolean
required

Indicates if the message has media available for download

​
ack
enum<number>
required

Message acknowledgement (ACK) status

Available options:
-1,
0,
1,
2,
3,
4
​
ackName
string
required

Message acknowledgement status name

​
media
object

Message media object, if any and downloaded

​
author
string

If the message was sent to a group, this field will contain the user who sent the message

​
location
object

Location information contained in the message

​
vCards
string[]

List of vCards contained in the message

​
_data
object

Message in raw WhatsApp format. May change at any time, use with caution!

​
replyTo
object
⌘I