注意,挂机接口的使用需要进行接口鉴权
1 接口概述
第三方系统通过发送HTTP POST请求来调用挂机功能,通过此接口可以在用户自己系统中实现结束一个通话的功能。
2 接口请求
-
HTTP请求方式:POST
-
请求链接:{HOST}/v20160818/call/hangup/{ACCOUNTID}?sig={SIG}
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
-
鉴权方式:接口鉴权
3 接口参数
参数名 | 是否必填 | 值 | 参数释义 |
CallID | CallID和Agent必填一项,优先使用CallID | 通话ID | 这个CallID一般都是由通话事件推送获取到的。可以关注link事件,这个参数会在电话接通时抛出来 |
Agent | CallID和Agent必填一项,优先使用CallID | 坐席工号 | 如8000,8001,8002等 |
ActionID | 否 | 唯一字符串(可随机) | 随机码,用户用来标识请求的操作,服务器返回的Response中会带有对应Action的ActionID;在通话事件中会带有该字段;该字段最大长度是40个字节 |
注意:如果是多个pbx,工号(Agent)为必传字段。
4 系统返回
返回Json对象,样例:
{
"Response": “HangUp”,
"ActionID": "34534jh9i23",
"Succeed": false,
"Message": "401PBXnotfound"
}
返回值字段说明:
字段名称 | 值 | 说明 |
Response | HangUp | 对应事件的名称 |
ActionID | 唯一字符串 | 对应操作的唯一标记 |
Succeed | 处理结果 | 请求是否成功,当不成功时会在Message字段中给出原因 |
Message | 结果说明 |
400 Error action:请求有误,请检查传递的参数是否合法 401 PBX not found:账户配置问题 404 Account not found:账户未找到,请检查Account参数 |