Autentifikatsiya
API kalitini bearer token sifatida yuboring. Kalit tickets.reply ruxsatiga ega boʻlishi shart; ruxsatsiz kalit 404 emas, balki 403 xatosi bilan rad etiladi.
Tashkilotingiz identifikatori kiritiladigan joy
Ushbu so'rov JSON tanasida org_id ni maydon sifatida qabul qiladi.
Tashkilotingiz identifikatori boshqaruv panelingizdagi API kalitlari ekranida, kalitning o'z yonida joylashgan. Bu siz amalga oshiradigan har bir so'rovda bir xil identifikator hisoblanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
curl -X POST https://api.zinndigital.com/v1/tickets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "subject": <string>, "body": <string> }'Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
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`.
Soʻrov tanasi
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
subject | string | Ha | — |
body | string | Ha | The customer's description — becomes the first message in the thread. |
priority | TicketPriority | Yo'q | How urgent the ticket is. The customer may propose one; staff decide. |
site_id | string | Yo'q | The site this is about. Must belong to the same org or the request is a 404. |
invoice_id | string | Yo'q | The invoice this is about. Must belong to the same org or the request is a 404. |
org_id | string | Yo'q | 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 | Yo'q | 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… |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subject | string | Ha | — |
status | TicketStatus | Ha | 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 | Ha | How urgent the ticket is. The customer may propose one; staff decide. |
channel | string | Ha | 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 | Yo'q | — |
invoice_id | object | Yo'q | — |
on_behalf_of_org_id | object | Yo'q | 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 | Ha | 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 | Yo'q | — |
resolved_at | object | Yo'q | — |
closed_at | object | Yo'q | — |
last_message_at | object | Yo'q | — |
reopened_count | integer | Ha | — |
message_count | integer | Ha | Customer-visible messages in the thread — internal notes are not counted. |
created_at | string | Ha | — |
updated_at | string | Ha | — |
messages | TicketMessage[] | Ha | The customer-visible thread in chronological order. |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 404 · 422 · 429