प्रमाणीकरण
बेरर टोकन म्हणून API की पाठवा. की मध्ये tickets.reply परवानगी असणे आवश्यक आहे; ती नसलेली की 404 ऐवजी 403 सह नाकारली जाते.
जिथे तुमचा ऑर्गनायझेशन आयडी (organization id) जाईल
हा एंडपॉइंट JSON बॉडीमधील फील्ड म्हणून org_id घेतो.
तुमची संस्था आयडी (organisation id) तुमच्या डॅशबोर्डवरील API की स्क्रीनवर, की च्या बाजूला आहे. तुम्ही केलेल्या प्रत्येक कॉलमधील तोच आयडी असतो.
प्रयत्न करा
कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.
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 कन्सोल तुमची खरी संस्था आयडी आणि तुमची स्वतःची की आपोआप भरतो आणि लाइव्ह 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 `404`d 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 staff-… |
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