Webcall接口
接口简介
呼叫中心系统,提供一个http接口,来发起外呼将被叫呼通后送入指定的流程中。在这个流程中,客户可以实现语音播报、接入坐席等一系列功能。
接口参数如下:(红色为必传参数)
参数名 |
描述 |
Action |
Webcall(固定不变) |
PBX |
PBX,用户请到“查询账号信息”根据开通的账号查询 |
Account |
用户编号,请到“查询账号信息”根据开通的账号查询 |
ServiceNo |
服务号,想要被叫进入的服务号码 |
Exten |
被叫电话号码。 |
Variable |
var1:value1,var2:value2……(可以传多个变量,如无需特殊定制可以不传) |
ActionID |
本次调用接口的唯一标示,response中会返回此字段。 |
Timeout |
接口呼叫被叫的时长单位为秒。值的范围为20至60,此时长包含接口调用后被叫开始振铃的这段时间。如果被叫有响应,则接口立即返回。如被叫一直不接,直到超时时间接口才返回。(本字段可不传,默认超时时长为20秒) |
调用实例:
http://127.0.0.1/command?Action=Webcall&PBX=bpx.ali.0&Account=Q00000000****&ServiceNo=01053500303&Exten=1581101** **&Timeout=40&Variable=var1:value1,var2:value2
接口返回值详解:
本接口是同步接口,所以response是在被叫号码做出响应后才会返回。超时时间默认为20秒(可以通过参数Timeout设置)。
接口返回的response是一个json格式字符串,包含如下字段:
参数名 |
值 |
说明 |
Command |
Response |
值固定不变 |
Response |
WebCall |
值固定不变 |
ActionID |
随机数 |
与调用接口时传的ActionID相同。如果调用接口时没传ActionID,则值是Webcall+随机数。 |
Succeed |
true/false |
本次接口调用是否成功。 |
Message |
true/false |
a)Message:4 被叫已接听 |
Response例子:
{"Command":"Response","Succeed":true,"Message":"4","ActionID":"Webcall1382293010856915711", "Response":"Webcall"}