Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie tickets.reply; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako pole w treści JSON.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X POST https://api.zinndigital.com/v1/tickets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "subject": <string>, "body": <string> }'Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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.
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
subject | string | Tak | — |
body | string | Tak | The customer's description — becomes the first message in the thread. |
priority | TicketPriority | Nie | How urgent the ticket is. The customer may propose one; staff decide. |
site_id | string | Nie | The site this is about. Must belong to the same org or the request is a 404. |
invoice_id | string | Nie | The invoice this is about. Must belong to the same org or the request is a 404. |
org_id | string | Nie | 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 | Nie | 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… |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subject | string | Tak | — |
status | TicketStatus | Tak | 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 | Tak | How urgent the ticket is. The customer may propose one; staff decide. |
channel | string | Tak | 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 | Nie | — |
invoice_id | object | Nie | — |
on_behalf_of_org_id | object | Nie | 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 404d otherwise, so it can never… |
assignee_name | object | Tak | 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… |
first_response_at | object | Nie | — |
resolved_at | object | Nie | — |
closed_at | object | Nie | — |
last_message_at | object | Nie | — |
reopened_count | integer | Tak | — |
message_count | integer | Tak | Customer-visible messages in the thread — internal notes are not counted. |
created_at | string | Tak | — |
updated_at | string | Tak | — |
messages | TicketMessage[] | Tak | The customer-visible thread in chronological order. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 422 · 429