卓越产品开放平台

通话控制api

更新日期:2022/2/9

 

通话控制api接口

 


1、通话控制api介绍

 

   对于通话中的通道进行控制,除了提供以上所说的工具条方式,卓越还提供了api对接方式,使用api对接,相比工具条会更灵活。

 

1、请求地址:

 

http://IP:60000/api/optcall/

 

 

3、请求方式:

 

POST 请求

 

4、请求参数:

 

 

 

属性

 

 

类型

 

 

约束

 

说明

appid

String

必选

应用ID

secret

String

必选

api认证码

agentNum

String

必选

当前通话的sip号(outout传主叫)

exten

String

可选

号码,执行转接时的转接号

监听或三方时的sip号

eavesdrop_dtmf时的数字:

1与被叫耳语

2 与主叫耳语

3 三方通话

0 恢复监听

 

command

String

必选

uuid_hold  保持通话

uuid_holdoff 结束保持恢复正常通话

hupall  挂断通话

Hupall_uuid  挂断通话

uuid_transfer  转接通话

three_way   三方通话

eavesdrop 监听

eavesdrop_dtmf  耳语和恢复

 

 

 

5、请求示例

 

 

{

    "appid": "zy0019",

    "secret": "kqjwjqqwkj1123274",

    "agentNum": "100393",

    "command": "uuid_hold",

}

 

 

 

 

失败返回结果:

 

{

    "code": "131",

    "data": "",

    "msg": "error",

    "number": "0",

    "request_id": "83ZCJTuok2AgRFqW1635478859.0518482"

}

 

 

 

成功返回结果:

 

{

    "code": "200",

    "data": "",

    "msg": "success",

    "request_id": "MSTpcdraPqiUouD71635430546.0976954"

}