Autentificare
Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea tickets.reply; o cheie care nu o are va fi respinsă cu 403, nu 404.
Unde merge ID-ul organizației tale
Acest punct final preia org_id ca câmp în corpul JSON.
ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X POST https://api.zinndigital.com/v1/tickets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "subject": <string>, "body": <string> }'Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
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`.
Corp cerere
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
subject | string | Da | — |
body | string | Da | The customer's description — becomes the first message in the thread. |
priority | TicketPriority | Nu | How urgent the ticket is. The customer may propose one; staff decide. |
site_id | string | Nu | The site this is about. Must belong to the same org or the request is a 404. |
invoice_id | string | Nu | The invoice this is about. Must belong to the same org or the request is a 404. |
org_id | string | Nu | 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 | Nu | 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… |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subject | string | Da | — |
status | TicketStatus | Da | 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 | Da | How urgent the ticket is. The customer may propose one; staff decide. |
channel | string | Da | 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 | Nu | — |
invoice_id | object | Nu | — |
on_behalf_of_org_id | object | Nu | 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 | Da | 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 | Nu | — |
resolved_at | object | Nu | — |
closed_at | object | Nu | — |
last_message_at | object | Nu | — |
reopened_count | integer | Da | — |
message_count | integer | Da | Customer-visible messages in the thread — internal notes are not counted. |
created_at | string | Da | — |
updated_at | string | Da | — |
messages | TicketMessage[] | Da | The customer-visible thread in chronological order. |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 422 · 429