support
POST /v1/tickets
Open a support ticket.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение tickets.reply; ключ без него отклоняется с кодом 403, а не 404.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве поля в теле JSON.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
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, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в 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