The Ticket Object
The Ticket Info Object represents a ticket on Periskope.
{
"chat": {
"org_id": "2997xx64-89bf-48d3-9a22-b314fxx017e5",
"org_phone": "91900438XXXX@c.us",
"chat_id": "919X836X025X090@Xc.us",
"chat_name": "Demo Chat",
"chat_type": "chat",
"chat_image": "/storage/image.jpeg",
"chat_labels": "label1, label2",
"custom_properties": {
"Property1": "opXtion1",
"Property2": "opXtion1",
"Property3": "opXtion1"
},
},
"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,
"raised_by": "raisedby@example.com",
"ticket_id": "TICKET-12345",
"created_at": "2024-05-24T08:30:00+00:00",
"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"
}
},
"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"
}]
}
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",
"chat_name": "Demo Chat",
"chat_type": "chat",
"chat_image": "/storage/image.jpeg",
"chat_labels": "label1, label2",
"custom_properties": {
"Property1": "opXtion1",
"Property2": "opXtion1",
"Property3": "opXtion1"
},
},
"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,
"raised_by": "raisedby@example.com",
"ticket_id": "TICKET-12345",
"created_at": "2024-05-24T08:30:00+00:00",
"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"
}
},
"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
The unique identifier of the organization.
The phone number of the organization.
The unique identifier of the chat.
The name of the chat.
The type of the chat.
The image URL of the chat.
Comma-separated labels associated with the chat.
Additional custom properties of the chat. Key-value map for the custom properties associated with the chat.
The unique identifier of the organization.
The status of the ticket.
The subject of the ticket.
The email address of the assignee.
The due date of the ticket.
The priority of the ticket.
The email address of the user who raised the ticket.
The unique identifier of the ticket.
The creation date of the ticket.
Comma-separated labels associated with the ticket.
The email address of the user who assigned the ticket.
The unique identifier of the quoted message.
Additional custom properties of the ticket. Key-value map for the custom properties associated with the ticket.
The text of the message.
The unique identifier of the chat.
The phone number of the organization.
The timestamp of the message.
The media path of the message.
The unique identifier of the message.
The name of the sender.
The email address of the user who performed the action.
The phone number of the sender.
An array of messages attached to the ticket.
The text of the message.
The unique identifier of the chat.
The phone number of the organization.
The timestamp of the message.
The media path of the message.
The unique identifier of the message.
The name of the sender.
The email address of the user who performed the action.
The phone number of the sender.
Was this page helpful?
{
"chat": {
"org_id": "2997xx64-89bf-48d3-9a22-b314fxx017e5",
"org_phone": "91900438XXXX@c.us",
"chat_id": "919X836X025X090@Xc.us",
"chat_name": "Demo Chat",
"chat_type": "chat",
"chat_image": "/storage/image.jpeg",
"chat_labels": "label1, label2",
"custom_properties": {
"Property1": "opXtion1",
"Property2": "opXtion1",
"Property3": "opXtion1"
},
},
"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,
"raised_by": "raisedby@example.com",
"ticket_id": "TICKET-12345",
"created_at": "2024-05-24T08:30:00+00:00",
"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"
}
},
"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"
}]
}