Obtener detalles del ticket

Se proporciona un endpoint para consultar los detalles del ticket a partir de su ID.

Método de solicitud

GET

URL de la solicitud

https://livedesk-api.engagelab.com/api/v2/accounts/tickets/:ticket_id

Autenticación

Para más información, se puede consultar la descripción de la autenticación en Visión general de la API.

Solicitud

Ejemplo de solicitud

curl -X GET 'https://livedesk-api.engagelab.com/api/v2/accounts/tickets/:ticket_id' \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \
              
              curl -X GET 'https://livedesk-api.engagelab.com/api/v2/accounts/tickets/:ticket_id' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \

            
Este bloque de código se muestra en una ventana flotante

Parámetros de la ruta

Parámetro Tipo Obligatorio Descripción
ticket_id String ID del ticket.

Ejemplo de respuesta

{ "code": 0, "message": "Success", "data": { "ticket_id": "tk_20251104_789abc", "title": "Printer paper jam, unable to print", "description": "Customer reported A4 paper jammed at the output tray, needs urgent handling.", "attachments": [ { "file_url": "https://example.com/files/error.jpg" } ], "status": "open", "priority": "high", "ticket_type": "incident", "requester": { "euid": "contact_12345", "name": "Zhang San", "email": "zhangsan@example.com", "phone": "+8613900000000", "channel_contacts": { "channel_id": "inbox_100", "contact_id": "-1001234567890", "sub_contact_id": "23232323", "followers": ["u_12345", "u_67890"] } }, "submitter": { "id": "u_99999" }, "assignment_team": { "id": 5, "name": "IT Support" }, "custom_fields": { "device_sn": "PRN-2024-001" }, "conversation_list": [ { "message_id": "msg_20251104_001", "sender": { "id": "u_12345", "type": "internal_member", "name": "Agent Li" }, "content": "We have received your feedback and are processing it.", "content_type": "text", "attachments": [ { "file_type": "image/jpeg", "file_url": "https://example.com/files/progress.jpg" }, { "file_type": "application/pdf", "file_url": "https://example.com/files/report.pdf" } ], "sent_at": "2025-11-19T05:55:25Z", "is_internal": false } ], "status_changes": [ { "to_status": "in_progress", "changed_at": "2025-11-04T09:25:00+08:00", "changed_by_type": "user", "changed_by_id": "u_12345" }, { "to_status": "resolved", "changed_at": "2025-11-04T10:30:00+08:00", "changed_by_type": "system" } ], "tags": ["printer", "hardware"], "sla": { "first_response_due": "2025-11-04T10:00:00+08:00", "resolution_due": "2025-11-05T18:00:00+08:00", "first_response_at": "2025-11-04T09:20:00+08:00", "breached": false }, "followers": [ {"id": "u_12345"}, {"id": "u_67890"} ], "satisfactions": { "rating": 5, "feedback": "Handled very quickly", "submitted_at": "2025-11-05T09:20:00+08:00" }, "created_at": "2025-11-04T09:15:22+08:00", "updated_at": "2025-11-04T09:18:45+08:00", "resolved_at": null, "closed_at": null } }
              
              {
  "code": 0,
  "message": "Success",
  "data": {
    "ticket_id": "tk_20251104_789abc",
    "title": "Printer paper jam, unable to print",
    "description": "Customer reported A4 paper jammed at the output tray, needs urgent handling.",
    "attachments": [
      {
        "file_url": "https://example.com/files/error.jpg"
      }
    ],
    "status": "open",
    "priority": "high",
    "ticket_type": "incident",
    "requester": {
      "euid": "contact_12345",
      "name": "Zhang San",
      "email": "zhangsan@example.com",
      "phone": "+8613900000000",
      "channel_contacts": {
        "channel_id": "inbox_100",
        "contact_id": "-1001234567890",
        "sub_contact_id": "23232323",
        "followers": ["u_12345", "u_67890"]
      }
    },
    "submitter": {
      "id": "u_99999"
    },
    "assignment_team": {
      "id": 5,
      "name": "IT Support"
    },
    "custom_fields": {
      "device_sn": "PRN-2024-001"
    },
    "conversation_list": [
      {
        "message_id": "msg_20251104_001",
        "sender": {
          "id": "u_12345",
          "type": "internal_member",
          "name": "Agent Li"
        },
        "content": "We have received your feedback and are processing it.",
        "content_type": "text",
        "attachments": [
          {
            "file_type": "image/jpeg",
            "file_url": "https://example.com/files/progress.jpg"
          },
          {
            "file_type": "application/pdf",
            "file_url": "https://example.com/files/report.pdf"
          }
        ],
        "sent_at": "2025-11-19T05:55:25Z",
        "is_internal": false
      }
    ],
    "status_changes": [
      {
        "to_status": "in_progress",
        "changed_at": "2025-11-04T09:25:00+08:00",
        "changed_by_type": "user",
        "changed_by_id": "u_12345"
      },
      {
        "to_status": "resolved",
        "changed_at": "2025-11-04T10:30:00+08:00",
        "changed_by_type": "system"
      }
    ],
    "tags": ["printer", "hardware"],
    "sla": {
      "first_response_due": "2025-11-04T10:00:00+08:00",
      "resolution_due": "2025-11-05T18:00:00+08:00",
      "first_response_at": "2025-11-04T09:20:00+08:00",
      "breached": false
    },
    "followers": [
      {"id": "u_12345"},
      {"id": "u_67890"}
    ],
    "satisfactions": {
      "rating": 5,
      "feedback": "Handled very quickly",
      "submitted_at": "2025-11-05T09:20:00+08:00"
    },
    "created_at": "2025-11-04T09:15:22+08:00",
    "updated_at": "2025-11-04T09:18:45+08:00",
    "resolved_at": null,
    "closed_at": null
  }
}

            
Este bloque de código se muestra en una ventana flotante

