Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar tickets.reply iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Kurum kimliğinizin yazılacağı yer
Bu uç nokta, JSON gövdesinde bir alan olarak org_id alır.
Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X POST https://api.zinndigital.com/v1/tickets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "subject": <string>, "body": <string> }'Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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`.
İstek gövdesi
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
subject | string | Evet | — |
body | string | Evet | The customer's description — becomes the first message in the thread. |
priority | TicketPriority | Hayır | How urgent the ticket is. The customer may propose one; staff decide. |
site_id | string | Hayır | The site this is about. Must belong to the same org or the request is a 404. |
invoice_id | string | Hayır | The invoice this is about. Must belong to the same org or the request is a 404. |
org_id | string | Hayır | 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 | Hayır | 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… |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subject | string | Evet | — |
status | TicketStatus | Evet | 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 | Evet | How urgent the ticket is. The customer may propose one; staff decide. |
channel | string | Evet | 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 | Hayır | — |
invoice_id | object | Hayır | — |
on_behalf_of_org_id | object | Hayır | 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 | Evet | 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 | Hayır | — |
resolved_at | object | Hayır | — |
closed_at | object | Hayır | — |
last_message_at | object | Hayır | — |
reopened_count | integer | Evet | — |
message_count | integer | Evet | Customer-visible messages in the thread — internal notes are not counted. |
created_at | string | Evet | — |
updated_at | string | Evet | — |
messages | TicketMessage[] | Evet | The customer-visible thread in chronological order. |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404 · 422 · 429