简要描述:
请求URL:
/webapi.php?act=call
请求方式:
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appid | 是 | string | 用户id |
mynumber | 是 | string | 分机号码,由管理员提供 |
callnumber | 是 | string | 被叫号码 |
second_route | 否 | string | 是否调用第二路由, 值为1或0 |
timeStamp | 是 | int | 当前时间戳 |
sign | 是 | string | Md5(appid+timeStamp+app_key) |
请求示例
webapi.php?act=call&appid=3003&callnumber=18280273993&mynumber=18818872699&timeStamp=145879634662&&sign=23dxds2sw
return_url由管理员分配appid、appkey时配置。
返回示例
返回值
{
"code": 1,
“msg”: “”, //消息
"data": {
"orderid": "XA2015091409573318818876699", //订单号
"showno": “02037862143,020987323,028987632” , //回拨显示号码
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回码 |
msg | string | 消息 |
orderid | string | 订单号 |
showno | string | 回拨显示号码 |
备注
code 返回码,1成功 -1appid错误 -2 IP受限 -3签名不正确 -4超过并发数.(对于包月用户) -5 不在呼叫时间段 -6 已呼叫 -7 余额不足 -11.线路繁忙
简要描述:
请求URL:
回调地址+参数
请求方式:
请求参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
orderid | 是 | string | 订单号 |
state | 是 | string | 状态 1,成功 0失败 |
fee_time | 是 | string | 通话时间(分钟) |
hold_time | 是 | string | 通话时间(秒) |
start_time | 否 | int | 开始时间 |
end_time | 否 | int | 结束时间 |
msg | 否 | string | 错误信息 |
返回示例
回调地址?orderid=1234&state=1&fee_time=1&hold_time=30&msg=sucess
返回说明
回调的时候,处理成功,返回1. 返回后,将不再异步回调. 否则会有3次的回调机会
简要描述:
请求URL:
/webapi.php?act=getUserInfo
请求方式:
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appid | 是 | string | 用户id |
timeStamp | 是 | int | 当前时间戳 |
sign | 是 | string | Md5(appid+timeStamp+app_key) |
简要描述:
请求URL:
/webapi.php?act= playcheck
请求方式:
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appid | 是 | string | 用户id |
callnumber | 是 | string | 用户手机号码 |
timeStamp | 是 | int | 当前时间戳 |
sign | 是 | string | Md5(appid+timeStamp+app_key) |
返回示例
{
"code": 1,
"data": {
"orderid": "015B99E4-9A6E-A976-8ACD-B75D6414EBF5",
"showno": "显示号码"
}
}
简要描述:
请求URL:
/webapi.php?act= createphone
请求方式:
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appid | 是 | string | 用户id |
phone | 是 | string | 用户手机号码,要联通电信的130,131,132,155,156,185,186,133,153,180,181,189 |
pass | 是 | string | 密码 |
verifycode | 是 | string | 验证码 |
timeStamp | 是 | int | 当前时间戳 |
sign | 是 | string | Md5(appid+timeStamp+app_key) |
简要描述:
请求URL:
/api/user/register
请求方式:
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appid | 是 | string | 用户id |
phone | 是 | string | 坐席分机号 |
timeStamp | 是 | int | 当前时间戳 |
sign | 是 | int | Md5(appid+timeStamp+app_key) |
简要描述:
请求URL:
/webapi.php?act= queryphone
请求方式:
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appid | 是 | string | 用户id |
phone | 否 | string | 坐席分机号 |
timeStamp | 是 | int | 当前时间戳 |
sign | 是 | string | Md5(appid+timeStamp+app_key) |
简要描述:
请求URL:
/webapi.php?act=sms
请求方式:
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appid | 是 | string | 用户id |
mobile | 是 | string | 发送号码 |
type | 是 | int | 1:验证类型 2:通知类型 3:营销类型 |
timeStamp | 是 | int | 当前时间戳 |
content | 是 | int | 发送内容(注:该参数不需要加密 内容编码为UTF-8 进行urlencode传递) |
sign | 是 | int | Md5(appid+timeStamp+app_key) |
简要描述:
请求URL:
/webapi.php?act=phone_record
请求方式:
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appid | 是 | string | 用户id |
mobile | 是 | string | 号码 |
starttime | 是 | string | 统计开始日期(格式如:2018-02-01) |
endtime | 是 | string | 统计结束日期(格式如:2018-02-01) |
page | 是 | int | 当前页码(每页10条记录) |
timeStamp | 是 | int | 当前时间戳 |
sign | 是 | string | Md5(appid+timeStamp+app_key) |
简要描述:
请求URL:
/webapi.php?act=phone_record
请求方式:
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appid | 是 | string | 用户id |
mobile | 是 | string | 号码 |
starttime | 是 | string | 统计开始日期(格式如:2018-02-01) |
endtime | 是 | string | 统计结束日期(格式如:2018-02-01) |
page | 是 | int | 当前页码(每页10条记录) |
timeStamp | 是 | int | 当前时间戳 |
sign | 是 | string | Md5(appid+timeStamp+app_key) |
简要描述:
请求URL:
/webapi.php?act=addrobotrecord
请求方式:
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appid | 是 | string | 用户id |
phone | 是 | string | 号码,多个号码用“,”隔开,数量不可超过5000个 |
backurl | 否 | string | 呼叫结果异步通知回调url |
timeStamp | 是 | int | 当前时间戳 |
sign | 是 | string | Md5(appid+timeStamp+app_key) |
template_id | 是 | string | 模板ID |
返回示例
{
"code": 1,
"data": {
"orderid":21202555654315132,
}
}
返回参数说明
异步通知回调backurl参数
简要描述:
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
state | 是 | string | 0.队列中1.已提取 2. 正在呼叫 3.呼叫结束 |
record_url | 是 | string | 下载地址 |
orderid | 是 | string | 呼叫id |
phone | 是 | string | 电话 |
appid | 是 | string | 请求的appid |
level | 是 | string | 返回的等级。”A” => “意向客户”, “B” => “一般意向”, “C” => “简单对话”, “D” => “明确拒绝”, “E” => “未接通” |
phone_state | 是 | string | 电话接通的状态,具体参考下面 |
desc | 是 | string | 机器人记录的标签,如有房子,有车子(要模板配置才有) |
start_time | 是 | string | 开始时间 |
end_time | 是 | string | 结束时间 |
fee_time | 是 | string | 计费时长 |
details | 是 | Struct | 具体的机器人跟客户的对话记录 |
phone_state的值
‘called’ => ‘已接通’,
‘power off’ => ‘关机’,
‘does not exist’ => ‘空号’,
‘out of service’ => ‘停机’,
‘hold on’ => ‘正在通话中’,
‘not convenient’ => ‘无法接通’,
‘not in service’ => ‘暂停服务’,
‘busy now’ => ‘用户正忙’,
‘not a local number’ => ‘拨号方式不正确’,
‘barring of incoming’ => ‘呼入限制’,
‘call reminder’ => ‘来电提醒’,
‘forwarded’ => ‘呼叫转移失败’,
‘line is busy’ => ‘网络忙’,
‘not answer’ => ‘无人接听’,
‘defaulting’ => ‘欠费’,
‘cannot be connected’ => ‘无法接听’,
‘number change’ => ‘改号’,
‘line fault’ => ‘线路故障’,
‘redial later’ => ‘稍后再拨’,
返回示例
接口处理完成后需求响应返回success
{
" state ":3
" record_url ":下载地址URL
"orderid":21202555654315132,
"phone":13726865325,
"start_time":1520835717,
"end_time":1520835721,
"fee_time":1520835721,
"hold_time":1520835721,
"details":{
(
"create_time":1517974838
"content":什么啊?我们这边信号不好
"url":http://120.77.22.229/downwav.php?url=20180207/70715918838905_9fe2ef80-0bb8-11e8-af4a-4938eb974e44_1.wav&sign=98917990fb3311d15200bec8df0103cf&type=2
"is_robot":1
)
}
}
}
截屏保存二维码
保存后可在微信扫码关注