support
POST /v1/tickets
Open a support ticket.
ავტორიზაცია
API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს tickets.reply ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.
სwhere your organisation id goes-ის ადგილი
ესენდპოინტი იღებს org_id-ს JSON ტანის ველად.
თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/tickets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "subject": <string>, "body": <string> }'შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი API კონსოლში
დეტალები
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.
მოთხოვნის სხეული
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
subject | string | დიახ | — |
body | string | დიახ | The customer's description — becomes the first message in the thread. |
priority | TicketPriority | არა | How urgent the ticket is. The customer may propose one; staff decide. |
site_id | string | არა | The site this is about. Must belong to the same org or the request is a 404. |
invoice_id | string | არა | The invoice this is about. Must belong to the same org or the request is a 404. |
org_id | string | არა | 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 | არა | 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… |
პასუხი
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
id | Uuid | დიახ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | დიახ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subject | string | დიახ | — |
status | TicketStatus | დიახ | 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 | დიახ | How urgent the ticket is. The customer may propose one; staff decide. |
channel | string | დიახ | 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 | არა | — |
invoice_id | object | არა | — |
on_behalf_of_org_id | object | არა | 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 404d otherwise, so it can never… |
assignee_name | object | დიახ | 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… |
first_response_at | object | არა | — |
resolved_at | object | არა | — |
closed_at | object | არა | — |
last_message_at | object | არა | — |
reopened_count | integer | დიახ | — |
message_count | integer | დიახ | Customer-visible messages in the thread — internal notes are not counted. |
created_at | string | დიახ | — |
updated_at | string | დიახ | — |
messages | TicketMessage[] | დიახ | The customer-visible thread in chronological order. |
შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს
401 · 403 · 404 · 422 · 429