Parámetros de la respuesta

Campo Tipo Obligatorio Descripción
ticket_id String ID único del ticket.
title String Título del ticket.
description String Descripción detallada del ticket (admite Markdown).
attachments Array No Lista de archivos adjuntos a nivel de ticket.
attachments[].file_name String No Nombre del archivo.
attachments[].file_type String No Tipo MIME.
attachments[].file_url String URL del archivo.
attachments[].file_size String No Tamaño.
status String Estado del ticket: open/in_progress/resolved/closed, etc.
priority String No Prioridad: low/medium/high/urgent.
ticket_type String No Tipo de ticket: incident/question/problem/task.
requester Object Información del solicitante.
requester.euid String No ID único del contacto.
requester.name String No Nombre del contacto.
requester.email String No Correo electrónico del contacto.
requester.phone String No Número de teléfono del contacto.
requester.channel_contacts Object No Asignación del contacto al canal (debe existir al menos uno con euid).
requester.channel_contacts.channel_id String ID del canal.
requester.channel_contacts.contact_id String ID de contacto del canal (p. ej., chat_id de TG).
requester.channel_contacts.sub_contact_id String No ID de subcontacto del canal (p. ej., topic_id de TG / thread_id de Email).
requester.channel_contacts.followers Array No Información de ID de seguidor (para envío de notificaciones dentro del canal); incluye los campos id (ID del seguidor) y name (nombre del seguidor).
submitter Object No Miembro interno que envió el ticket.
submitter.id String ID de usuario del remitente.
assignment_team Object No Información del equipo asignado.
assignment_team.id Integer ID del equipo.
assignment_team.name String Nombre del equipo.
custom_fields Object No Campos personalizados (p. ej., número de serie del dispositivo, número de pedido, etc.).
custom_fields.device_sn String Número de serie del dispositivo.
conversation_list Array Historial completo de mensajes dentro del ticket.
conversation_list[].message_id String ID único del mensaje.
conversation_list[].sender Object Información del remitente.
conversation_list[].sender.id String ID del remitente.
conversation_list[].sender.type String Tipo de remitente: internal_member/system/bot.
conversation_list[].sender.name String No Nombre del remitente.
conversation_list[].content String No Contenido de texto del mensaje.
conversation_list[].content_type String Tipo de contenido: text/image/file/audio/video.
conversation_list[].attachments Array No Lista de archivos adjuntos del mensaje.
conversation_list[].attachments[].file_type String Tipo MIME.
conversation_list[].attachments[].file_url String URL del archivo.
conversation_list[].sent_at String Hora de envío (ISO8601).
conversation_list[].is_internal Boolean Indica si es un mensaje interno (no visible para los clientes).
status_changes Array No Registro de cambios de estado del ticket.
status_changes[].to_status String No Estado tras el cambio (open/resolved o código personalizado).
status_changes[].changed_at String No Hora del cambio (ISO8601).
status_changes[].changed_by_type String No Origen del cambio: user/system/bot.
status_changes[].changed_by_id String No Se devuelve cuando changed_by_type es user.
tags Array No Etiquetas del ticket.
sla Object No Información de SLA (Service Level Agreement).
sla.first_response_due String No Fecha límite de la primera respuesta.
sla.resolution_due String No Fecha límite de resolución.
sla.first_response_at String No Hora real de la primera respuesta.
sla.breached Boolean No Indica si se ha incumplido.
followers Array No Lista de seguidores.
satisfactions Object No Resultado de la encuesta de satisfacción.
satisfactions.rating Integer No Valoración de 1 a 5.
satisfactions.feedback String No Comentarios de texto.
satisfactions.submitted_at String No Hora de envío.
created_at String Hora de creación del ticket (ISO8601).
updated_at String Hora de la última actualización del ticket.
resolved_at String No Hora de resolución (null si no se ha resuelto).
closed_at String No Hora de cierre (null si no se ha cerrado).
Icon Solid Transparent White Qiyu
Contacto