Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation tickets.reply ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Où insérer l'ID de votre organisation
Cet endpoint prend org_id comme champ dans le corps JSON.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X POST https://api.zinndigital.com/v1/tickets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "subject": <string>, "body": <string> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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`.
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
subject | string | Oui | — |
body | string | Oui | The customer's description — becomes the first message in the thread. |
priority | TicketPriority | Non | How urgent the ticket is. The customer may propose one; staff decide. |
site_id | string | Non | The site this is about. Must belong to the same org or the request is a 404. |
invoice_id | string | Non | The invoice this is about. Must belong to the same org or the request is a 404. |
org_id | string | Non | 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 | Non | 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… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subject | string | Oui | — |
status | TicketStatus | Oui | 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 | Oui | How urgent the ticket is. The customer may propose one; staff decide. |
channel | string | Oui | 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 | Non | — |
invoice_id | object | Non | — |
on_behalf_of_org_id | object | Non | 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 | Oui | 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 | Non | — |
resolved_at | object | Non | — |
closed_at | object | Non | — |
last_message_at | object | Non | — |
reopened_count | integer | Oui | — |
message_count | integer | Oui | Customer-visible messages in the thread — internal notes are not counted. |
created_at | string | Oui | — |
updated_at | string | Oui | — |
messages | TicketMessage[] | Oui | The customer-visible thread in chronological order. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429