チケットを作成
開発者は、APIを使用してチケットを作成できます。チケットが作成されると、チケットIDが返されます。
リクエストメソッド
POST
エンドポイント
https://livedesk-api.engagelab.com/api/v2/accounts/tickets
認証
詳細については、API Overview の認証手順を参照してください。
リクエスト
リクエスト例
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階プリンター室"
}
}'
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| Field | Type | Description |
|---|---|---|
| Authorization | string | Authorization: Basic base64(API Key:API Secret) を使用して認証します。API Keysページに移動してAPI keyとAPI secretを取得し、コロンで連結してBase64でエンコードしてください。 |
| Content-Type | application/json | データ型です。値は application/json である必要があります。 |
リクエスト本文パラメータ
| Field | Type | Required | Description |
|---|---|---|---|
| title | String | Yes | チケットのタイトル。 |
| description | String | No | チケットの説明。Markdown形式に対応しています。 |
| attachments | Array | No | 添付ファイルの配列です。事前に /upload を使用してファイルをアップロードしてください。 |
| file_url | String | Yes | ファイルのURL。 |
| requester | Object | Yes | 依頼者情報。 |
| euid | String | No | 一意の連絡先ID。 |
| channel_contacts | Object | No | チャネル連絡先のマッピング。euid とこのフィールドの少なくとも一方を指定する必要があります。 |
| channel_id | String | Yes | チャネルID。 |
| contact_id | String | Yes | チャネル連絡先ID。例：TelegramのチャットID。 |
| sub_contact_id | String | No | チャネルのサブ連絡先ID。例：TelegramのトピックIDまたはメールスレッドID。 |
| followers | Array | No | チャネル内でのプッシュ通知および通知に使用されるフォロワー情報の配列です。id フィールドと name フィールドを含みます。id: フォロワーID。name: フォロワー名。 |
| submitter | Object | No | 送信者情報。id フィールドを含みます。id: 送信者ID。 |
| assignment_team | String | No | 割り当て先のチーム名。チームはあらかじめ作成されている必要があります。 |
| priority | String | No | 優先度：high、medium、または low。省略した場合のデフォルト値は medium です。 |
| ticket_type | String | No | チケットタイプ：problem、incident、question、task、または none。省略した場合のデフォルト値は none です。 |
| custom_fields | Object | No | ソース情報などのカスタムフィールドです。キーと値の形式で指定します。 |
レスポンス
成功レスポンス
{
"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"
}
}
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
| ticket_id | String | No | チケットID。 |
| message | String | No | 返されるメッセージ。例："Ticket created successfully"。 |
