首页 - 2. 呼叫接口 登录  
最后修改者: admin  2019-08-15 00:00:00 

1. 点击拨号接口

编号  :  201

GET/POST - /index.php?m=Api&c=Exten&a=clickcallout
参考URL: /index.php?m=Api&c=Exten&a=clickcallout&token=xxxxxxxxx48bit-tokenxxxxxxxx&dailtech=sip/5060&src=5060&dst=1008610000

请求类型  application/x-www-form-urlencoded

请求参数

参数名 参数类型 必传 缺省值 描述
dailtech string Y Dial字符串,比如:SIP/5060,详见下面"备注"
src string Y 接口发起者坐席的分机号
dst string Y 被叫号码
token string Y token
trunk_valid_cid string N 呼出中继合法主叫号码

返回类型  application/json

返回值

1)失败结果: token失效
{"result":"error","code":403,"msg":"发起呼叫失败,Token不合法或者已经失效!请刷新token后再试"}

2)呼叫成功
{"result":"success","code":200,"msg":"发起呼叫成功!","ActionID":"A1878134424"}

3)呼叫失败
{"result":"error","code":500,"msg":"发起呼叫失败!"}

{"result":"error","code":404,"msg":"发起呼叫失败:被叫号码不能为空!"}

{"result":"error","code":403,"msg":"发起呼叫失败:被叫号码不合格!"}
{"result":"error","code":403,"msg":"发起呼叫失败:坐席分机未就绪!"}

备注

1) Dial字符串: 形如 "SIP/5060",该字符串在生成token的坐席登录接口调用中,如果调用成功后会有返回,接口调用者可以将此字符串和token存入session,以供后续接口调用使用。
如果PBX后台关闭了token校验安全设置,那么此字符串一般格式为: "SIP/分机号"

2)呼出中继合法主叫号码(trunk_valid_cid):此参数如果不传,线路呼出主叫默认为分机号,但是有些中继线路需要有合法的主叫号码, 比如E1线路中继必须采用运营商分配的主叫CID号码,否则呼叫会被拒绝,如果点击呼叫通过E1线路呼出,那么建议传递此参数。
最后修改者: admin  2019-08-15 00:00:00 

2. 挂断自己通话

编号  :  2

GET/POST - /index.php?m=Api&c=Exten&a=hangup

请求类型  application/x-www-form-urlencoded

请求参数

参数名 参数类型 必传 缺省值 描述
exten string Y 坐席分机号
token string Y token

返回类型  application/json

返回值

挂机成功:
{"result":"success","code":200,"msg":"挂断成功!"}

挂机失败:
{"result":"error","code":404,"msg":"挂断失败:通话不存在!"}
最后修改者: admin  2019-08-15 00:00:00 

3. 转接当前通话

编号  :  3

GET/POST - /index.php?m=Api&c=Exten&a=transfer

请求类型  application/x-www-form-urlencoded

请求参数

参数名 参数类型 必传 缺省值 描述
exten string Y 坐席自己的分机号
phone string Y 要转接到的坐席分机、手机号、座机、队列(技能组)号码
token string Y token

返回类型  application/json

返回值

成功:
{"result":"success","code":200,"msg":"转接成功!"}

失败:
{"result":"error","code":404,"msg":"转接失败:通话不存在!"}
{"result":"error","code":500,"msg":"转接失败!"}
{"result":"error","code":403,"msg":"转接失败:目标坐席已经被手动置忙!"}
{"result":"error","code":403,"msg":"转接失败:坐席当前处于会议通话模式,不能转接!"}
最后修改者: admin  2019-08-15 00:00:00 

4. 邀请多方通话

编号  :  4

GET/POST - /index.php?m=Api&c=Exten&a=multicall

请求类型  application/x-www-form-urlencoded

请求参数

参数名 参数类型 必传 缺省值 描述
token string Y token
exten string Y 发起邀请的坐席分机
phone string Y 被邀请的坐席分机、座机、手机

返回类型  application/json

返回值

成功:
{"result":"success","code":200,"msg":"邀请成功!","roomNum":"9914"}

失败:
{"result":"error","code":403,"msg":"邀请失败,Token不合法或者已经失效!请刷新token后再试"}
{"result":"error","code":404,"msg":"邀请失败:号码不能为空!"}
{"result":"error","code":404,"msg":"邀请失败:通话不存在!"}
{"result":"error","code":500,"msg":"邀请失败:目标坐席未就绪!"}
{"result":"error","code":500,"msg":"邀请失败:目标坐席未就绪!"}
最后修改者: admin  2019-08-15 00:00:00 

5. 保持通话

编号  :  5

GET/POST - /index.php?m=Api&c=Exten&a=holdon

请求类型  application/x-www-form-urlencoded

请求参数

参数名 参数类型 必传 缺省值 描述
token string Y token
exten string Y 坐席自己的分机号

返回类型  application/json

返回值

成功:
{"result":"success","code":200,"msg":"保持成功!"}

失败:
{"result":"error","code":404,"msg":"保持失败:坐席分机号不存在!"}
{"result":"error","code":403,"msg":"保持失败,Token不合法或者已经失效!请刷新token后再试"}
{"result":"error","code":404,"msg":"保持失败:通话不存在!"}
最后修改者: admin  2019-08-15 00:00:00 

6. 恢复通话

编号  :  6

GET/POST - /index.php?m=Api&c=Exten&a=restore

请求类型  application/x-www-form-urlencoded

请求参数

参数名 参数类型 必传 缺省值 描述
token string Y token
exten string Y 坐席自己的分机号

返回类型  application/json

返回值

成功:
{"result":"success","code":200,"msg":"恢复成功!"}

失败:
{"result":"error","code":404,"msg":"恢复失败:坐席分机号不存在!"}
{"result":"error","code":403,"msg":"恢复失败,Token不合法或者已经失效!请刷新token后再试"}
{"result":"error","code":403,"msg":"恢复失败:坐席分机未就绪!"}
{"result":"error","code":500,"msg":"恢复失败!"}
最后修改者: admin  2019-08-15 00:00:00 

7. 拦截呼入通话并将号码添加到呼入黑名单

编号  :  7

GET/POST - /index.php?m=Api&c=Exten&a=block

请求类型  application/x-www-form-urlencoded

请求参数

参数名 参数类型 必传 缺省值 描述
token string Y token
exten string Y 坐席分机号

返回类型  application/json

返回值

拦截成功:
{"result":"success","code":200,"msg":"拦截成功!"}

拦截失败:
{"result":"error","code":403,"msg":"拦截失败,Token不合法或者已经失效!请刷新token后再试"}
{"result":"error","code":404,"msg":"拦截失败:通话不存在!"}