Attributes

org_id
string

The ID of the organization that the chat belongs to.

chat_id
string

The ID of the chat.

members
object

A map of members/contacts present in the chat. The key is the phone number of the member.

chat_name
string

The name of the chat.

For a group chat, this is the group name. For an individual chat, this is the contact name.

chat_type
string

The type of chat. Possible values are group, user, business.

chat_labels
string

Comma-separated labels associated with the chat on Periskope.

org_phone
string

The phone number ID of the chat.

chat_image
string

The URL path of the chat’s image.

created_at
string

The timestamp when the chat was created.

updated_at
string

The timestamp when the chat was last updated.

invite_link
string

The invite link of the chat.

is_muted
boolean

Indicates if the chat is muted.

is_archived
boolean

Indicates if the chat is archived.

custom_properties
object

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:

  1. For dropdown type custom properties, the value is the selected option from the dropdown.
  2. For text type custom properties, the value is the text value.
  3. For date type custom properties, the value is the date value.
group_description
string

The description of the group chat.