Logo Site EngageLab Mark Colored Transparent
Documentation

Obtenir les détails d'un ticket

Récupère les détails d'un ticket à partir de son ID.

Méthode de requête

GET

URL de requête

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

Authentification

Pour plus de détails, consultez les instructions d'authentification dans la Présentation de l'API.

Requête

Exemple de requête

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)' \

            
Afficher ce bloc de code dans la fenêtre flottante

Paramètres de chemin

Field Type Required Description
ticket_id String Yes ID du ticket.

Réponse

Exemple de réponse

{ "code": 0, "message": "Success", "data": { "ticket_id": "tk_20251104_789abc", "title": "Printer jammed and unable to print", "description": "The customer reported that A4 paper is stuck at the paper output tray and requires urgent attention.", "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": "Support 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": "Very fast handling", "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 jammed and unable to print",
    "description": "The customer reported that A4 paper is stuck at the paper output tray and requires urgent attention.",
    "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": "Support 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": "Very fast handling",
      "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
  }
}

            
Afficher ce bloc de code dans la fenêtre flottante

Paramètres de réponse

Field Type Required Description
ticket_id String Yes ID unique du ticket.
title String Yes Titre du ticket.
description String Yes Description détaillée du ticket (prend en charge Markdown).
attachments Array No Liste des pièces jointes au niveau du ticket.
attachments.file_name String Yes Nom du fichier.
attachments.file_type String Yes Type MIME.
attachments.file_url String Yes URL du fichier.
attachments.file_size String Yes Taille du fichier.
status String Yes Statut du ticket, tel que open, in_progress, resolved ou closed.
priority String No Priorité : low, medium, high ou urgent.
ticket_type String No Type de ticket : incident, question, problem ou task.
requester Object Yes Informations sur le demandeur.
requester.euid String No ID unique du contact.
requester.name String No Nom du contact.
requester.email String No Adresse e-mail du contact.
requester.phone String No Numéro de téléphone du contact.
requester.channel_contacts Object No Informations de mappage des contacts du canal (au moins un euid doit être présent).
requester.channel_contacts.channel_id String Yes ID du canal.
requester.channel_contacts.contact_id String Yes ID du contact du canal, par exemple un chat_id Telegram.
requester.channel_contacts.sub_contact_id String No ID du sous-contact du canal, par exemple un topic_id Telegram ou un thread_id d'e-mail.
requester.channel_contacts.followers Array No Informations sur les ID des abonnés utilisées pour les envois ou les notifications dans le canal, y compris les champs id et name.
submitter Object No Membre interne ayant soumis le ticket.
submitter.id String Yes ID utilisateur du soumissionnaire.
assignment_team Object No Informations sur l'équipe d'affectation.
assignment_team.id Integer Yes ID de l'équipe.
assignment_team.name String Yes Nom de l'équipe.
custom_fields Object No Champs personnalisés, tels que les numéros de série des appareils et les numéros de commande.
custom_fields.device_sn String Yes Numéro de série de l'appareil.
conversation_list Array Yes Historique complet des messages du ticket.
conversation_list.message_id String Yes ID unique du message.
conversation_list.sender Object Yes Informations sur l'expéditeur.
conversation_list.sender.id String Yes ID de l'expéditeur.
conversation_list.sender.type String Yes Type d'expéditeur : internal_member, system ou bot.
conversation_list.sender.name String No Nom de l'expéditeur.
conversation_list.content String No Contenu textuel du message.
conversation_list.content_type String Yes Type de contenu : text, image, file, audio ou video.
conversation_list.attachments Array No Liste des pièces jointes du message.
conversation_list.attachments.file_type String Yes Type MIME.
conversation_list.attachments.file_url String Yes URL du fichier.
conversation_list.sent_at String Yes Heure d'envoi (ISO 8601).
conversation_list.is_internal Boolean Yes Indique s'il s'agit d'un message interne non visible par les clients.
status_changes Array No Historique des changements de statut du ticket.
status_changes.to_status String No Statut après modification, tel que open, resolved ou un code personnalisé.
status_changes.changed_at String No Heure de la modification (ISO 8601).
status_changes.changed_by_type String No Source de la modification : user, system ou bot.
status_changes.changed_by_id String No Renvoyé lorsque changed_by_type est user.
tags Array No Étiquettes du ticket.
sla Object No Informations relatives au SLA.
sla.first_response_due String No Date limite de première réponse.
sla.resolution_due String No Date limite de résolution.
sla.first_response_at String No Heure réelle de la première réponse.
sla.breached Boolean No Indique si le SLA a été dépassé.
followers Array No Liste des abonnés.
satisfactions Object No Résultats de l'enquête de satisfaction client.
satisfactions.rating Integer No Note de 1 à 5.
satisfactions.feedback String No Commentaire rédigé.
satisfactions.submitted_at String No Heure de soumission.
created_at String Yes Heure de création du ticket (ISO 8601).
updated_at String Yes Heure de la dernière mise à jour du ticket.
resolved_at String No Heure de résolution (null si non résolu).
closed_at String No Heure de clôture (null si non clôturé).
Icon Solid Transparent White Qiyu
Contacter l'équipe