Skip to main content
POST
/
sender
/
listmessages
List campaign messages
curl --request POST \
  --url https://api.wppfy.com/sender/listmessages \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "folder_id": "<string>",
  "messageStatus": "Scheduled",
  "page": 1,
  "pageSize": 1000
}
'
{
  "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>"
        }
      }
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "pageSize": 123,
    "lastPage": 123
  }
}

Authorizations

token
string
header
required

Body

application/json
folder_id
string
required

ID of the campaign to be queried

messageStatus
enum<string>

Message status to filter

Available options:
Scheduled,
Sent,
Failed
page
integer
default:1

Page number for pagination

Required range: x >= 1
pageSize
integer
default:1000

Number of items per page

Required range: 1 <= x <= 1000

Response

List of messages returned successfully

messages
object[]
pagination
object