The Chat Object

{
  "org_id": "00000000-0000-0000-0000-000000000000",
  "chat_id": "120363000000000000@g.us",
  "org_phone": "911111111111@c.us",
  "chat_name": "Example Group",
  "chat_type": "group",
  "chat_image": "https://example.com/images/example.jpg",
  "invite_link": "https://chat.whatsapp.com/invite/AAAAAAAAAAAAAAAAAAAAAA",
  "label_ids": {
    "label-aaaaaaaaaaaaaaaa": true
  },
  "labels": [
    "priority"
  ],
  "custom_properties": {
    "Custom Property": "Value"
  },
  "assigned_to": "user@example.com",
  "chat_access": {
    "user@example.com": true
  },
  "group_description": "A sample group description",
  "info_admins_only": false,
  "messages_admins_only": false,
  "add_members_admins_only": false,
  "member_count": 12,
  "members": {
    "key": {
      "org_id": "00000000-0000-0000-0000-000000000000",
      "chat_id": "120363000000000000@g.us",
      "org_phone": "911111111111@c.us",
      "contact_id": "922222222222@c.us",
      "contact_name": "John Doe",
      "contact_image": "https://example.com/images/example.jpg",
      "contact_color": "#000000",
      "is_admin": false,
      "is_super_admin": false,
      "is_internal": false
    }
  },
  "latest_message": {
    "message_id": "true_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAAAA",
    "org_id": "00000000-0000-0000-0000-000000000000",
    "org_phone": "911111111111@c.us",
    "chat_id": "120363000000000000@g.us",
    "body": "Hello! This is a sample message.",
    "message_type": "chat",
    "from_me": true,
    "author": "922222222222@c.us",
    "ack": "4",
    "timestamp": "2026-01-15T09:30:00+00:00",
    "media": {
      "path": "https://example.com/images/example.jpg",
      "mimetype": "image/png",
      "filename": "image.png"
    },
    "mentioned_ids": [
      "922222222222@c.us"
    ],
    "performed_by": "api",
    "quoted_message_id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "sender_phone": "911111111111@c.us",
    "sent_message_id": "00000000-0000-0000-0000-000000000000",
    "delivery_info": {
      "delivered": {
        "key": null
      },
      "read": {
        "key": null
      },
      "pending": [
        null
      ],
      "read_count": null,
      "delivered_count": null
    },
    "is_deleted": null,
    "is_forwarded": null,
    "is_starred": null,
    "has_media": null,
    "unique_id": "AAAAAAAAAAAAAAAAAAAAAA",
    "updated_at": "2026-01-15T09:31:12.884+00:00"
  },
  "latest_message_timestamp": "2026-01-15T09:30:00+00:00",
  "message_unread_count": 0,
  "flag_count_map": {
    "key": null
  },
  "parent_community_id": null,
  "is_archived": false,
  "group_metadata": {},
  "is_muted": false,
  "is_exited": false,
  "closed_at": null,
  "created_at": "2026-01-10T08:00:00+00:00",
  "updated_at": "2026-01-15T09:30:00.025233+00:00"
}

{
  "org_id": "00000000-0000-0000-0000-000000000000",
  "chat_id": "120363000000000000@g.us",
  "org_phone": "911111111111@c.us",
  "chat_name": "Example Group",
  "chat_type": "group",
  "chat_image": "https://example.com/images/example.jpg",
  "invite_link": "https://chat.whatsapp.com/invite/AAAAAAAAAAAAAAAAAAAAAA",
  "label_ids": {
    "label-aaaaaaaaaaaaaaaa": true
  },
  "labels": [
    "priority"
  ],
  "custom_properties": {
    "Custom Property": "Value"
  },
  "assigned_to": "user@example.com",
  "chat_access": {
    "user@example.com": true
  },
  "group_description": "A sample group description",
  "info_admins_only": false,
  "messages_admins_only": false,
  "add_members_admins_only": false,
  "member_count": 12,
  "members": {
    "key": {
      "org_id": "00000000-0000-0000-0000-000000000000",
      "chat_id": "120363000000000000@g.us",
      "org_phone": "911111111111@c.us",
      "contact_id": "922222222222@c.us",
      "contact_name": "John Doe",
      "contact_image": "https://example.com/images/example.jpg",
      "contact_color": "#000000",
      "is_admin": false,
      "is_super_admin": false,
      "is_internal": false
    }
  },
  "latest_message": {
    "message_id": "true_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAAAA",
    "org_id": "00000000-0000-0000-0000-000000000000",
    "org_phone": "911111111111@c.us",
    "chat_id": "120363000000000000@g.us",
    "body": "Hello! This is a sample message.",
    "message_type": "chat",
    "from_me": true,
    "author": "922222222222@c.us",
    "ack": "4",
    "timestamp": "2026-01-15T09:30:00+00:00",
    "media": {
      "path": "https://example.com/images/example.jpg",
      "mimetype": "image/png",
      "filename": "image.png"
    },
    "mentioned_ids": [
      "922222222222@c.us"
    ],
    "performed_by": "api",
    "quoted_message_id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "sender_phone": "911111111111@c.us",
    "sent_message_id": "00000000-0000-0000-0000-000000000000",
    "delivery_info": {
      "delivered": {
        "key": null
      },
      "read": {
        "key": null
      },
      "pending": [
        null
      ],
      "read_count": null,
      "delivered_count": null
    },
    "is_deleted": null,
    "is_forwarded": null,
    "is_starred": null,
    "has_media": null,
    "unique_id": "AAAAAAAAAAAAAAAAAAAAAA",
    "updated_at": "2026-01-15T09:31:12.884+00:00"
  },
  "latest_message_timestamp": "2026-01-15T09:30:00+00:00",
  "message_unread_count": 0,
  "flag_count_map": {
    "key": null
  },
  "parent_community_id": null,
  "is_archived": false,
  "group_metadata": {},
  "is_muted": false,
  "is_exited": false,
  "closed_at": null,
  "created_at": "2026-01-10T08:00:00+00:00",
  "updated_at": "2026-01-15T09:30:00.025233+00:00"
}

