Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте tickets.reply рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте JSON корпусында өріс ретінде org_id қабылдайды.
Сіздің ұйым идентификаторыңыз басқару панеліндегі 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 арқылы орындайды. Бұл соңғы нүктені 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`.
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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… |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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 `404`d 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 staff-… |
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