Skip to main content
POST
/
message
/
find
curl --request POST \
  --url https://api.wppfy.com/message/find \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "chatid": "5511999999999@s.whatsapp.net",
  "limit": 20,
  "offset": 0
}
'
{
  "returnedMessages": 123,
  "messages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "messageid": "<string>",
      "chatid": "<string>",
      "fromMe": false,
      "isGroup": false,
      "messageType": "text",
      "messageTimestamp": 0,
      "edited": "",
      "quoted": "",
      "reaction": "",
      "sender": "",
      "senderName": "",
      "source": "",
      "status": "",
      "text": "",
      "vote": "",
      "buttonOrListid": "",
      "convertOptions": "",
      "fileURL": "",
      "content": "<string>",
      "owner": "",
      "track_source": "",
      "track_id": "",
      "created": "(strftime('%Y-%m-%d %H:%M:%f', 'now'))",
      "updated": "(strftime('%Y-%m-%d %H:%M:%f', 'now'))",
      "ai_metadata": {
        "agent_id": "<string>",
        "request": {
          "messages": "<array>",
          "tools": "<array>",
          "options": {
            "model": "<string>",
            "temperature": 123,
            "maxTokens": 123,
            "topP": 123,
            "frequencyPenalty": 123,
            "presencePenalty": 123
          }
        },
        "response": {
          "choices": "<array>",
          "toolResults": "<array>",
          "error": "<string>"
        }
      }
    }
  ],
  "limit": 123,
  "offset": 123,
  "nextOffset": 123,
  "hasMore": true
}

Authorizations

​
token
string
header
required

Body

application/json
​
id
string

Specific message ID for exact search

Example:

"user123:r3EB0538"

​
chatid
string

Chat ID in international format

Example:

"5511999999999@s.whatsapp.net"

​
track_source
string

Tracking source to filter messages

Example:

"chatwoot"

​
track_id
string

Tracking ID to filter messages

Example:

"msg_123456789"

​
limit
integer
default:100

Maximum number of messages to return (default 100)

Required range: x >= 1
Example:

20

​
offset
integer
default:0

Offset for pagination (0 returns the most recent messages)

Response

List of found messages with pagination metadata

​
returnedMessages
integer

Number of messages returned in this page

​
messages
object[]
​
limit
integer

Limit applied to the search

​
offset
integer

Offset used to retrieve results

​
nextOffset
integer

Suggested offset for the next page

​
hasMore
boolean

Indicates if there are more messages after this page