This object represents a detailed ticket along with its related chat and message details on Periskope.
{
"chat": {
"org_id": "2997xx64-89bf-48d3-9a22-b314fxx017e5",
"org_phone": "91900438XXXX@c.us",
"chat_id": "919X836X025X090@Xc.us",
"members": {
"918527184400@c.us": {
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"chat_id": "919537851844@c.us",
"is_admin": true,
"org_phone": "918527184400@c.us",
"contact_id": "918527184400@c.us",
"is_internal": true,
"contact_name": "Support",
"contact_color": "#B4876E",
"contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737690126280",
"is_super_admin": true
},
"919537851844@c.us": {
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"chat_id": "919537851844@c.us",
"is_admin": true,
"org_phone": "918527184400@c.us",
"contact_id": "919537851844@c.us",
"is_internal": false,
"contact_name": "BK Local1",
"contact_color": "#B4876E",
"contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
"is_super_admin": true
}
},
"is_muted": false,
"chat_name": "Demo Chat",
"chat_type": "chat",
"chat_image": "/storage/image.jpeg",
"created_at": "2025-01-26T02:30:50+00:00",
"chat_labels": "label1, label2",
"invite_link": "https://chat.whatsapp.com/invite/BZcwk7oCxxVIhExxxcmKxN"
"custom_properties": {
"Property1": "opXtion1",
"Property2": "opXtion1",
"Property3": "opXtion1"
},
"group_description": null
},
"message": {
"body": "hello",
"chat_id": "X919836025090@c.us",
"org_phone": "X91900438XXXX@c.us",
"timestamp": "2024-05-13T17:27:15+00:00",
"media_path": "/path/to/media",
"message_id": "true_91983602XXXX@c.us_3EB0DAB631F7E58XXXXE0C",
"sender_name": "Periskope Central",
"performed_by": "demo@email.com",
"sender_phone": "91900438XXXX"
},
"ticket": {
"org_id": "2997xx64-89bf-48d3-9a22-b314fxx017e5",
"status": "open",
"subject": "Sample Ticket Subject",
"assignee": "assignee@example.com",
"due_date": "2024-06-15T12:00:00+00:00",
"priority": 2,
"closed_at": "2024-06-14T12:00:00+00:00",
"closed_by": "closedby@example.com",
"raised_by": "raisedby@example.com",
"ticket_id": "TICKET-12345",
"created_at": "2024-05-24T08:30:00+00:00",
"is_deleted": false,
"assigned_by": "manager@example.com",
"ticket_labels": "label1, label2",
"quoted_message_id": "3EB0DAB631F7E580EAAE0C"
"ticket_custom_properties": {
"property-1": "value-1",
"property-2": "value-2",
"property-3": "value-3"
},
"first_assigned_at" : null
},
"attached_messages": [{
"body": "hello",
"chat_id": "X919836025090@c.us",
"org_phone": "X91900438XXXX@c.us",
"timestamp": "2024-05-13T17:27:15+00:00",
"media_path": "/path/to/media",
"message_id": "true_91983602XXXX@c.us_3EB0DAB631F7E58XXXXE0C",
"sender_name": "Periskope Central",
"performed_by": "demo@email.com",
"sender_phone": "91900438XXXX"
},{
"body": "attached message 1",
"chat_id": "X919836025090@c.us",
"org_phone": "X91900438XXXX@c.us",
"timestamp": "2024-05-13T17:27:15+00:00",
"media_path": "/path/to/media",
"message_id": "true_91983602XXXX@c.us_3EB0DAB631F7E58XXXXE0C",
"sender_name": "Periskope Central",
"performed_by": "demo@email.com",
"sender_phone": "91900438XXXX"
}]
}
Attributes
object
Show child attributes
Show child attributes
string
The unique identifier of the organization.
string
The phone number of the organization.
string
The unique identifier of the chat.
object
A map of members in the chat, keyed by WhatsApp ID (format:
{phone_number}@c.us).Show child attributes
Show child attributes
string
The unique identifier of the organization that owns the WhatsApp
account.
string
The unique identifier of the WhatsApp chat.
boolean
Indicates if the member has admin privileges in the 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).boolean
Indicates if the member is an internal user of the organization.
string
The display name of the member.
string
The hex color code assigned to the member in Periskope’s UI.
string
The URL of the member’s profile image.
boolean
Indicates if the member has super admin privileges in the chat.
boolean
Indicates if notifications for this chat are muted.
string
The name of the chat.
string
The type of the chat.
string
The image URL of the chat.
string
The ISO 8601 formatted timestamp when the chat was created.
string
Comma-separated labels associated with the chat.
string
The invite link of the chat.
object
Additional custom properties of the chat. Key-value map for the custom
properties associated with the chat.
string
The description text for group chats.
object
Show child attributes
Show child attributes
string
The unique identifier of the organization.
string
The status of the ticket.
string
The subject of the ticket.
string
The email address of the assignee.
string
The due date of the ticket.
number
The priority of the ticket.
string
The date when the ticket was closed.
string
The email address of the user who closed the ticket.
string
The email address of the user who raised the ticket.
string
The unique identifier of the ticket.
string
The creation date of the ticket.
boolean
Is set to
true if ticket is deleted. It is false otherwise.string
Comma-separated labels associated with the ticket.
string
The email address of the user who assigned the ticket.
string
The unique identifier of the quoted message.
object
Additional custom properties of the ticket. Key-value map for the custom
properties associated with the ticket.
string
The date when the ticket was first assigned.
object
Show child attributes
Show child attributes
string
The text of the message.
string
The unique identifier of the chat.
string
The phone number of the organization.
string
The timestamp of the message.
string
The media path of the message.
string
The unique identifier of the message.
string
The name of the sender.
string
The email address of the user who performed the action.
string
The phone number of the sender.
array
An array of messages attached to the ticket.
Show child attributes
Show child attributes
string
The text of the message.
string
The unique identifier of the chat.
string
The phone number of the organization.
string
The timestamp of the message.
string
The media path of the message.
string
The unique identifier of the message.
string
The name of the sender.
string
The email address of the user who performed the action.
string
The phone number of the sender.