Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso tickets.reply; una clave que no lo tenga se rechazará con un código 403, no 404.
Donde va el ID de tu organización
Este endpoint toma org_id como un campo en el cuerpo JSON.
El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X POST https://api.zinndigital.com/v1/tickets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "subject": <string>, "body": <string> }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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`.
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
subject | string | Sí | — |
body | string | Sí | The customer's description — becomes the first message in the thread. |
priority | TicketPriority | No | How urgent the ticket is. The customer may propose one; staff decide. |
site_id | string | No | The site this is about. Must belong to the same org or the request is a 404. |
invoice_id | string | No | The invoice this is about. Must belong to the same org or the request is a 404. |
org_id | string | No | 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 | No | 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… |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subject | string | Sí | — |
status | TicketStatus | Sí | 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 | Sí | How urgent the ticket is. The customer may propose one; staff decide. |
channel | string | Sí | 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 | No | — |
invoice_id | object | No | — |
on_behalf_of_org_id | object | No | 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 | Sí | 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 | No | — |
resolved_at | object | No | — |
closed_at | object | No | — |
last_message_at | object | No | — |
reopened_count | integer | Sí | — |
message_count | integer | Sí | Customer-visible messages in the thread — internal notes are not counted. |
created_at | string | Sí | — |
updated_at | string | Sí | — |
messages | TicketMessage[] | Sí | The customer-visible thread in chronological order. |
Errores que este endpoint puede devolver
401 · 403 · 404 · 422 · 429