Doğrulama
API açarını bearer token kimi göndərin. Açar tickets.reply icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.
Təşkilatınızın identifikatorunun yerləşdiyi yer
Bu son nöqtə JSON gövdəsində sahə kimi org_id qəbul edir.
Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X POST https://api.zinndigital.com/v1/tickets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "subject": <string>, "body": <string> }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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`.
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
subject | string | Bəli | — |
body | string | Bəli | The customer's description — becomes the first message in the thread. |
priority | TicketPriority | Xeyr | How urgent the ticket is. The customer may propose one; staff decide. |
site_id | string | Xeyr | The site this is about. Must belong to the same org or the request is a 404. |
invoice_id | string | Xeyr | The invoice this is about. Must belong to the same org or the request is a 404. |
org_id | string | Xeyr | 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 | Xeyr | 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… |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
id | Uuid | Bəli | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Bəli | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subject | string | Bəli | — |
status | TicketStatus | Bəli | 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 | Bəli | How urgent the ticket is. The customer may propose one; staff decide. |
channel | string | Bəli | 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 | Xeyr | — |
invoice_id | object | Xeyr | — |
on_behalf_of_org_id | object | Xeyr | 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 | Bəli | 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 | Xeyr | — |
resolved_at | object | Xeyr | — |
closed_at | object | Xeyr | — |
last_message_at | object | Xeyr | — |
reopened_count | integer | Bəli | — |
message_count | integer | Bəli | Customer-visible messages in the thread — internal notes are not counted. |
created_at | string | Bəli | — |
updated_at | string | Bəli | — |
messages | TicketMessage[] | Bəli | The customer-visible thread in chronological order. |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 422 · 429