Rest 坐席管理

座席管理是云通讯平台提供的关于IVR座席的一系列REST API,包括创建队列删除队列修改队列座席上班座席下班座席准备就绪座席结束通话呼叫转接座席班长监听查询座席状态查询队列信息座席外呼座席咨询座席转移呼叫座席咨询返回三方通话用户静音取消用户静音座席内呼座席强插座席强拆座席未应答前转获取用户输入数据等23个接口。通过这些REST API能够实现功能全面的座席管理。

1创建队列

  • 创建用户排队的队列,客户可以创建多个不同属性技能的队列,具体属性技能类型由应用侧管理。

1.1 请求地址

  • /{SoftVersion}/Accounts/{accountSid}/ivr/createqueue

1.2 请求包头

1.3 请求包体

节点属性类型约束说明
Appid
-----String必选应用Id节点
CreateQueue
-----String必选创建队列主节点
queuetypeString必选队列类型,定义为正整数(支持最大9位),具体属性类型的含义由应用侧维护,例如:1英语技能组,2足球技能组,3法语技能组。队列类型与座席类型相一致。默认为0队列。
typedesString必选队列类型描述
worktimeString可选队列工作时间,格式:hh:mi-hh:mi。非工作时间不接听电话,为用户播放提示音后挂机,若需设置多个时间段,用分号隔开。
offworkpromptString可选非工作时间队列提示,填写语音库中上传的语音文件名
offworkdateString可选非工作日期,默认值为空,格式为 yyyy-mm-dd:yyyy-mm-dd,开始及结束日期以英文冒号隔开。相同时表示为一天。
offworkweekdayString
可选
每周的非工作时间,默认值为空。若是多天以#分隔,输入值为每日英文缩写,如:Mon、Tue、Wed、Thu、Fri、Sat、Sun
offworktalk
String
可选
非工作时间是否允许继续外呼坐席通话,0、否 1、是 默认0

1.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/createqueue?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <CreateQueue queuetype="1" typedes="test" worktime="09:00-18:00" offworkprompt="offworktime.wav" offworkdate="2014-10-01:2014-10-07" offworkweekday="Sun#Sat"/>
</Request>

1.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

1.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

2 删除队列

  • 应用侧删除队列。

2.1 请求地址

  • /{SoftVersion}/Accounts/{accountSid}/ivr/delqueue

2.2 请求包头

2.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
DelQueue
-----String必选删除队列主节点
queuetypeString必选队列类型,定义为正整数

2.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/delqueue?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <DelQueue queuetype="1"/>
</Request>

2.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

2.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

3 修改队列

  • 修改用户排队的队列,queyetype为查询条件不能修改。

3.1 请求地址

  • /{SoftVersion}/Accounts/{accountSid}/ivr/modifyqueue

3.2 请求包头

3.3 请求包体

节点属性类型约束说明
Appid
-----String必选应用Id节点
ModifyQueue
-----String必选修改队列主节点
queuetypeString必选队列类型,定义为正整数,具体属性类型的含义由应用侧维护,例如:1英语技能组,2足球技能组,3法语技能组。队列类型与座席类型相一致。默认为0队列
typedesString可选队列类型描述
worktimeString可选队列工作时间,格式:hh:mi-hh:mi。非工作时间不接听电话,为用户播放提示音后挂机,若需设置多个时间段,用分号隔开。
offworkpromptString可选非工作时间队列提示,填写语音库中上传的语音文件名
offworkdateString可选非工作日期,默认值为空,格式为 yyyy-mm-dd:yyyy-mm-dd,开始及结束日期以英文冒号隔开。相同时表示为一天。
offworkweekday
String
可选
每周的非工作时间,默认值为空。若是多天以#分隔,输入值为每日英文缩写,如:Mon、Tue、Wed、Thu、Fri、Sat、Sun
offworktalk
String
可选
非工作时间是否允许继续外呼坐席通话(取值0或1)

3.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/modifyqueue?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <ModifyQueue  queuetype="1" typedes="1" worktime="09:00-18:00" offworkprompt="上班时间.wav" offworkdate="2014-10-01:2014-10-07" offworkweekday="Sun#Sat"/>
</Request>

