Genesys接口 - 02 拨号器 - Dialer

此API文档描述了由 外部应用程序 (百仕瑞CRM) 调用时ICWS中的 交互式拨号程序 和 拨号程序活动的高级工作流程。

拨号服务允许客户端登录后处理呼叫相关的业务。

---

一些名词的个人理解：
代理 - agent： 指x-lite或者IP话机
活动 - campaign ： 签入后的状态

此API允许代理一次打开多个Web浏览器选项卡。每个选项卡都有自己的会话ID，但使用相同的代理用户名和外部应用程序名称。API将这些会话组合在一起，并且它们与Dialer交互，就好像它们是一个会话一样。只要代理程序至少打开一个选项卡，Dialer就会继续与此会话进行交互。

完整的API：https://help.genesys.com/developer/cic/docs/icws/webhelp/icws/(sessionId)/dialer/Dialer.htm#application

---

1、签入签出

• /icws/{sessionId}/dialer/log-in POST
• /icws/{sessionId}/dialer/log-off POST

---

2、状态切换：准备接听

解释：一旦代理登录到一个或多个活动（campaign），代理就不会立即开始接收呼叫。Calling ready for calls表示代理已准备好接收呼叫。每当代理手动或自动登录到其他活动（campaign）时，必须再次调用准备好呼叫。

• /icws/{sessionId}/dialer/ready-for-calls POST

---

3、状态切换：中断接听

个人理解：这个状态下，电话无法呼入。

解释：当代理请求中断时调用此方法。立即发送BreakStatusMessage以指示已请求中断，并在授予中断时发送单独的BreakStatusMessage。拨号程序不会将代理的状态作为中断授权消息的一部分更改。客户端应用程序或代理必须更改状态。

• /icws/{sessionId}/dialer/disposition POST

---

4、状态切换：开始休息、结束休息（不做）

• /icws/{sessionId}/dialer/request-break POST
• /icws/{sessionId}/dialer/end-break POST

---

5、数据弹出消息

解释：代理收到包含 预览弹出(PreviewPop)的数据弹出消息(DataPopMessage)后，可以调用此方法来放置相应的调用。调用此方法后，预览弹出窗口将更新，以指示已向拨号程序发出呼叫请求。

• /icws/{sessionId}/dialer/place-preview-call POST

---

6、建立长连接

解释：此方法允许使用远程号码站类型（a remote number station type）的代理在连接到代理的呼叫之前，建立到出站拨号服务器的连接。

连接是持久的，这意味着它不会在出站调用之间断开连接。用此方法，消除了拨号程序将 呼叫连接到代理时 的任何延迟。

此方法应在代理登录到一个或多个活动（campaign）后调用，但在调用Ready for Calls接口（状态切换：准备接听）之前调用。

要使此呼叫工作，代理必须具有远程号码的站类型，且“持久连接”选项设置为“真”，并且至少登录到一个活动（campaign）。

请注意，如果不满足这些前提条件中的任何一个，则此方法无法报告拨号程序的错误。

• /icws/{sessionId}/dialer/establish-persistent-connection POST

---

7、请求表单定义

解释：检索基本脚本表单定义。（文档对此方法的说明不够详细）

• /icws/{sessionId}/dialer/request-form-definition POST

---

8、更新呼叫数据

解释：更新特定活动呼叫ID的呼叫数据属性（文档信息说明不详）
个人理解：是否指修改通话的状态？传入的参数可以是闭音、保持等。API中没有给出对应的状态枚举类型。

• /icws/{sessionId}/dialer/update-call-data POST

---

9、活动复位

解释：通过活动ID使活动复位 （文档说明不详）
个人理解：类似重新签入的功能？

• /icws/{sessionId}/dialer/reset-campaign POST

---

10、回收活动

解释：通过活动ID回收活动。（文档说明不详）

• /icws/{sessionId}/dialer/recycle-campaign POST

---

11、活动转移

解释：要传递给transitionCampaign调用的Campaign ID和GroupName。
个人理解：呼叫转移？

• /icws/{sessionId}/dialer/transition-campaign POST

---

12、手机出站呼叫

解释：用于查询与联系人列表相关的Dialer数据库表的一组参数。（不明确使用场景）

• /icws/{sessionId}/dialer/initiate-manual-outbound-call POST

---

13、请求号码详情

解释：检索拨号器联系人的电话号码详细信息以进行其他后续呼叫。（文档说明不详）

• /icws/{sessionId}/dialer/request-phone-number-details POST

---

14、设置代理类型

解释：为特定的活动(campaign)设置代理类型。（文档说明不详）

• /icws/{sessionId}/dialer/set-agent-type POST

---

15、标记要求完成

解释：标记调用重定向到整理代理。（文档说明不详）

• /icws/{sessionId}/dialer/mark-call-for-finishing POST

---

16、呼叫转移

解释：根据配置文件，将呼叫转接到话务员。（文档说明不详）

• /icws/{sessionId}/dialer/transfer-to-attendant-profile POST

---

17、请求呼叫的联系人数据

解释：请求呼叫的联系人数据。（具体使用场景）

• /icws/{sessionId}/dialer/request-contact-data POST

---

18、更新阶段

解释：将代理移动到呼叫的一个新阶段。（文档说明不详）
Moves the agent to a new stage in the call.

• /icws/{sessionId}/dialer/update-stage POST

---

19、将代理移入或移出活动（campaigns）

• /icws/{sessionId}/dialer/allocate-agents POST