挂机接口
第三方系统通过发送HTTP Get请求来调用挂机功能,通过此接口可以在客户自己系统中实现结束一个通话的功能。
请求URL地址:对应节点的地址,具体值在开完账户之后由接口提供方发放给客户。
GET请求格式样例:
http://119.254.**.**/app?Action=Hangup&ActionID=1234567890&Account=N0000000012&CallID=dh-pbx03-7-1437983226.1347058&PBX=ds.pbx.1.0
参数说明:(所有字段均区分大小写;字符串编码UTF-8)
参数名 |
值 |
说明 |
Action |
Hangup |
命令名称,挂机接口中固定名称为Hangup |
ActionID |
唯一字符串 |
随机码,用户用来标识请求的操作,服务器返回的Response中会带有对应Action的ActionID;在通话事件中会带有该字段;该字段最大长度是40个字节 |
Account |
账户编号 |
用户请到“查询账号信息”根据开通的账号查询,如N0000000012 |
CallID |
通话ID |
这个CallID一般都是由通话事件推送获取到的。可以关注link事件,这个事件会在电话接通时抛出来 |
PBX |
xx.xx.xx.xx |
用户请到“查询账号信息”根据开通的账号查询 |
系统返回
返回Json对象,样例:
{"Response":"Hangup","ActionID":"34534jh9i23","Succeed":false, "Message":" Null channel!"}
返回值字段说明:
参数名 |
值 |
说明 |
Response |
Hangup |
对应Action的名称 |
ActionID |
唯一字符串 |
对应操作的唯一标记 |
Succeed |
处理结果 |
请求是否成功,当不成功时会在Message字段中给出原因 |
Message |
结果说明 |
Null channel! or Null CallID:这个CallID有误或者对应的通话已不存在 |