{
  "org_id": "00000000-0000-0000-0000-000000000000",
  "chat_id": "120363000000000000@g.us",
  "org_phone": "911111111111@c.us",
  "chat_name": "Example Group",
  "chat_type": "group",
  "chat_image": "https://example.com/images/example.jpg",
  "invite_link": "https://chat.whatsapp.com/invite/AAAAAAAAAAAAAAAAAAAAAA",
  "label_ids": {
    "label-aaaaaaaaaaaaaaaa": true
  },
  "labels": [
    "priority"
  ],
  "custom_properties": {
    "Custom Property": "Value"
  },
  "assigned_to": "user@example.com",
  "chat_access": {
    "user@example.com": true
  },
  "group_description": "A sample group description",
  "info_admins_only": false,
  "messages_admins_only": false,
  "add_members_admins_only": false,
  "member_count": 12,
  "members": {
    "key": {
      "org_id": "00000000-0000-0000-0000-000000000000",
      "chat_id": "120363000000000000@g.us",
      "org_phone": "911111111111@c.us",
      "contact_id": "922222222222@c.us",
      "contact_name": "John Doe",
      "contact_image": "https://example.com/images/example.jpg",
      "contact_color": "#000000",
      "is_admin": false,
      "is_super_admin": false,
      "is_internal": false
    }
  },
  "latest_message": {
    "message_id": "true_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAAAA",
    "org_id": "00000000-0000-0000-0000-000000000000",
    "org_phone": "911111111111@c.us",
    "chat_id": "120363000000000000@g.us",
    "body": "Hello! This is a sample message.",
    "message_type": "chat",
    "from_me": true,
    "author": "922222222222@c.us",
    "ack": "4",
    "timestamp": "2026-01-15T09:30:00+00:00",
    "media": {
      "path": "https://example.com/images/example.jpg",
      "mimetype": "image/png",
      "filename": "image.png"
    },
    "mentioned_ids": [
      "922222222222@c.us"
    ],
    "performed_by": "api",
    "quoted_message_id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "sender_phone": "911111111111@c.us",
    "sent_message_id": "00000000-0000-0000-0000-000000000000",
    "delivery_info": {
      "delivered": {
        "key": null
      },
      "read": {
        "key": null
      },
      "pending": [
        null
      ],
      "read_count": null,
      "delivered_count": null
    },
    "is_deleted": null,
    "is_forwarded": null,
    "is_starred": null,
    "has_media": null,
    "unique_id": "AAAAAAAAAAAAAAAAAAAAAA",
    "updated_at": "2026-01-15T09:31:12.884+00:00"
  },
  "latest_message_timestamp": "2026-01-15T09:30:00+00:00",
  "message_unread_count": 0,
  "flag_count_map": {
    "key": null
  },
  "parent_community_id": null,
  "is_archived": false,
  "group_metadata": {},
  "is_muted": false,
  "is_exited": false,
  "closed_at": null,
  "created_at": "2026-01-10T08:00:00+00:00",
  "updated_at": "2026-01-15T09:30:00.025233+00:00"
}

Attributes

string

The unique identifier of the organization that owns the WhatsApp account.

string

The unique identifier of the WhatsApp chat (format: {phone_number}@c.us for individual chats or {group_id}@g.us for groups).

string

The organization phone that the chat belongs to (in the format {phone_number}@c.us).

string

The display name of the chat. For groups, this is the group name. For individual chats, this is the contact’s name.

string

