获取有效休息状态 (v2) 文档
获取有效休息状态 (v2)
v2
获取有效休息状态 (v2)
v2
获取有效休息状态 (v2)
坐席可用的休息状态,可选针对单个坐席
API v2v21 个端点
概述
列出您的服务中坐席可以使用的休息状态,例如用于在 CRM 或 CTI 中填充坐席的状态下拉列表。“有效”指坐席当前可以使用的休息状态:管理员未关闭的默认休息状态,加上管理员已开启的自定义休息状态。整个服务都已关闭的休息状态不会出现在列表中。列表始终针对令牌所属的服务。传入 agent-id 还可以查看管理员为该坐席隐藏了哪些休息状态。不计费。
可用端点
GET
/api/v2/effective-breaks关键参数
agent-id(Integer)坐席 ID(即 GET /api/v2/agents 返回的 id)。传入后,管理员为该坐席隐藏的休息状态会带有 "disabled": true 返回。不传或传空值,则返回不含坐席专属标记的服务列表。坐席必须处于启用状态且属于令牌所属的服务。
使用场景
整个服务的休息状态
无参数。在没有特定坐席时使用,例如在报表中显示休息状态名称。响应已缩短;一个典型服务大约有十几个休息状态。
0 个参数见“示例”
单个坐席的休息状态
传入 agent-id。此处管理员为坐席 319 隐藏了 Leave,因此它带有 "disabled": true 返回。该休息状态仍保留在列表中,以便您显示其名称和颜色;只是不要让坐席选择它。
0 个参数见“示例”
快速示例
使用简单的 cURL 命令试用此 API
基础 API 调用
curl 'https://telephonycloud.co.in/api/v2/effective-breaks' \
-H 'Authorization: Bearer <YOUR_TOKEN>'💡 将 <YOUR_TOKEN> 替换为您的 API 令牌
响应预览
此 API 的示例响应
示例响应
[{"break_id":0,"label":"Available","icon":"available","color":"#5ccc56","is_system":true,"sort_order":1,"is_deleted":false,"category":"SYSTEM"},{"break_id":1,"label":"Meal","icon":"lunch","color":"#F4...在“响应”部分查看完整的响应格式
