Skip to main content
GET
Get chat metadata

Overview

This method is responsible for returning a chat’s metadata information.

Attributes

string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.

Path

string
required
Contact phone number in DDI DDD NUMBER format. E.g.: 551199999999

Response

200

string
Contact phone number
string
Number of unread messages
string
Last interaction timestamp
string
0 or 1 indicating if the chat is muted
boolean
Whether the chat is marked as spam
string
Chat photo URL (deleted after 48h by WhatsApp)
boolean
Whether it is an announcement group
boolean
Whether it is a group
string
Profile status
object
Chat annotations (available only for WhatsApp Business)

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.