请求与响应示例

GEThttps://jamdesk-docs.jamdesk.app/api/playground/demo/tickets/{ticket_id}

使用 RequestExample 和 ResponseExample 在端点文档旁展示真实的 API 用法。这些组件可以展示多种语言、响应状态以及内联说明。

示例：获取支持工单

本示例为 Acme Support API 记录 GET /tickets/{ticket_id} 端点。

请求

使用参数字段描述端点的输入要求。代码示例位于右侧边栏中。

ticket_idstringrequired

工单创建时返回的唯一工单标识符。

curl -X GET https://api.acme.com/v1/tickets/tkt_9S8L2 \
  -H "Authorization: Bearer $ACME_TOKEN"

响应

使用响应字段记录 API 返回的最重要属性。

idstringrequired

唯一工单标识符。

statusstring

当前工单状态（open、pending 或 resolved）。

created_atstring

工单创建时间的 ISO 8601 时间戳。

{
  "id": "tkt_9S8L2",
  "customer_id": "cus_2X9W8",
  "subject": "Export stuck on step 3",
  "priority": "high",
  "status": "open",
  "created_at": "2026-02-04T16:12:00Z"
}

提示

至少包含一个成功响应和一个错误响应。
使用真实的标识符和时间戳，使示例更贴近实际。
保持负载精简，便于读者快速浏览。

示例：获取支持工单

请求

响应

提示

相关页面