0 接口概述
接口地址(Base URL)
/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/agentCall
请求头字段
Accept: application/jsonContent-Type: application/json;charset=utf-8Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
鉴权说明
基于主账号Basic Authorization鉴权
1 基本呼叫控制
1.1 坐席外呼
/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/agentCall/makeCall
请求参数
参数 | 约束 | 说明 |
---|---|---|
agentNo | 必选 | 坐席工号 |
userNumber | 必选 | 用户号码 |
userCli | 可选 | 用户侧显号标识 |
agentCli | 可选 | 座席侧显号标识 |
userData | 可选 | 自定义数据,支持英文字母和数字,长度不超过256 |
ringback | 可选 | 是否透传被叫侧回铃音:"true" 透传(默认) "false" 不透传 |
请求消息示例
{"userNumber":"13600000001","agentNo":"1111"}
响应
参数 | 说明 |
---|---|
statusCode | "00000"成功 |
statusMsg | 状态描述 |
conversationSid | 会话id |
响应示例
{"statusCode":"00000","statusMsg":"success","conversationSid":"CV111111111111"}
1.2 桥接呼叫
/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/agentCall/bridge
请求参数
参数 | 说明 |
---|---|
agentNo | 坐席工号,该坐席话机已应答呼叫,未桥接 |
1.3 结束呼叫
/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/agentCall/releaseCall
请求参数
参数 | 说明 |
---|---|
agentNo | 坐席工号,该坐席在通话中。 |
响应
参数 | 说明 |
---|---|
statusCode | "00000"成功 |
statusMsg | 状态描述 |
2 呼叫保持/恢复
2.1 保持呼叫
/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/agentCall/holdCall
请求参数
参数 | 说明 |
---|---|
agentNo | 坐席工号,该坐席必须在通话中 |
2.2 恢复呼叫
/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/agentCall/retrieveCall
请求参数
参数 | 说明 |
---|---|
agentNo | 坐席工号,该坐席在通话中,且通话被保持 |