support
POST /v1/tickets
Open a support ticket.
Санҷиши ҳаққоният
Kaliti API-ро ҳамчун рамзи доранда (bearer token) фиристед. Калит бояд дорои иҷозати tickets.reply бошад; калиди бидуни он бо хатои 403 рад карда мешавад, на 404.
Ҷое, ки рақами мушаххаси ташкилоти шумо ҷойгир аст
Ин нуқтаи поёнӣ org_id -ро ҳамчун майдон дар бадани JSON мегирад.
Rakami муайянкунандаи ташкилоти шумо дар экрани калидҳои API дар панели идоракунии шумо, дар паҳлӯи худи калид ҷойгир аст. Ин як раками муайянкунанда дар ҳар یک дархосте, ки шумо иҷро мекунед, якхела аст.
Санҷидан
Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.
curl -X POST https://api.zinndigital.com/v1/tickets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "subject": <string>, "body": <string> }'Воarid шудаед? Консоли 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 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