GET
/
messages
curl --request GET \
  --url https://api.wapikit.com/api/messages
{
  "messages": [
    {
      "uniqueId": "<string>",
      "conversationId": "<string>",
      "direction": "InBound",
      "status": "Read",
      "messageType": "Text",
      "createdAt": "2023-11-07T05:31:56Z",
      "replyToMessageId": "<string>",
      "whatsAppMessageId": "<string>",
      "messageData": {
        "text": "<string>"
      }
    }
  ],
  "paginationMeta": {
    "page": 123,
    "per_page": 123,
    "total": 123
  }
}

Query Parameters

​
page
integer

number of records to skip

​
per_page
integer

max number of records to return per page

​
order
enum<string>

order by asc or desc

Available options:
asc,
desc
​
status
enum<string>

status of the message

Available options:
read,
unread,
sent,
failed
​
direction
enum<string>

direction of the message

Available options:
InBound,
OutBound
​
contact_id
string

query messages with a contact id.

​
campaign_id
string

query messages with a campaign id.

​
list_id
string

query messages with a list id.

​
conversation_id
string

query messages with a conversation id.

Response

200
application/json

list of messages

The response is of type object.

GET
/
messages
curl --request GET \
  --url https://api.wapikit.com/api/messages
{
  "messages": [
    {
      "uniqueId": "<string>",
      "conversationId": "<string>",
      "direction": "InBound",
      "status": "Read",
      "messageType": "Text",
      "createdAt": "2023-11-07T05:31:56Z",
      "replyToMessageId": "<string>",
      "whatsAppMessageId": "<string>",
      "messageData": {
        "text": "<string>"
      }
    }
  ],
  "paginationMeta": {
    "page": 123,
    "per_page": 123,
    "total": 123
  }
}

Query Parameters

​
page
integer

number of records to skip

​
per_page
integer

max number of records to return per page

​
order
enum<string>

order by asc or desc

Available options:
asc,
desc
​
status
enum<string>

status of the message

Available options:
read,
unread,
sent,
failed
​
direction
enum<string>

direction of the message

Available options:
InBound,
OutBound
​
contact_id
string

query messages with a contact id.

​
campaign_id
string

query messages with a campaign id.

​
list_id
string

query messages with a list id.

​
conversation_id
string

query messages with a conversation id.

Response

200
application/json

list of messages

The response is of type object.