認証
ベアラー トークンとして API キーを送信します。キーには tickets.reply 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/tickets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "subject": <string>, "body": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Opens a ticket in `open` with the supplied `body` as its first message, and publishes `ticket.created` (which sends the customer a localized acknowledgement via the notification consumer). `channel` is server-decided — it is not accepted from the client. A supplied `site_id` or `invoice_id` must belong to the same org or the request is a `404`. Requires `tickets.reply`.
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
subject | string | はい | — |
body | string | はい | The customer's description — becomes the first message in the thread. |
priority | TicketPriority | いいえ | How urgent the ticket is. The customer may propose one; staff decide. |
site_id | string | いいえ | The site this is about. Must belong to the same org or the request is a 404. |
invoice_id | string | いいえ | The invoice this is about. Must belong to the same org or the request is a 404. |
org_id | string | いいえ | The organization to open it in. Required only when the caller holds `tickets.reply` in more than one org. |
on_behalf_of_org_id | string | いいえ | The client org this is about — a reseller escalating to Zinn® on their client's behalf. Must be a **descendant** of the ticket's org or the request is a `404`; your client never… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subject | string | はい | — |
status | TicketStatus | はい | Where a ticket sits in its lifecycle. `open` = waiting on us; `pending` = waiting on the customer; `solved` = we believe it is resolved and a customer reply reopens it; `closed`… |
priority | TicketPriority | はい | How urgent the ticket is. The customer may propose one; staff decide. |
channel | string | はい | How the ticket reached us — `dashboard`, `api` or `staff`. Server-decided; an open string so a future channel is additive on both sides. |
site_id | object | いいえ | — |
invoice_id | object | いいえ | — |
on_behalf_of_org_id | object | いいえ | The **client org** a reseller opened this ticket about. Null on every ordinary ticket. ⛔ Validated as a descendant of the ticket's own org and `404`d otherwise, so it can never… |
assignee_name | object | はい | The owning agent's display name (first name), or null while unassigned. The customer sees a **name** so they know a person owns their ticket; the agent's id and email are staff-… |
first_response_at | object | いいえ | — |
resolved_at | object | いいえ | — |
closed_at | object | いいえ | — |
last_message_at | object | いいえ | — |
reopened_count | integer | はい | — |
message_count | integer | はい | Customer-visible messages in the thread — internal notes are not counted. |
created_at | string | はい | — |
updated_at | string | はい | — |
messages | TicketMessage[] | はい | The customer-visible thread in chronological order. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429