外呼接口
接口介绍
第三方系统通过发送HTTP Get请求来调用平台外呼功能,通过此接口可以在客户自己系统中实现点击呼叫的功能。
提示:外呼接口功能是默认关闭的,如需开启,请发送邮件到service@诗雨.com,写清要求开启账号的外呼接口功能
请求URL地址:对应节点的地址,具体值在开完账户之后,用户请到“查询账号信息”根据开通的账号查询。
GET请求格式样例:
http://119.254.**.**/app?Action=Dialout&ActionID=1234567890&Account=N0000000012&Exten=01067011234&FromExten=8001&PBX=xx.xx.xx.xx
参数说明:(所有字段均区分大小写;字符串编码UTF-8)
参数名 |
值 |
说明 |
Action |
Dialout |
命令名称,外呼接口中固定名称为Dialout |
ActionID |
唯一字符串 |
随机码,用户用来标识请求的操作,服务器返回的Response中会带有对应Action的ActionID;在通话事件中会带有该字段;该字段最大长度是40个字节 |
Account |
账户编号 |
用户请到“查询账号信息”根据开通的账号查询,如N0000000012 |
Exten |
被叫号码 |
对于手机号,系统会自动判断是否本地号码,从而自动在号码前加0,使用者不需要处理,只需传手机号即可,如138xxxxxxxx。对于固话,如果是外地号码使用者需要将区号带上,如010xxxxxxxx |
FromExten |
坐席工号 |
|
PBX |
xx.xx.xx.xx |
用户请到“查询账号信息”根据开通的账号查询 |
ExtenType |
Local/sip/gateway |
外呼时强制座席使用该接听方式。可选参数。正常情况下调用外呼接口不需传此字段,座席默认使用登陆呼叫中心的接听方式外呼。 |
系统返回
返回Json对象,样例:
{"Response":"Dialout","ActionID":"34534jh9i23","Succeed":false, "Message":"401 PBX not found"}
返回值字段说明:
参数名 |
值 |
说明 |
Response |
Dialout |
对应Action的名称 |
ActionID |
唯一字符串 |
对应操作的唯一标记 |
Succeed |
处理结果 |
请求是否成功,当不成功时会在Message字段中给出原因 |
Message |
结果说明 |
400 Error action:请求有误,请检查POST中传递的Json串是否合法 |