3.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

3.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

4 座席上班

  • 座席在指定队列上班,上班后状态变为准备就绪才可接听电话。支持应用侧重复调用此命令来修改上班的号码。

4.1 请求地址

  • /{SoftVersion}/Accounts/{accountSid}/ivr/agentonwork

4.2 请求包头

4.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
AgentOnWork
-----String必选座席上班主节点
numberString必选座席号码,手机号或座机号或通讯账号
agentidString必选座席Id,大于0的正整数,建议4位。注意:必须是大于0的正整数,否则上班准备就绪成功后会转接不到该坐席。
agenttypeString可选座席类型,定义为正整数,与队列类型一致,默认值为0,可以填多个值,使用英文逗号分隔。
agentstateString可选座席状态:0坐席准备中不能接电话,可以坐席外呼;1坐席准备就绪可以接听来电,也可以坐席外呼; 2坐席锁定中,锁定中是云通讯平台在转接到坐席的时候先对坐席进行锁定操作,以避免其他用户呼入后分配到同一个坐席,不能接听其他来电和坐席外呼;3坐席通话中不能接听其他来电和坐席外呼;4座席线路忙,如果用云通讯的通讯账号为坐席可能是通讯账号不在线或者占线中,如果用落地电话则是在占线中(占线中不是通过云通讯平台的坐席进行呼叫)。默认值为0。

4.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/agentonwork?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentOnWork  number="13800138000" agentid="1000"/>
</Request>

4.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

4.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

5 座席下班

  • 座席从所有队列中下班,座席退出队列,不会再接入用户。

5.1 请求地址

  • /{SoftVersion}/Accounts/{accountSid}/ivr/agentoffwork

5.2 请求包头

5.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
AgentOffWork
-----String必选座席下班主节点
numberString必选座席号码,手机号或座机号或通讯账号
agentid
String
必选
座席Id,4位正整数
agenttype
String
必选
座席服务队列类型,指定下班队列;默认空,下班所有队列。  

5.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/agentoffwork?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentOffWork agentid="1000" />
</Request>

5.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

5.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

6 座席准备就绪

  • 将座席状态变为准备就绪或准备中。只有准备就绪座席才可以接听电话。

6.1 请求地址

  • /{SoftVersion}/Accounts/{accountSid}/ivr/agentready

6.2 请求包头

6.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
AgentReady
-----String必选座席准备就绪主节点
agentidString必选座席Id,4位正整数
actionString可选就绪失败的回调url,默认值为空
stateString可选true表示状态更新为准备就绪,false表示状态更新为准备中,默认值为true
priorityString可选是否优先接听客户电话。false:顺序接听,true:优先接听。默认值为false
forceString可选是否强制设置状态。默认值为false;设置为true时,不会发送状态改变通知。此参数主要用于非正常流程使用,普通操作不建议使用。

6.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/agentready?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentReady agentid="1000" state="true" priority="true" force="true"/>
</Request>

6.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

6.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

7 座席结束通话

  • 征得用户同意后座席可主动结速通话,但用户通话未挂断,应用侧可继续为用户执行后续业务逻辑。若action内容为空则使用进入排队系统命令中agenthangupurl参数作为回调地址,若都为空则挂断用户电话。

  • 注意:只有当座席和用户在通话中发起请求才有效。

7.1 请求地址


  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

7.2 请求包头

7.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
AgentServiceEnd
-----String必选座席结束通话主节点
callidString必选平台侧为每个用户呼叫分配唯一Id
agentidString必选座席Id,4位正整数
actionString可选结束成功的回调url,默认值为空

7.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304281638380000100 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentServiceEnd callid ="13421304281638380000100"  agentid="1000"/>
</Request>

7.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

7.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

8 座席呼叫转接

  • 通话中座席将用户的呼叫转接到另外一个座席或第三方号码接听。只要agentid或number或queuetype参数有效就会向action发送转接结果的通知。如果转接失败需要应用侧通过此通知对用户的控制权转交进行后续业务处理,否则就会挂机。

