Skip to main content
GET
/
instances
/
{id}
/
chats
List instance chats
curl --request GET \
  --url https://api.vzaps.com/instances/{id}/chats \
  --header 'Authorization: Bearer <token>'
{
  "page": 1,
  "page_size": 50,
  "total": 123,
  "total_pages": 123,
  "content": [
    {
      "phone": "5511999999999",
      "jid": "5511999999999@s.whatsapp.net",
      "name": "<string>",
      "last_message_user_name": "<string>",
      "last_message_user_phone": "<string>",
      "community_name": "<string>",
      "community_jid": "<string>",
      "archived": true,
      "pinned": true,
      "unread": "<string>",
      "messages_unread": 123,
      "marked_as_unread": true,
      "is_marked_spam": true,
      "is_group": true,
      "is_group_announcement": true,
      "last_message_time": "<string>",
      "last_message_timestamp_ms": 123,
      "mute_end_time": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Example:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

Query Parameters

page
integer
default:1
page_size
integer
default:50
Required range: 1 <= x <= 200

Response

Paginated chat list

page
integer
Example:

1

page_size
integer
Example:

50

total
integer
total_pages
integer
content
object[]