卓越产品开放平台

外呼接口

更新日期:2022/2/7

 

呼叫接口(动态验证)

 

 

 

1、接口介绍:

 

用此接口,客户可以实现一键外呼、双向回呼、号码隐私、隐藏号码呼叫等应用,以实现与第三方平台的互操作,进行业务定制。

注意:PAAS平台收到外呼请求后,先呼主叫,接通之后再呼被叫。

 

通过HTTPS POST方式提交请求,卓越云pass平台收到请求后,返回调用发起呼叫接口后的信息。

 

2、请求地址:

 

http://IP:58080/api/call/

 

3、请求方式:

 

POST 请求

 

 

4、请求参数JSON格式:

 

 

属性

 

 

类型

 

 

约束

 

 

说明

appid

String

必选

应用ID

time

String

必选

时间戳为实时北京时间,精确到秒的10位

callType

String

必选

呼叫类型:

inout:先呼坐席(sip)再呼客户(手机)

inin  :先呼(sip)再呼(sip)

outin:先呼客户(手机)再呼坐席(sip)

outout:先呼(手机)再呼(手机)

sig

String

必选

sid+secret+时间戳,然后md5加密(md5使用32位大写

时间戳为实时北京时间,精确到秒的10位,与time字段值保持一致

gateway

String

必选

地域标识

caller

String

必选

主叫号码(sip账号或pstn号码)

called

String

必选

被叫号码(sip账号或pstn号码)

displayCallerNum

String

可选

主叫侧显号,坐席侧看到的号码

displayCalledNum

String

必选

被叫侧显号,外显号码

data1

String

可选

自定义参数,随话单传回

data2

String

可选

自定义参数,随话单传回

 

参数备注:呼叫接口,可选字段如无值,就不传,传的所有字段必须有值。

 

 

 

5、请求示例:

 

{

"appid":"zy0ll01",

"caller":"102606",

"called":"18366889988",

"callType":"inout",

"sig":"9AA66A732E3DE4ADBFAA34B0953C8372",

"time":"1637681137",

"gateway":"zy1",

"displayCallerNum":"aaa",

"displayCalledNum":"01066668888",

"data1":"id1",

"data2":"id2"

}

 

 

 

 

外呼失败返回结果:

 

{

    "code": "152",

    "data": "sig验证不成功",

    "msg": "error",

}

 

 

 

 

外呼成功返回结果:

 

{

    "code": "200",

    "data": "",

    "msg": "success",

    "callid": "H3VKEYmbMsRITzcJ1637681174.8445358"

}