support
POST /v1/tickets
Open a support ticket.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422 · 429