Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền tickets.reply; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.
Nơi điền id tổ chức của bạn
Endpoint này nhận org_id làm một trường trong phần thân JSON.
Mã tổ chức của bạn nằm ở màn hình khóa API trong bảng điều khiển, ngay bên cạnh khóa đó. Đây là cùng một mã trong mọi lệnh gọi mà bạn thực hiện.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X POST https://api.zinndigital.com/v1/tickets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "subject": <string>, "body": <string> }'Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
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`.
Nội dung yêu cầu
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
subject | string | Có | — |
body | string | Có | The customer's description — becomes the first message in the thread. |
priority | TicketPriority | Không | How urgent the ticket is. The customer may propose one; staff decide. |
site_id | string | Không | The site this is about. Must belong to the same org or the request is a 404. |
invoice_id | string | Không | The invoice this is about. Must belong to the same org or the request is a 404. |
org_id | string | Không | 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 | Không | 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… |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
id | Uuid | Có | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Có | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subject | string | Có | — |
status | TicketStatus | Có | 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 | Có | How urgent the ticket is. The customer may propose one; staff decide. |
channel | string | Có | 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 | Không | — |
invoice_id | object | Không | — |
on_behalf_of_org_id | object | Không | 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 | Có | 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 | Không | — |
resolved_at | object | Không | — |
closed_at | object | Không | — |
last_message_at | object | Không | — |
reopened_count | integer | Có | — |
message_count | integer | Có | Customer-visible messages in the thread — internal notes are not counted. |
created_at | string | Có | — |
updated_at | string | Có | — |
messages | TicketMessage[] | Có | The customer-visible thread in chronological order. |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 422 · 429