The type of chat. Can be group, user, or business.

string

The URL of the chat’s profile image.

string

The invite link of the chat. Group chats only, and only when the phone is an admin.

object

A map of label identifiers associated with the chat, where keys are label IDs and values are booleans.

string[]

An array of labels associated with the chat.

object

A map of custom properties associated with the chat. Values depend on the property type: dropdown, text, date.

string

The email address of the user assigned to this chat. Absent when unassigned.

object

A map of user access permissions, where keys are email addresses and values are booleans. Absent when no per-chat overrides exist.

string

The description text for group chats. Group chats only.

boolean

Indicates if only admins can modify group info.

boolean

Indicates if only admins can send messages in the group.

boolean

Indicates if only admins can add new members to the group.

integer

The total number of participants in the chat.

object

A map of members in the chat, keyed by WhatsApp ID (format: {phone_number}@c.us). Only returned when fetching a single chat by id — list results omit it.

Show each value

string

The unique identifier of the organization that owns the WhatsApp account.

string

The unique identifier of the WhatsApp chat.

string

The WhatsApp ID of the organization’s account (format: {phone_number}@c.us).

string

The WhatsApp ID of the member (format: {phone_number}@c.us).

string

The display name of the member.

string

The URL of the member’s profile image.

string

The hex color code assigned to the member in Periskope’s UI.

boolean

Indicates if the member has admin privileges in the chat.

boolean

Indicates if the member has super admin privileges in the chat.

boolean

Indicates if the member is an internal user of the organization.

object

An object containing details about the latest message sent in the chat.

Show properties

string

Unique id of the message, in the form <from_me><chat_id><wa_message_id>

string

Id of the organization the message belongs to

string

Org phone (WhatsApp account) the message was sent or received on, as country code + number suffixed with @c.us

string

Chat the message belongs to — <countrycode><number>@c.us for 1-1 chats, <group-id>@g.us for group chats

string

Text content of the message, or the caption of a media message.

string

Content type of the message: ‘chat’ for text, otherwise the media/attachment type (e.g. ‘image’, ‘video’, ‘document’, ‘audio’, ‘ptt’, ‘sticker’, ‘location’, ‘poll_creation’)

boolean

true when the message was sent by the org phone, false when it was received from the contact

string

In group chats, the participant who sent the message (<countrycode><number>@c.us).

string

WhatsApp acknowledgement level of an outgoing message as a string: ‘1’ sent, ‘2’ delivered, ‘3’ read, ‘4’ played/read.

string

When the message was sent, as an ISO 8601 UTC timestamp

object

Media attached to the message (may also carry dimensions, size, thumbnail).

Show properties

string

URL of the media file

string

MIME type of the media file

string

Filename of the media file, when applicable

string[]

Contact ids @-mentioned in the message body.

string

Member email or “api” when the message was sent through Periskope.

string

message_id of the message this message replies to. Absent when the message is not a reply.

string

Phone that sent the message, as country code + number suffixed with @c.us

string

Internal id assigned when the message was sent via the Periskope queue. Absent for received messages.

object

Per-recipient delivery and read receipts of an outgoing message.

Show properties

object

Map of recipient contact_id to delivery epoch-ms timestamp

object

Map of recipient contact_id to read epoch-ms timestamp

string[]

Recipients the message has not been delivered to yet

number

Number of recipients who have read the message

number

Number of recipients the message was delivered to

boolean

true when the message was deleted for everyone.

boolean

true when the message was forwarded.

boolean

true when the message is starred.

boolean

true when the message carries media.

string

WhatsApp message id without the from_me/chat_id prefix — accepted by message endpoints in place of the full message_id

string

When the message record was last updated (e.g. by a delivery receipt), as an ISO 8601 UTC timestamp

string

Timestamp of the most recent message in the chat, as an ISO 8601 UTC timestamp.

integer

The number of unread messages in the chat.

object

A map of flagged messages, where keys are phone numbers and values are flagged messages count.

string

Indicates the id of the parent community for the group.

boolean

Indicates if the chat has been archived.

object

Additional raw group metadata synced from WhatsApp, when present

boolean

Indicates if notifications for this chat are muted.

boolean

Indicates if the organization has left this chat.

number

The timestamp when the chat was closed, if applicable, as an epoch timestamp in milliseconds. Absent while the chat is open.

string

The ISO 8601 formatted timestamp when the chat was created.

string

The ISO 8601 formatted timestamp when the chat was last updated.

API

Chat APIs

Group Settings APIs

Message APIs

Scheduled Message APIs

Media APIs

Contact APIs

Ticket APIs

Custom Property APIs

Task APIs

Queue APIs

Phone APIs

Notes APIs

Reaction APIs

Knowledge Base APIs

Member APIs

AI APIs

Webhook APIs

Webhooks