Get chat metada
Method#
/chat/{phone}#
GET https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/chats/{phone}
Header#
| Key | Value |
|---|---|
| Client-Token | ACCOUNT SECURITY TOKEN |
Concept#
This method is responsible for returning the metadata of a chat.
Attributes#
Required#
| Attributes | Type | Description |
|---|---|---|
| phone | string | Telephone number in the format DDI DDD NUMERS Ex: 551199999999. IMPORTANT only send numbers without formatting or a mask |
Optionals#
| Attributes | Type | Description |
|---|---|---|
Request Params#
URL example#
Method
GET https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/chat/5511999999999
Response#
200#
| Attributes | Type | Description |
|---|---|---|
| phone | string | Contact’s phone |
| unread | string | Indicates the number of messages that haven’t been read in a chat |
| lastMessageTime | string | Timestamp with date and time of your last interaction with that chat |
| isMuted | string | 0 or 1 indicates if you have silenced or not a certain chat |
| isMarkedSpam | boolean | True or false indicates if you have marked a chat as spam |
| profileThumbnail | string | Chat photo URL that Whatsapp deletes after 48h |
| isGroupAnnouncement | boolean | true or false indicates if the chat is an announcement group |
| isGroup | boolean | true or false indicates if the chat is a group |
| notes | object (Note) | Notes of the chat (only whatsapp business) |
| messagesUnread | integer | discontinued |
| about | string | Profile about |
Object (Note)
| Atributos | Tipo | Descrição |
|---|---|---|
| id | string | Note id |
| content | string | Note text |
| createdAt | number | Note creation timestamp |
| lastUpdateAt | number | Note last update timestamp |
Example
405#
In this case certify that you are sending the correct specification of the method. This means, verify if you sent a POST or GET as specified at the beginning of this topic.
415#
In case you receive 415 error, make sure to add the “Content-Type” of the object you are sending in the request headers, mostly “application/json”