预约使用
即接即用,玖云平台为您提供稳定的通信能力
开发者账户使用使用指南
开放接口使用指南
平台审核标准
平台服务标准
Rest API接口介绍
取消通话接口
通话记录查询接口
录音及下载接口
专线语音接口
专号通接口
专号通号码申请接口
专号通号码查询接口
专号通号码释放接口
应用映射号码查询接口
语音通知下发接口
取消预约语音通知接口
语音通知记录查询接口
语音验证码接口
智能语音验证接口
订单小号绑定接口
订单小号解绑接口
订单小号查询接口
订单小号话单查询接口
虚拟小号绑定接口
虚拟小号解绑接口
虚拟小号查询接口
虚拟小号在线呼叫接口
虚拟小号话单查询接口
工作号被叫绑定接口
云呼小号在线呼叫接口
批量上传号码接口
手机专号通绑定接口
手机专号通解绑接口
手机专号通更新接口
手机专号通查询接口
手机专号通双呼接口
云话机回拨接口
SDK产品简介
SDK集成指南
来电推送配置指南
Web
Android
Ios
更多
常见问题
专线语音回调通知接口
专号通回调通知接口
语音通知状态回调接口
语音验证码回调接口
智能语音验证回调接口
订单小号状态回调接口
虚拟小号状态回调接口
云呼小号状态回调
AI智能语音回调接口
语音回呼回调接口
手机专号通回调接口
云双呼回调接口
云呼AXB回调接口
云话机回调通知接口
全局错误码表
接入流程
(1).创建应用并配置用户的AS服务器地址即回调地址
(2).用户AS服务器端开发相应接口
(3).开始使用
请求地址配置
请求地址为开发者服务器地址,具体配置方式如下:
在每个号码呼叫结束之后,玖云平台会把相关通话结果发送给用户,用户需要接收处理,并返回应答。
回调请求地址
用户自行配置URL地址。通过POST方式请求通知用户,只提供JSON格式。
回调请求包头
| 属性 | 类型 | 约束 | 说明 |
| Content-Type | String | 必选 | 类型application/json |
| Content-Length | String | 必选 | 消息体的长度 |
回调请求包体
| 属性 | 类型 | 约束 | 描述 |
| action | String | 必选 | 请求类型,固定值“AI” |
| type | int | 必选 | 呼叫类型,固定值“17” |
| appId | String(32) | 必选 | 应用id |
| callId | int | 必选 | 呼叫id |
| batchNumber | String(128) | 必选 | 批次号 |
| phone | String(20) | 必选 | 手机号码 |
| company | String(30) | 可选 | 机主的公司名称,原样返回 |
| name | String(100) | 可选 | 机主的姓名,原样返回 |
| remarks | String(150) | 可选 | 备注,原样返回 |
| attach | String(100) | 可选 | 附加数据,原样返回 |
| starttime | String(20) | 必选 | 外呼开始时间 y-m-d H:i:s,例如2017-12-16 12:15:16 |
| endtime | String(20) | 必选 | 外呼结束时间y-m-d H:i:s,例如2017-12-16 12:15:16 |
| calltime | int | 必选 | 通话时长,秒 |
| operate | String(30) | 必选 | 所属者 |
| label | String(2) | 必选 | 根据话术规则AI判定的标签 |
| labelReason | String(128) | 必选 | AI判定标签的理由 |
| templateId | String(30) | 必选 | 话术模版Id |
| customerSex | String(50) | 必选 | AI识别的结果,有一定概率,如“女(100%)” |
| list | List | 必选 | |
| list.id | int | 必选 | 语音流水ID |
| list.phone | String(20) | 必选 | 手机号码 |
| list.callid | int | 必选 | 通话id |
| list.content | String(300) | 必选 | 语音识别内容 |
| list.answer | String(500) | 必选 | AI话术内容 |
| list.addtime | String(20) | 必选 | 通话时间y-m-d H:i:s,例如2017-12-16 12:15:16 |
| dateCreated | String | 必选 | 回调用的请求时间 |
参数说明:
1)action:请求类型,固定值“AI”
2)type:呼叫类型,固定值“17”
3)appId:应用ID
4)callId:呼叫ID
5)batchNumber:批次号
6)phone: 手机号码
7)company:机主的公司名称,原样返回
8)name:机主的姓名,原样返回
9)remarks:备注,原样返回
10)attach:附加数据,原样返回
11)starttime:外呼开始时间 y-m-d H:i:s,例如2017-12-16 12:15:16
12)endtime: 外呼结束时间y-m-d H:i:s,例如2017-12-16 12:15:16
13)calltime:通话时长,秒
14)operate:所属者
15)label:根据话术规则AI判定的标签
16)labelReason:AI判定标签的理由
17)templateId:话术模版Id
18)customerSex:AI识别的结果,有一定概率,如“女(100%)”
19)list:
20)list.id:语音流水ID
21)list.phone:手机号码
22)list.callid:通话id
23)list.content:语音识别内容
24)list.answer:AI话术内容
25)list.addtime:通话时间y-m-d H:i:s,例如2017-12-16 12:15:16
26)dateCreated:回调用的请求时间
回调请求示例
JSON请求示例
POST
{
"action": "valueAI",
"type": 17,
"appId": "7290fa01293c483fb2709c690f213272",
"callId": 495921,
"batchNumber": "PC20171226001",
"phone": "13815443105",
"company": "大众",
"name": "张三",
"remarks": "1000.00",
"attach": "第二次呼叫",
"starttime": "2017-12-16 12:15:16",
"endtime": "2017-12-16 12:16:06",
"calltime": 59,
"operate": "test",
"label": "A",
"labelReason": "场景互动 3 轮及以上",
"templateId": "12348674",
"customerSex": "女( 100 %)",
"list": [
{
"id": 435458,
"phone": "13815443105",
"callid": 495921,
"content": "嗯",
"answer": "您好,这边是借条贷后管理部,请问是张三吗?",
"addtime": "2017-12-16 12:15:16 "
},
{
"id": 435459,
"phone": "13815443105",
"callid": 495921,
"content": "嗯",
"answer": "您好,这边是借条贷后管理部,请问是张三吗?",
"addtime": "2017-12-16 12:15:16 "
}
],
"dateCreated": "2017/04/24 13:55:09"
}
用户AS响应包头
| 属性 | 类型 | 约束 | 说明 | 举例 |
| Status-Code | String | 必选 | 应答状态码,全部为200 | HTTP/1.1 200 OK |
| Date | String | 可选 | 服务器时间 | Wed Nov 9 16:08:57 2011 |
| Content-Length | String | 必选 | 消息体的长度 | 140 |
用户AS响应包体
| 属性 | 类型 | 约束 | 描述 | 取值 |
| statusCode | String | 必选 | 响应结果 | 用户返回错误码 0000表示成功,目前平台不对此字段进行解析 |
| statusMsg | String | 可选 | 响应结果描述 | 用户自定义描述,目前平台不对此字段进行解析 |
用户AS响应示例
JSON响应示例
{
"statusCode": 0,
"statusMsg": "success"
}
如果客户配置了计划拨打完成通知功能,则在一批计划呼叫结束之后,玖云平台会发送通知给用户,用户接收处理,并返回应答。
回调请求地址
用户自行配置URL地址。通过POST方式请求通知用户,只提供JSON格式。
回调请求包头
| 属性 | 类型 | 约束 | 说明 |
| Content-Type | String | 必选 | 类型application/json |
| Content-Length | String | 必选 | 消息体的长度 |
回调请求包体
| 属性 | 类型 | 约束 | 描述 |
| action | String | 必选 | 请求类型,固定值“AI” |
| type | int | 必选 | 呼叫类型,固定值“18” |
| appId | String | 必选 | 应用id |
| batchNumber | String | 必选 | 批次号 |
| numberTotal | int | 必选 | 该批次用户总数量 |
| numberCalled | int | 必选 | 该批次已外呼数量 |
| numberF | int | 必选 | 该批次外呼标签为F的数量 |
| dateCreated | String | 必选 | 回调用的请求时间 |
参数说明:
1)action:请求类型,固定值“AI” 2)type:呼叫类型,固定值“18” 3)appId:应用ID 4)batchNumber:批次号 5)numberTotal:该批次用户总数量 6)numberCalled: 该批次已外呼数量 7)numberF:该批次外呼标签为F的数量 8)dateCreated:回调用的请求时间
回调请求示例
JSON请求示例
POST
{
"action": "AI",
"type": 18,
"appId": "7290fa01293c483fb2709c690f213272",
"batchNumber": "PC1002IJS34543F",
"numberTotal": "10",
"numberCalled": "10",
"numberF": 1,
"dateCreated": "2017/04/24 13:55:09"
}
用户AS响应包头
| 属性 | 类型 | 约束 | 说明 | 举例 |
| Status-Code | String | 必选 | 应答状态码,全部为200 | HTTP/1.1 200 OK |
| Date | String | 可选 | 服务器时间 | Wed Nov 9 16:08:57 2011 |
| Content-Length | String | 必选 | 消息体的长度 | 140 |
用户AS响应包体
| 属性 | 类型 | 约束 | 描述 | 取值 |
| statusCode | String | 必选 | 响应结果 | 用户返回错误码 0000表示成功,目前平台不对此字段进行解析 |
| statusMsg | String | 可选 | 响应结果描述 | 用户自定义描述,目前平台不对此字段进行解析 |
用户AS响应示例
JSON响应示例
{
"statusCode": 0,
"statusMsg": "success"
}
1
2
3
4