support
POST /v1/tickets
Open a support ticket.
Πισtoποίηση
Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Το κλειδί πρέπει να διαθέτει το δικαίωμα tickets.reply· ένα κλειδί που δεν το διαθέτει απορρίπτεται με 403, όχι 404.
Πού μπαίνει το αναγνωριστικό του οργανισμού σας
Αυτό το endpoint δέχεται το πεδίο org_id στο σώμα JSON.
Το αναγνωριστικό του οργανισμού σας βρίσκεται στην οθόνη των κλειδιών API στον πίνακα ελέγχου σας, δίπλα στο ίδιο το κλειδί. Είναι το ίδιο αναγνωριστικό σε κάθε κλήση που πραγματοποιείτε.
Δοκιμάστε το
Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.
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.
Σώμα αίτησης
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
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… |
Απάντηση
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
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 404d 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… |
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