SparkTG

更新坐席(v2) 文档

更新坐席(v2)

v2

更新坐席(v2)

登录、登出、休息和资料修改

API v2v21 个端点

概述

让坐席登录或登出、进入休息状态,或修改其电话号码、国家区号或显示名称。此接口取代 PATCH /api/v1/agents。请恰好使用 agent_number 或 agent_sip 之一来指定坐席,然后至少发送一个要修改的字段;未发送的字段不会被改动。请求体为 JSON,下方未列出的任何字段都会被以 400 拒绝。null 和空字符串会被拒绝;此接口不会清除任何内容。每次成功调用计费一次。

可用端点

PUT/api/v2/agents

关键参数

agent_number(String)

坐席当前的电话号码。请发送此字段或 agent_sip,不要同时发送。

agent_sip(String)

坐席的 SIP 分机号。请发送此字段或 agent_number,不要同时发送。

status(Integer)

0 让坐席登录(空闲)。2 让其登出(离线),若同时带有 break_id,则让其进入该休息状态。不接受其他值。

break_id(Integer)

让坐席进入哪种休息状态。必须是您的服务已启用的休息类型。发送 break_id 即隐含状态 2,且不能与状态 0 同时使用。状态为 2 且没有 break_id 时,使用默认休息 7(离线),即让坐席登出。

number(String)

新的电话号码:4 到 15 位数字,不含 +、空格或短横线。不得属于服务内的其他坐席。坐席通话期间不能修改。

country_code(String)

1 到 4 位数字,不含 +,且不以 0 开头,例如 91 或 971。

使用场景

让坐席登录

将 status 设为 0。坐席变为空闲,并开始接收其队列分配的来电。这也能让处于任何休息状态的坐席恢复上线。

0 个参数见“示例”

让坐席登出

将 status 设为 2 且不带 break_id。坐席变为离线(休息 7),不再接收来电。发送 status 2 并带 break_id 7 效果相同。

0 个参数见“示例”

让坐席进入休息

发送 break_id;status 2 为隐含值。坐席在重新登录前不会接收来电。此例中通过电话号码而不是 SIP 分机号来指定坐席。

0 个参数见“示例”

从一种休息切换到另一种

坐席不能直接从一种休息切换到另一种;该调用会返回 409。请先让其登录(status 0),再发送新的 break_id。这两次调用都可以安全重试。

0 个参数见“示例”

更新资料

同时修改姓名、电话号码和国家区号。资料字段可以与 status 或 break_id 在同一次调用中发送,但坐席通话期间不能修改号码。

0 个参数见“示例”

快速示例

使用简单的 cURL 命令试用此 API

基础 API 调用
curl -X PUT 'https://telephonycloud.co.in/api/v2/agents' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"agent_sip": "10114", "status": 0}'
💡 将 <YOUR_TOKEN> 替换为您的 API 令牌

响应预览

此 API 的示例响应

示例响应
{"status":"success","changed":["status","break_id"],"agent":{"id":735,"name":"Priya Sharma","number":"9876500000","country_code":"91","sip":"10114","status":2,"break_id":3}}
在“响应”部分查看完整的响应格式