8.1 请求地址

  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

8.2 请求包头

8.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
Transfer
-----String必选座席呼叫转接主节点
callidString必选平台侧为每个用户呼叫分配唯一Id
agentidString可选座席Id,4位正整数。agentid和number二者必须有一个不为空,当agentid不为空时number无效。
numberString可选被转接的电话号码,可以是通讯账号、座机号、手机号。当agentid为空时才有效,当号码无效时则会执行副命令中的呼转命令。
queuetypeString必选转接队列的类型,定义为正整数,默认值为0
actionString可选转接结果通知的回调url
timeoutString可选转座席是指接听超时时长;转入队列则是指排队超时时长,单位是秒,默认值为120秒
enterurlString可选用户进入排队成功通知的回调url地址,默认值为空
quiturlString可选退出队列通知的回调url地址,默认值为空
queuetimesString可选排队次数,从1开始,默认是3
promptvoiceString可选超时提示音,用户按#号键则退出排队
finishkeyString可选排队超时播放提示音时退出排队的按键内容,默认是#号键,超时未按键表示继续排队
recordurlString可选录音完成通知的回调url地址。座席通话默认会录音,默认值空
agenthangupurlString可选通话过程中座席侧挂断电话通知的回调url地址,默认值为空,为空时自动挂断用户电话
talkmodString可选通话模式,false表示点对点,true表示会议模式。若是点对点模式,则不支持班长监听功能,默认值为true
playanswerpromptString可选是否为用户播放接通后的提示音。默认值为true
answerpromptString可选应答后播放的自定义提示音,默认为空,为空则为用户播放平台自定义文件:****工号为您服务。
worktimeString可选队列工作时间,格式:hh:mi-hh:mi。非工作时间不接听电话,为用户播放提示音后挂机
offworkdateString可选非工作日期,默认值为空,格式为 yyyy-mm-dd:yyyy-mm-dd,开始及结束日期以英文冒号隔开。相同时表示为一天。
offworkweekdayString可选每周的非工作时间,默认值为空。若是多天以#分隔,输入值为每日英文缩写,如:Mon、Tue、Wed、Thu、Fri、Sat、Sun
offworkqueueString可选非工作时间的转移的工作队列
overflowurlString可选队列溢出通知回调url,默认值为空
userhangupurlString可选用户挂机通知回调url,默认值为空

  • 注意:转接的优先顺序是先判断agentid、再判断number、最后判断queuetype,三个参数必须有一个存在。

8.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304281638380000100 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request> 
  <Appid>12591111</Appid>        
  <Transfer callid ="13421304281638380000100"  agentid="1000"/>
</Request>

8.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

8.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

9 座席班长监听

  • 班长监听某个座席人员与用户的通话。

9.1 请求地址


  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

9.2 请求包头

9.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
Monitor
-----String必选座席班长监听主节点
callidString必选平台侧为每个用户呼叫分配唯一Id
agentidString必选座席Id,4位正整数
numberString必选班长号码,手机号或座机号或通讯账号
actionString可选监听结果通知的回调url
notifyurlString可选班长监听结束通知的回调url

9.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304281638380000100 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <Monitor callid ="13421304281638380000100"  agentid="1000" number="13800138000"/>
</Request>

9.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

9.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

10 查询座席状态

  • 查询所有座席的工作状态

10.1 请求地址

  • /{SoftVersion}/Accounts/{accountSid}/ivr/queryagentstate

10.2 请求包头

10.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
QueryAgentState
-----String必选查询座席状态主节点
agentidString可选座席Id,无此属性返回全部座席。

10.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/queryagentstate?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <QueryAgentState agentid='8001'/>
</Request>

10.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码
agentsString必选座席列表主节点
agentString必选座席二级节点
idString必选座席Id,4位正整数
stateString必选座席状态:0准备中 ,1:准备就绪,2:用户锁定,3:咨询通话中
numberString必选座席号码,手机号或座机号或通讯账号

