版本 2.4.8 · 最新
工单设置 ticket-settings
自动关闭、提醒、重开期限与评价开关。
点击任一接口,右侧显示对应的调用示例。
工单鉴权: 仅管理员2 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
GET
/api/v2/ticket-settings读工单设置
鉴权: 仅管理员
PUT
/api/v2/ticket-settings改工单设置
鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
admin_bot_enabled | boolean | 同上事件是否发到启用且勾选了工单事件(events 含 ticket)的 webhook 机器人;不传不改,缺省开。 |
admin_email_enabled | boolean | 用户新建/回复/重开/差评时是否给平台联系邮箱发邮件;不传不改,缺省开。 |
auto_close_days必填 | integer | 自动关闭天数(从最后一次客服回复算),1~30,缺省 7。 |
auto_close_enabled必填 | boolean | 客服回复后用户长期不回复是否自动关闭。 |
bot_summary_enabled | boolean | 机器人消息是否带前 200 字内容摘要;关掉只发标题、状态与链接。不传不改,缺省开。 |
rating_enabled必填 | boolean | 是否允许用户评价。 |
remind_days必填 | integer | 提醒天数(从最后一次客服回复算),1~29,须小于自动关闭天数,缺省 1。 |
remind_enabled必填 | boolean | 自动关闭前是否提醒用户。 |
reopen_days必填 | integer | 关闭后可重开的天数,1~365,缺省 30。 |
reopen_enabled必填 | boolean | 关闭后是否允许用户重开。 |
工单设置对象
| 字段 | 类型 | 说明 |
|---|---|---|
admin_bot_enabled | boolean | 同上事件是否发到启用且勾选了工单事件(events 含 ticket)的 webhook 机器人;不传不改,缺省开。 |
admin_email_enabled | boolean | 用户新建/回复/重开/差评时是否给平台联系邮箱发邮件;不传不改,缺省开。 |
auto_close_days | integer | 自动关闭天数(从最后一次客服回复算),1~30,缺省 7。 |
auto_close_enabled | boolean | 客服回复后用户长期不回复是否自动关闭。 |
bot_summary_enabled | boolean | 机器人消息是否带前 200 字内容摘要;关掉只发标题、状态与链接。不传不改,缺省开。 |
rating_enabled | boolean | 是否允许用户评价。 |
remind_days | integer | 提醒天数(从最后一次客服回复算),1~29,须小于自动关闭天数,缺省 1。 |
remind_enabled | boolean | 自动关闭前是否提醒用户。 |
reopen_days | integer | 关闭后可重开的天数,1~365,缺省 30。 |
reopen_enabled | boolean | 关闭后是否允许用户重开。 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}