チケットの作成

開発者はAPIを通じてチケットを作成できます。チケット作成後、チケットIDが返されます。

リクエスト方式

POST

呼び出しアドレス

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

呼び出し検証

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

リクエスト

リクエスト例

curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/tickets' \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ -d '{ "title": "プリンター紙詰まり、印刷不可", "description": "顧客よりA4用紙が排紙トレイで詰まったとの報告あり、緊急対応が必要。", "attachments": [ { "file_url": "https://example.com/files/error.jpg" } ], "requester": { "euid": "contact_12345", "channel_contacts": { "channel_id": "inbox_100", "contact_id": "-1001234567890", "sub_contact_id": "23232323", "followers": [ { "id": "7562646527", "name": "張三" } ] } }, "submitter": { "id": "u_12345" }, "assignment_team": "ITサポート", "priority": "high", "ticket_type": "incident", "custom_fields": { "device_sn": "PRN-2024-001", "location": "北京本社-3階印刷室" } }'

              
              curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/tickets' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
-d '{
  "title": "プリンター紙詰まり、印刷不可",
  "description": "顧客よりA4用紙が排紙トレイで詰まったとの報告あり、緊急対応が必要。",
  "attachments": [
    {
      "file_url": "https://example.com/files/error.jpg"
    }
  ],
  "requester": {
    "euid": "contact_12345",
    "channel_contacts": {
      "channel_id": "inbox_100",
      "contact_id": "-1001234567890",
      "sub_contact_id": "23232323",
      "followers": [
        {
          "id": "7562646527",
          "name": "張三"
        }
      ]
    }
  },
  "submitter": {
    "id": "u_12345"
  },
  "assignment_team": "ITサポート",
  "priority": "high",
  "ticket_type": "incident",
  "custom_fields": {
    "device_sn": "PRN-2024-001",
    "location": "北京本社-3階印刷室"
  }
}'

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

リクエストヘッダー

フィールド	タイプ	説明
Authorization	string	`Authorization: Basic base64(API Key:API Secret)`を使用して認証を行います。APIキーページにアクセスしてAPI KeyとAPI Secretを取得し、両者をコロンで連結した後にBase64エンコードしてください。
Content-Type	application/json	データタイプ。application/jsonを使用します。

リクエストボディパラメータ

フィールド	タイプ	必須	説明
title	String	はい	チケットタイトル。
description	String	いいえ	チケット内容の説明、md形式をサポート。
attachments	Array	いいえ	添付ファイル配列。先に/uploadを通じてアップロードする必要があります。
file_url	String	はい	ファイルアドレス。
requester	Object	はい	リクエスター情報。
euid	String	いいえ	連絡先一意ID。
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（内部メンバーアカウントID）、idフィールドを含む。 id: 提出者ID。
assignment_team	String	いいえ	割り当てチーム名（既存であること）。
priority	String	いいえ	優先度: high/medium/low、指定しない場合はデフォルトでmedium。
ticket_type	String	いいえ	チケットタイプ：problem/incident/question/task/None、指定しない場合はデフォルトでNone。
custom_fields	Object	いいえ	カスタムフィールド（ソース情報など）、key-value形式を使用。

レスポンス例

成功レスポンス

{ "code": 0, "message": "Success", "data": { "ticket_id": "tk_20251104_789abc", "message": "Ticket created successfully" } }

              
              {
  "code": 0,
  "message": "Success",
  "data": {
    "ticket_id": "tk_20251104_789abc",
    "message": "Ticket created successfully"
  }
}

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

レスポンスパラメータ

フィールド	タイプ	必須	説明
ticket_id	String	いいえ	チケットID。
message	String	いいえ	返却メッセージ内容。例："Ticket created successfully"