10.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
  <agents>
    <agent>
     <id>1000</id>
     <state>1</state>
     <number>123456789</number>
    </agent>
     ...
  </agents>
</Response>

11 查询队列信息

  • 查询队列信息及队列相关设置。

11.1 请求地址

  • /{SoftVersion}/Accounts/{accountSid}/ivr/queryqueueinfo

11.2 请求包头

11.3 请求包体

属性类型约束说明
AppidString必选应用Id节点
QueryQueueInfoString必选查询座席队列主节点

11.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/queryqueueinfo?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1 
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>         
  <QueryQueueInfo/>
</Request>

11.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码
queuesString必选队列列表主节点
queueString必选队列二级节点
typeString必选队列类型
typedesString可选队列类型描述
worktimeString可选队列工作时间,格式:hh:mi-hh:mi。非工作时间不接听电话,为用户播放提示音后挂机
offworkpromptString可选非工作时间队列提示,填写语音库中上传的语音文件名
offworkdateString可选非工作日期,默认值为空,格式为 yyyy-mm-dd:yyyy-mm-dd,开始及结束日期以英文冒号隔开。相同时表示为一天。
offworkweekdayString可选每周的非工作时间,默认值为空。若是多天以#分隔,输入值为每日英文缩写,如:Mon、Tue、Wed、Thu、Fri、Sat、Sun

11.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
  <queues>
    <queue>
     <type>1</type>
     <typedes>描述</typedes>
     <count>12</count>
    </queue>
     ...
  </queues>
</Response>

12 座席外呼

  • 座席人员主动发起外呼。座席状态只有在准备中、准备就绪、状态下才能进行外呼。

12.1 请求地址

  • /{SoftVersion}/Accounts/{accountSid}/ivr/agentmakecall

12.2 请求包头

12.3 请求包体

节点属性类型约束说明
Appid
-----String必选应用Id
AgentMakeCall
-----
String
必选座席外呼主节点
number
String
必选
外呼号码,手机号或座机号或通讯账号。
agentid
String
必选
座席Id,4位正整数
action
String
可选
外呼操作结果通知的回调地址,默认值为空    
disnumber
String
可选
用户方的显号号码,根据平台侧显号规则控制。
answerurl
String
可选
用户应答通知的回调url,默认值为空
agenthangupurl
String
可选
通话过程中座席与用户通话结束通知的回调url,默认值为空的回调url默认值为空。为空时自动挂断用户电话。

12.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/agentmakecall?sig=155EAA68C5DFB6B762A42D88F406ABCD&queuetype=1 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentMakeCall agentid="8001" number="13800138000"/>
</Request>

12.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码
callSidstring必选一个由32个字符组成的唯一电话标识符

12.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
  <callSid>12345678909876543211234</callsid>  
</Response>

13 座席咨询

  • 座席与用户通话过程中可以发送此请求咨询其他座席或电话。
  • 注:此接口不可以与用户静音接口一起使用,坐席咨询默认会将用户端静音,如果调用用户静音会导致无法转接。

13.1 请求地址


  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

13.2 请求包头

13.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
AgentConsult
-----String必选座席咨询主节点
callidString必选平台侧为每个用户呼叫分配唯一Id
agentidString必选座席Id,4位正整数,为空则呼叫number参数号码
numberString必选电话号码或通讯账号
actionString可选咨询操作结果通知的回调url,默认值为空

13.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304281638380000100 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentConsult callid ="13421304281638380000100"  agentid="1000" number="13812345678"/>
</Request>

13.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

13.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

14 座席转移呼叫

  • 座席咨询后使用,将用户通话转移给被咨询者。

14.1 请求地址


  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

14.2 请求包头

14.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
AgentShift
-----String必选座席转移呼叫主节点
callidString必选平台侧为每个用户呼叫分配唯一Id
actionString可选呼叫转移操作结果通知的回调url,默认值为空

14.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304281638380000100 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentShift callid ="13421304281638380000100"  action="shift"/>
</Request>

14.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

14.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

15 座席咨询返回

  • 座席咨询后使用,座席结束咨询,继续与用户进行通话。

