チケット詳細の取得

チケットIDに基づいてチケットの詳細を取得する機能を提供します。

リクエスト方式

GET

呼び出しアドレス

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

呼び出し検証

詳細はAPI概要の認証方式の説明を参照してください。

リクエスト

リクエスト例

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

このコードブロックはフローティングウィンドウ内に表示されます

パスパラメータ

フィールド	タイプ	必須	説明
ticket_id	String	はい	チケットID。

レスポンス例

{ "code": 0, "message": "Success", "data": { "ticket_id": "tk_20251104_789abc", "title": "プリンター紙詰まり、印刷不可", "description": "顧客よりA4用紙が排紙トレイで詰まったとの報告あり、緊急対応が必要。", "attachments": [ { "file_url": "https://example.com/files/error.jpg" } ], "status": "open", "priority": "high", "ticket_type": "incident", "requester": { "euid": "contact_12345", "name": "張三", "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サポート" }, "custom_fields": { "device_sn": "PRN-2024-001" }, "conversation_list": [ { "message_id": "msg_20251104_001", "sender": { "id": "u_12345", "type": "internal_member", "name": "エージェント李" }, "content": "フィードバックを受け取りました。現在処理中です。", "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": "処理が早かった", "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": "プリンター紙詰まり、印刷不可",
    "description": "顧客よりA4用紙が排紙トレイで詰まったとの報告あり、緊急対応が必要。",
    "attachments": [
      {
        "file_url": "https://example.com/files/error.jpg"
      }
    ],
    "status": "open",
    "priority": "high",
    "ticket_type": "incident",
    "requester": {
      "euid": "contact_12345",
      "name": "張三",
      "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サポート"
    },
    "custom_fields": {
      "device_sn": "PRN-2024-001"
    },
    "conversation_list": [
      {
        "message_id": "msg_20251104_001",
        "sender": {
          "id": "u_12345",
          "type": "internal_member",
          "name": "エージェント李"
        },
        "content": "フィードバックを受け取りました。現在処理中です。",
        "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": "処理が早かった",
      "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
  }
}

このコードブロックはフローティングウィンドウ内に表示されます

レスポンスパラメータ

フィールド	タイプ	必須	説明
ticket_id	String	はい	チケット一意ID。
title	String	はい	チケットタイトル。
description	String	はい	チケット詳細説明（Markdownをサポート）。
attachments	Array	いいえ	チケットレベルの添付ファイルリスト。
file_name	String	はい	ファイル名。
file_type	String	はい	MIMEタイプ。
file_url	String	はい	ファイルアドレス。
file_size	String	はい	サイズ。
status	String	はい	チケットステータス：open/in_progress/resolved/closedなど。
priority	String	いいえ	優先度：low/medium/high/urgent。
ticket_type	String	いいえ	チケットタイプ：incident/question/problem/task。
requester	Object	はい	リクエスター情報。
euid	String	いいえ	連絡先一意ID。
name	String	いいえ	連絡先名。
email	String	いいえ	連絡先メールアドレス。
phone	String	いいえ	連絡先携帯電話番号。
channel_contacts	Object	いいえ	チャネル連絡先マッピング（euidと少なくとも1つ存在すること）。
channel_id	String	はい	チャネルID。
contact_id	String	はい	チャネル連絡先ID（例：TGのchat_id）。
sub_contact_id	String	いいえ	チャネルサブ連絡先ID（例：TGのtopic_id / Emailのthread_id）。
followers	Array	いいえ	フォロワーID情報（チャネル内プッシュ/通知に使用）、idとnameフィールドを含む。 id: フォロワーID。 name: フォロワー名。
submitter	Object	いいえ	チケットを提出した内部メンバー。
id	String	はい	提出者ユーザーID。
assignment_team	Object	いいえ	割り当てチーム情報。
id	Integer	はい	チームID。
name	String	はい	チーム名。
custom_fields	Object	いいえ	カスタムフィールド（デバイスシリアル番号、注文番号など）。
device_sn	String	はい	デバイスシリアル番号。
conversation_list	Array	はい	チケット内のすべてのメッセージ履歴。
message_id	String	はい	メッセージ一意ID。
sender	Object	はい	送信者情報。
id	String	はい	送信者ID。
type	String	はい	送信者タイプ：internal_member/system/bot。
name	String	いいえ	送信者名。
content	String	いいえ	メッセージテキスト内容。
content_type	String	はい	コンテンツタイプ：text/image/file/audio/video。
attachments	Array	いいえ	メッセージ添付ファイルリスト。
file_type	String	はい	MIMEタイプ。
file_url	String	はい	ファイルアドレス。
sent_at	String	はい	送信時間（ISO8601）。
is_internal	boolean	はい	内部メッセージかどうか（顧客には不可視）。
status_changes	Array	いいえ	チケットステータス変更履歴。
to_status	String	いいえ	変更後のステータス（open/resolvedまたはカスタムコード）。
changed_at	String	いいえ	変更時間（ISO8601）。
changed_by_type	String	いいえ	変更ソース：user/system/bot。
changed_by_id	String	いいえ	changed_by_typeがuserの場合に返されます。
tags	Array	いいえ	チケットタグ。
sla	Object	いいえ	SLAサービスレベル契約情報。
first_response_due	String	いいえ	初回応答期限。
resolution_due	String	いいえ	解決期限。
first_response_at	String	いいえ	実際の初回応答時間。
breached	boolean	いいえ	違反したかどうか。
followers	Array	いいえ	フォロワーリスト。
satisfactions	Object	いいえ	満足度調査結果。
rating	Integer	いいえ	評価 1-5。
feedback	String	いいえ	テキストフィードバック。
submitted_at	String	いいえ	提出時間。
created_at	String	はい	チケット作成時間（ISO8601）。
updated_at	String	はい	チケット最終更新時間。
resolved_at	String	いいえ	解決時間（未解決の場合はnull）。
closed_at	String	いいえ	クローズ時間（未クローズの場合はnull）。