转接接口请求说明

一、转接接口

1.接口简介

本接口主要用来转接来电,可以转外线,坐席或者对应的技能组

2.接口请求

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20160818/call/transfer/ACCOUNTID?sig=SIG

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 鉴权文档:接口鉴权

3.接口参数如下:

参数名 是否必填 参数释义
FromExten 坐席工号 例:假设8001@gs是坐席登陆账号,8001才是坐席工号
Exten 被叫号码 可传入,外线号码, 坐席工号, 技能组编号例如:1501045xxxx, 8000, 10014640
Mode number/skillgroup 转接到技能组为skillgroup, 转接到外线或者坐席为number
ActionID 唯一字符串(可随机) 随机码,用户用来标识请求的操作,服务器返回的Response中会带有对应Action的ActionID;在通话事件中会带有该字段;该字段最大长度是40个字节

4.系统返回

返回Json对象,样例:

{
    "Command": "Response",
    "Succeed": false,
    "Message": "317",
    "ActionID": "Transfer0.2626624043352459",
    "Response": "Transfer"
}

返回值字段说明:

字段名称 说明
Response Transfer 对应Action的名称
ActionID 唯一字符串 对应操作的唯一标记
Succeed 处理结果 请求是否成功,当不成功时会在Message字段中给出原因
Command Response 返回的固定参数
Message 结果说明 300 转接失败,联系管理员,pbx中的转接接口没有开启
310未配置外呼线路
311转接的用户忙
312转接的用户未签入
313转接的用户正在通话
314转接的用户没有以通话方式登录
315无法呼通转接的用户
316转接用户不存在
317对方忙碌,无法处理您的转接电话
400 Error action:请求有误,请检查传递的参数是否合法
401 PBX not found:账户配置问题
403 forbbiden:鉴权失败
404 Agent not found:坐席未找到,请检查FromExten字段中的坐席分机号是否传递正确
500 Server error:服务器错误

二、取消转接接口

1.接口简介

取消正在转接中的电话

2.接口请求

  • HTTP请求方式:POST

  • 是否需要鉴权:接口鉴权

  • 请求链接:{HOST}/v20160818/call/canceTransfer/ACCOUNTID?sig=SIG

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 接口鉴权

3.接口参数如下:

参数名 是否必填 参数释义
FromExten 坐席工号 例:假设8001@gs是坐席登陆账号,8001才是坐席工号
ActionID 唯一字符串(可随机) 随机码,用户用来标识请求的操作,服务器返回的Response中会带有对应Action的ActionID;在通话事件中会带有该字段;该字段最大长度是40个字节

请求实例

https://apis.7moor.com/v20160818/call/cancelTransfer/N00000001305?sig=SIG

{
   "FromExten": "8001",
    "ActionID":"123456789"
}

4.系统返回

返回Json对象,样例:

{
    "Command": "Response",
    "Succeed": true,
    "ActionID": "123456789",
    "Response": "CancelTransfer"
}

返回值字段说明:

字段名称 说明
Response CancelTransfer 对应Action的名称
ActionID 唯一字符串 对应操作的唯一标记
Succeed 处理结果 请求是否成功,当不成功时会在Message字段中给出原因
Command Response 返回的固定参数
Message 结果说明 301 This exten is not calling... 当前坐席不存在转接话务
400 Error action please check your params 传入参数错误,请检查你的参数
500 Server error 服务器错误,请联系管理员
404 Agent not found 坐席没有找到
401 PBX not found 坐席所在pbx没有找到