15.1 请求地址


  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

15.2 请求包头

15.3 请求包体

节点属性 类型 约束 说明
Appid-----String必选应用Id节点
AgentConsultBack
-----String必选座席咨询返回主节点
callidString必选平台侧为每个用户呼叫分配唯一Id
actionString可选座席咨询返回结果通知的回调url,默认值为空

15.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304281638380000100 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentConsultBack callid="13421304281638380000100"  action="back"/>
</Request>

15.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

15.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

16 三方通话

16.1 请求地址


  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

16.2 请求包头

16.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
TripartiteTalk
-----String必选三方通话主节点
callidString必选平台侧为每个用户呼叫分配唯一Id
actionString可选三方通话操作结果通知的回调url,默认值为空

16.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304281638380000100 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <TripartiteTalk callid ="13421304281638380000100"  action="trip"/>
</Request>

16.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

16.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

17 用户静音

  • 将用户静音,听不到座席人员的声音,并为用户播放等待音。

17.1 请求地址

  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

17.2 请求包头

17.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
AgentMuteUser
-----String必选用户静音主节点
callidString必选平台侧为每个用户呼叫分配唯一Id
promptvoiceString可选用户听到的等待音,默认值为agentmuteuser.wav
actionString可选操作结果通知的回调url,默认值为空

17.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304281638380000100 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentMuteUser callid ="13421304281638380000100"  action="mute"/>
</Request>

17.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

17.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

18 取消用户静音

  • 取消用户静音,座席与用户继续进行通话。

18.1 请求地址


  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

18.2 请求包头

18.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
AgentUnMuteUser
-----String必选取消用户静音主节点
callidString必选平台侧为每个用户呼叫分配唯一Id
actionString可选操作结果通知的回调url,默认值为空

18.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304281638380000100 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentUnMuteUser callid ="13421304281638380000100"  action="unmute"/>
</Request>

18.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

18.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

19 座席内呼

  • 用于座席呼叫座席。

19.1 请求地址

  • /{SoftVersion}/Accounts/{accountSid}/ivr/agent

19.2 请求包头

19.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
AgentCallAgent
-----String必选座席内呼主节点
callagentidString必选被叫座席Id
agentidString必选发起者座席Id
actionString
可选
操作结果通知的回调url,默认值为空
playanswerprompt
String
可选
true为用户播放接通后的提示音,false则不播放。播放默认提示音 agentid+.wav
answerprompt
String
可选
应答后播放的自定义提示音,默认为空,则为用户播放自定义的文件:****号客服代表为您服务,该文件需要通过云通讯官网上传进行审核通过后才可使用,文件名用坐席id命名,例如坐席id为8001,则文件名为8001.wav。

19.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/agent?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentCallAgent callagentid ="1001"  agentid="1000"/>
</Request>

19.5 响应包体

statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

19.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

20 座席强插

  • 座席班长监听后使用,用于班长介入座席与用户的通话,强插其他座席加入通话。强插后即为三方通话。

20.1 请求地址


  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

20.2 请求包头

20.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
AgentInsert
-----String必选座席强插主节点
callidString必选平台侧为每个用户呼叫分配唯一Id
agentidString必选被强插的座席Id,4位正整数
actionString可选操作结果通知的回调url,默认值为空

20.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304281638380000100 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentInsert callid ="13421304281638380000100"  agentid="1000"/>
</Request>

20.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

20.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

21 座席强拆

21.1 请求地址


  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

21.2 请求包头

21.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
AgentBreak
-----String必选座席强拆主节点
callidString必选平台侧为每个用户呼叫分配唯一Id
agentidString必选被强拆的座席Id,4位正整数
actionString可选操作结果通知的回调url,默认值为空

21.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304281638380000100 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <AgentBreak callid ="13421304281638380000100"  agentid="1000"/>
</Request>

21.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

21.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

22 座席未应答前转

  • 用户电话转给座席后,座席未接听时可通过此命令将电话转出,处理逻辑与座席呼叫转接完全相同。主要可用于座席长时间未接用户通话的处理。

