The Chat Object
The Chat object represents a chat in WhatsApp.
Attributes
The ID of the organization that the chat belongs to.
The ID of the chat.
A map of members/contacts present in the chat. The key is the phone number of the member.
The name of the chat.
For a group
chat, this is the group name.
For an individual
chat, this is the contact name.
The type of chat. Possible values are group
, user
, business
.
Comma-separated labels associated with the chat on Periskope.
The phone number ID of the chat.
The URL path of the chat’s image.
The timestamp when the chat was created.
The timestamp when the chat was last updated.
The invite link of the chat.
Indicates if the chat is muted.
Indicates if the chat is archived.
A key-value map of custom properties associated with the chat. The key is the name of the custom property.
The value is based on custom_property.property_value_type
:
- For
dropdown
type custom properties, the value is the selected option from the dropdown. - For
text
type custom properties, the value is the text value. - For
date
type custom properties, the value is the date value.
The description of the group chat.
Was this page helpful?