接口说明
简介
AI客服平台能力中间件接口服务,支撑用户的个性化业务需求。按照呼叫方向, 分为呼入模式和呼出(外呼)模式。
#呼入模式
呼入对接模式是指开发者在需要时主动发起呼叫,由AI电话机器人接听呼入的电话并进行人机交互。
#标准交互场景
1、开发者利用自有CTI 系统接通客户电话;
2、开发者 CTI 系统向AI电话机器人发起 SIP 呼叫,用于桥接机器人话路和客户话路;
3、AI电话机器人接听 SIP 来电;如果话术需要上下文动态数据,则由机器人通过 Rest 请求从开发者的业务系统中拉取(详见呼入话术上下文动态数据获取部分);
4、开发者 CTI 系统将机器人话路和客户话路进行桥接;
5、客户与AI进行人机对话交互;
6、对话结束后,根据开发者预先设置的 URL(详见结果数据推送部分),向开发者的业务系统推送交互结果数据。
#呼出(外呼)模式
呼出(外呼)模式是指开发者使用AI电话机器人主动呼叫客户电话,并进行人机交互的模式。讯飞开放平台不提供外呼中继线路,只提供外呼调度控制能力,开发者需要自行从运营商(或线路商) 申请可外呼的中继线路,然后将外呼中继线路对接到讯飞开放平台,为机器人提供外呼话路通道。
#标准交互场景
1、开发者的业务系统调用AI电话机器人能力中间件 API 提交客户号码和数据;
2、AI电话机器人通过开发者的外呼中继线路并发呼叫客户电话;
3、客户接听后与AI电话机器人进行人机对话交互;
4、对话结束后,AI电话机器人根据开发者预先设置的 URL(详见结果数据推送部分),向开发者的业务系统推送交互结果数据。
注:这里的“客户”是指开发者(企业)的客户,是通过电话与AI电话机器人交互的人。
#接口协议说明
请求方向:由应用方主动请求开放平台
请求方式:HTTPS POST
字符编码:UTF-8
请求头:Content-Type: application/json;charset=UTF-8
返回格式:json
#返回json对象说明
开放平台的所有json响应消息采用标准对象定义,全部具有code、message和result三个属性。
名称 | 类型 | 说明 |
---|---|---|
code | int | 返回码。0:成功,其它值表示失败,具体参考“附录:返回码参照” |
message | string | 返回码描述 |
result | object | 返回结果集 |
调用示例
请下载 Java Demo
说明:请将Demo中APP_KEY 和 APP_SECRET换成讯飞开放平台提供的appKey和appSecret,详细内容可在相应的应用控制台 ==> 已开通服务中查看。
#附录
#成功码参照
返回码 | 说明 |
---|---|
0 | ok(成功) |
#服务级错误码参照
错误码 | 说明 |
---|---|
200101 | 账号或密码错误 |
#系统级错误码参照
错误码 | 说明 |
---|---|
10001 | 无效的token请求 |
10002 | 该token无请求权限 |
10003 | 错误的app_id |
10004 | 服务忙,请稍后再试 |
10005 | 输入参数不正确 |
10020 | 接口维护 |
10021 | 接口停用 |
200200 | 错误的数据关系 |
200201 | 错误的企业id |
200202 | 错误的任务id |
200203 | 错误的外呼号码 |
200204 | 错误的话术id |
200205 | 错误的话术发音id |
200206 | 错误的语速 |
200209 | 余额不足 |
200210 | 错误的文件格式 |
200211 | 文件上传超过限定大小10m |
200212 | 错误的数据,与话术动态信息不匹配 |
200213 | 上传的外呼数据量超过限制 |
3030002 | 号码被占用 |
3010102 | 任务已经删除 |
3010101 | 任务已经完成 |
#错误码格式说明(示例:200201)
开头 | 中间 | 尾部 |
---|---|---|
2 | 002 | 01 |
服务级错误(1为系统级错误) | 服务模块代码 | 具体错误代码 |
#常见问题
#A.I.客服平台能力中间件的主要功能是什么?
答:A.I.客服平台能力中间件,支持呼入和外呼回访服务,释放人工,降低企业成本,提升了企业工作效率和服务质量。
#A.I.客服平台能力中间件支持什么应用平台?
答:目前A.I.客服平台能力中间件支持Web api应用平台。
#A.I.客服平台能力中间件购买了就可以用吗?
答:接入能力中间件以Web API接口形式提供,需要有线路对接以及适当的开发工作量。
#是否提供线路资源?
答:线路资源是由用户与线路商进行协调,我们可帮忙推荐线路商。
#我们这边有呼叫中心,能否接入你们机器人?
答:可以,这边只要通过sip,双方线路进行对接即可;由您那边呼叫客户,客户接通过sip呼入我们系统,由机器人完成智能会话,会话结果我们会异步推送过去,包括:话单、录音、会话数据等。
#A.I.客服平台能力中间件怎么收费的?
答:价格详情参考A.I.客服平台能力中间件服务首页