support

POST /v1/tickets

Open a support ticket.

Semua titik akhir support

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin tickets.reply; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Tempat ID organisasi Anda dimasukkan

Titik akhir ini memerlukan org_id sebagai field dalam bodi JSON.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

curl -X POST https://api.zinndigital.com/v1/tickets \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "subject": <string>, "body": <string> }'

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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`.

Isi permintaan

NamaJenisWajibTentang apa ini
subjectstringYa
bodystringYaThe customer's description — becomes the first message in the thread.
priorityTicketPriorityTidakHow urgent the ticket is. The customer may propose one; staff decide.
site_idstringTidakThe site this is about. Must belong to the same org or the request is a 404.
invoice_idstringTidakThe invoice this is about. Must belong to the same org or the request is a 404.
org_idstringTidakThe organization to open it in. Required only when the caller holds `tickets.reply` in more than one org.
on_behalf_of_org_idstringTidakThe 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…

Tanggapan

NamaJenisWajibTentang apa ini
idUuidYaUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidYaUUIDv7 identifier — sortable by creation time (docs/02 §8).
subjectstringYa
statusTicketStatusYaWhere 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`…
priorityTicketPriorityYaHow urgent the ticket is. The customer may propose one; staff decide.
channelstringYaHow the ticket reached us — `dashboard`, `api` or `staff`. Server-decided; an open string so a future channel is additive on both sides.
site_idobjectTidak
invoice_idobjectTidak
on_behalf_of_org_idobjectTidakThe **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_nameobjectYaThe 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_atobjectTidak
resolved_atobjectTidak
closed_atobjectTidak
last_message_atobjectTidak
reopened_countintegerYa
message_countintegerYaCustomer-visible messages in the thread — internal notes are not counted.
created_atstringYa
updated_atstringYa
messagesTicketMessage[]YaThe customer-visible thread in chronological order.

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422 · 429