22.1 请求地址


  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

22.2 请求包头

22.3 请求包体

节点属性类型约束说明
Appid-----String必选应用Id节点
NoAnswerTransfer
-----String必选座席未应答前转主节点
callidString必选平台侧为每个用户呼叫分配唯一Id
agentidString必选座席Id,4位正整数
numberString必选被转接的电话号码,可以是通讯账号、座机号、手机号。
queuetypeString必选转接队列的类型,定义为正整数,默认值为0
actionString可选转接结果通知的回调url
timeoutString可选转座席是指接听超时时长;转入队列则是指排队超时时长,单位是秒,默认值为120秒
enterurlString可选用户进入排队成功通知的回调url地址,默认值为空
quiturlString可选退出队列通知的回调url地址,默认值为空
queuetimesString可选排队次数,从1开始,默认是3
promptvoiceString可选超时提示音,用户按#号键则退出排队
finishkeyString可选排队超时播放提示音时退出排队的按键内容,默认是#号键,超时未按键表示继续排队
recordurlString可选录音完成通知的回调url地址。座席通话默认会录音,默认值空
agenthangupurlString可选通话过程中座席侧挂断电话通知的回调url地址,默认值为空,为空时自动挂断用户电话
talkmodString可选通话模式,false表示点对点,true表示会议模式。若是点对点模式,则不支持班长监听功能,默认值为true
playanswerpromptString可选是否为用户播放接通后的提示音。默认值为true
answerpromptString可选应答后播放的自定义提示音,默认为空,为空则为用户播放平台自定义文件:****工号为您服务。
worktimeString可选队列工作时间,格式:hh:mi-hh:mi。非工作时间不接听电话,为用户播放提示音后挂机
offworkdateString可选非工作日期,默认值为空,格式为 yyyy-mm-dd:yyyy-mm-dd,开始及结束日期以英文冒号隔开。相同时表示为一天。
offworkweekdayString可选每周的非工作时间,默认值为空。若是多天以#分隔,输入值为每日英文缩写,如:Mon、Tue、Wed、Thu、Fri、Sat、Sun
offworkqueueString可选非工作时间的转移的工作队列
overflowurlString可选队列溢出通知回调url,默认值为空
userhangupurlString可选用户挂机通知回调url,默认值为空

  • 注意:转接的优先顺序是先判断agentid、再判断number、最后判断queuetype,三个参数必须有一个存在。

22.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304281638380000100 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>12591111</Appid>        
  <NoAnswerTransfer callid ="13421304281638380000100"  agentid="1000"/>
</Request>

22.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

22.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>

23 获取用户输入数据

  • 座席与用户通话时,通过此命令可随时获取用户的按键输入。

23.1 请求地址


  • 注:此接口URL上在拼接sig的同时还需拼接callid

  • /{SoftVersion}/Accounts/{accountSid}/ivr/call?callid={callid}

23.2 请求包头

23.3 请求包体

节点属性类型约束说明
Appid-----String必选应用id节点
GetUserData
-----String必选获取用户数据主节点
callidString必选平台侧为每个用户呼叫分配唯一id;此处为用户侧callid
actionString必选操作结果通知的回调地址;相对url
datanotifyurlString必选用户输入数据通知的回调地址,默认值:/ datanotifyurl;相对url
typeString可选取值为0:按键输入
finishkeyString可选当type值为0时有效;0123456789*#;默认值为#
timeoutString可选当type值为0时有效;按键超时时长,默认值为-1,不超时

23.4 请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/call?sig=155EAA68C5DFB6B762A42D88F406ABCD&callid=13421304000100000001 HTTP/1.1
Accept:application/xml;
Host:192.168.0.1:8883
content-length: 139
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version='1.0' encoding='utf-8'?>
<Request>
  <Appid>appid</Appid>        
  <GetUserData action="sendoptok" callid="13421304000100000001" datanotifyurl="getuserdtmfok" finishkey="#" timeout="20"/>
</Request>

23.5 响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值000000(成功),可参考Rest 错误代码

23.6 响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
</Response>