support

POST /v1/tickets/{ticketId}/messages

Reply to a support ticket.

Minden support végpont

Az összes fejlesztői dokumentáció

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) tickets.reply jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

curl -X POST https://api.zinndigital.com/v1/tickets/{ticketId}/messages \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "body": <string> }'

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

Appends a customer message and returns the thread to open. Replying to a solved ticket reopens it. A closed ticket is rejected with a 422 whose error code is the stable TICKET_CLOSED, so a client can offer "reopen" without string-matching a translated message. Requires tickets.reply.

Paraméterek

NévTípusKötelezőMi ez
ticketId (path)UuidIgenThe ticket's id.

Kérés törzse

NévTípusKötelezőMi ez
bodystringIgen

Válasz

NévTípusKötelezőMi ez
idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
subjectstringIgen
statusTicketStatusIgenWhere 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 =…
priorityTicketPriorityIgenHow urgent the ticket is. The customer may propose one; staff decide.
channelstringIgenHow the ticket reached us — dashboard, api or staff. Server-decided; an open string so a future channel is additive on both sides.
site_idobjectNem
invoice_idobjectNem
on_behalf_of_org_idobjectNemThe 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_nameobjectIgenThe 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_atobjectNem
resolved_atobjectNem
closed_atobjectNem
last_message_atobjectNem
reopened_countintegerIgen
message_countintegerIgenCustomer-visible messages in the thread — internal notes are not counted.
created_atstringIgen
updated_atstringIgen
messagesTicketMessage[]IgenThe customer-visible thread in chronological order.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422 · 429