אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה tickets.reply; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כשדה בגוף ה-JSON.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
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 בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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