support

POST /v1/tickets/{ticketId}/messages

Reply to a support ticket.

所有 support 端点

所有开发者文档

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 tickets.reply 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

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

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

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.

参数

名称类型必填内容简介
ticketId (path)UuidThe ticket's id.

请求正文

名称类型必填内容简介
bodystring

响应

名称类型必填内容简介
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
subjectstring
statusTicketStatusWhere 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 =…
priorityTicketPriorityHow urgent the ticket is. The customer may propose one; staff decide.
channelstringHow the ticket reached us — dashboard, api or staff. Server-decided; an open string so a future channel is additive on both sides.
site_idobject
invoice_idobject
on_behalf_of_org_idobjectThe 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_nameobjectThe 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_atobject
resolved_atobject
closed_atobject
last_message_atobject
reopened_countinteger
message_countintegerCustomer-visible messages in the thread — internal notes are not counted.
created_atstring
updated_atstring
messagesTicketMessage[]The customer-visible thread in chronological order.

此端点可能返回的错误

401 · 403 · 404 · 422 · 429