1. AI客服平台能力中间件简介

AI客服平台能力中间件接口服务，支撑用户的个性化业务需求。按照呼叫方向， 分为呼入模式和呼出（外呼）模式。

1.1. 呼入模式

呼入对接模式是指开发者在需要时主动发起呼叫，由AI电话机器人接听呼入的电话并进行人机交互。

1.1.1. 标准交互场景

1、开发者利用自有CTI 系统接通客户电话；

2、开发者 CTI 系统向AI电话机器人发起 SIP 呼叫，用于桥接机器人话路和客户话路；

3、AI电话机器人接听 SIP 来电；如果话术需要上下文动态数据，则由机器人通过 Rest 请求从开发者的业务系统中拉取（详见呼入话术上下文动态数据获取部分）；

4、开发者 CTI 系统将机器人话路和客户话路进行桥接；

5、客户与AI进行人机对话交互；

6、对话结束后，根据开发者预先设置的 URL（详见结果数据推送部分），向开发者的业务系统推送交互结果数据。

1.2. 呼出（外呼）模式

呼出（外呼）模式是指开发者使用AI电话机器人主动呼叫客户电话，并进行人机交互的模式。讯飞开放平台不提供外呼中继线路，只提供外呼调度控制能力，开发者需要自行从运营商（或线路商） 申请可外呼的中继线路，然后将外呼中继线路对接到讯飞开放平台，为机器人提供外呼话路通道。

1.2.1. 标准交互场景

1、开发者的业务系统调用AI电话机器人能力中间件 API 提交客户号码和数据；

2、AI电话机器人通过开发者的外呼中继线路并发呼叫客户电话；

3、客户接听后与AI电话机器人进行人机对话交互；

4、对话结束后，AI电话机器人根据开发者预先设置的 URL（详见结果数据推送部分），向开发者的业务系统推送交互结果数据。

注：这里的“客户”是指开发者（企业）的客户，是通过电话与AI电话机器人交互的人。

1.3. 接口协议说明

请求方向：由应用方主动请求开放平台

请求方式：HTTPS POST

字符编码：UTF-8

请求头：Content-Type: application/json;charset=UTF-8

返回格式：json

1.3.1. 返回json对象说明

开放平台的所有json响应消息采用标准对象定义，全部具有code、message和result三个属性。

2. 接口能力调用

2.1. 获取token

功能：获取授权令牌。请求本接口之外的其它接口时，必须在接口url中通过token参数携带令牌。令牌有效期默认1小时，需要在过期前重新获取。

接口地址：https://callapi.xfyun.cn/v1/service/v1/aicall/oauth/v1/token

2.1.1. 请求参数说明

请求示例

POST https://callapi.xfyun.cn/v1/service/v1/aicall/oauth/v1/token HTTP/1.1
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache
{
   "app_key": "ODM1ZTk4ODAtYTMyZC00ZjBiLTkzMDQtY2VjNWU0ZDUyZWQ5",
   "app_secret": "MTM5NUM3NjlGQ0M2REUwN0FBREE3QjUxMkU1Qzg5NUQ="
}

响应示例

HTTP/1.1 200 OK
Content-Length:98
Date:Fri, 10 Aug 2018 06:58:01 GMT
{
    "code": 0,  
    "message": "ok",  
    "result": {
       "token": "08236d0aeeee4d5b566db5f4adc41a63",
       "time_expire": 3600
    }      
}

2.1.2. result返回结果集说明

2.2. 查询配置

功能：查询企业下的各项资源及配置信息

接口地址：https://callapi.xfyun.cn/v1/service/v1/aicall/config/v1/query?token=08236d0aeeee4d5b566db5f4adc41a63

2.2.1. 请求参数说明

请求示例

{
   "type": 0
}

响应示例

{
    "code": 0,  
    "message": "ok",  
    "result": {
       "lines": [
           {
               "line_num": "055169101407",
               "concurrents": 10,
               "time_work": ["09:00:00-12:00:00", "13:00:00-17:59:59"],
               "status": 1,
               "time_apply": 1527321492000,
               "time_expire": 2592000
           },
           {
               "line_num": "055169101408",
               "concurrents": 100,
               "time_work": ["08:00:00-20:00:00"],
               "status": 0,
               "time_apply": 1527321492000,
               "time_expire": 2592000
           }
       ],
       "robots": [
           {
               "robot_id": "111111",
               "robot_name": "金融外呼",
               "call_column":["客户手机号码","姓名","性别"],
               "status": 4,
               "type": 1,
               "deleted": 0,
               "time_create": 1527321492000,
               "time_update": 1527325092000
           }
       ],
       "urls": [
           {
               "url": "http://your-service.url/receiveCallRecord",
               "url_module": "receiveCallRecord"
           }
       ],
       "voices": [
           {
               "voice_code": "60020",
               "voice_name": "春春"
           }
       ]
    }  
}

2.2.2. result返回结果集说明

2.2.3. 常用发音人清单

具体发音效果建议通过后台管理平台话术编辑的话术预览进行体验。

2.3. 直接外呼

功能：面向便捷外呼业务场景，提交号码数据同时指定线路和机器人话术，直接发起外呼。直接外呼的号码数据将被提交到应用默认对应的长期任务下。如果号码数据中存在不合规记录（例如敏感号码、非手机号等）将会整批失败。

接口地址：https://callapi.xfyun.cn/v1/service/v1/aicall/outbound/v1/task/callout?token=08236d0aeeee4d5b566db5f4adc41a63

2.3.1. 请求参数说明

请求示例

{
    "line_num":"69101338",
    "robot_id":"719",
    "call_column":["客户手机号码","姓名"],
    "call_list":[["13000000001","张先生"],["13000000002","王女士"]],
    "voice_code":"60030"
}

响应示例

{
    "code": 0,  
    "message": "ok",  
    "result": {
        "total": 2,
        "task_data_ids": [130,131]
    }     
}

2.3.2. result返回结果集说明

2.4. 创建外呼任务

功能：面向需要灵活管控的业务场景。可以按照不同的业务维度创建多组任务、分批多次向指定任务提交号码数据，可以对外呼任务进行启动、暂停、删除等控制操作。

接口地址：https://callapi.xfyun.cn/v1/service/v1/aicall/outbound/v1/task/create?token=08236d0aeeee4d5b566db5f4adc41a63

2.4.1. 请求参数说明

请求示例

{
   "task_name": "测试外呼",
   "line_num": "055169101407",
   "robot_id": "11",
   "recall_count": 1,
   "time_recall_wait": 600,
   "time_range": ["09:00:00-12:00:00", "13:00:00-17:30:00"],
   "time_begin": 1527321492000,
   "time_end": 1527325092000
}

响应示例

{
    "code": 0,  
    "message": "ok",  
    "result": {
       "task_id": "129"
    }     
}

2.4.2. result返回结果集说明

2.5. 提交任务数据

功能：向指定任务提交号码数据，可以分多批次提交。

接口地址：https://callapi.xfyun.cn/v1/service/v1/aicall/outbound/v1/task/insert?token=08236d0aeeee4d5b566db5f4adc41a63

2.5.1. 请求参数说明

请求示例

{
   "task_id": "129",
   "call_column": ["客户手机号码","列2", "列3"],
   "call_list": [
         ["13000000001","t2","t3"],
         ["13000000002","t2","t3"]
     ]
}

响应示例

{
    "code": 0,  
    "message": "ok",  
    "result": {
       "total": 2,
       "task_data_ids": [87,88]
    }  
}

2.5.2. result返回结果集说明

2.6. 启动外呼任务

功能：启动外呼任务，任务将按照预设的开始时间和工作时段进行外呼。 任务启动之后，将不能再提交号码数据。

接口地址：https://callapi.xfyun.cn/v1/service/v1/aicall/outbound/v1/task/start?token=08236d0aeeee4d5b566db5f4adc41a63

2.6.1. 请求参数说明

请求示例

{
   "task_id": "129"
}

响应示例

{
    "code": 0,  
    "message": "ok",  
    "result": {}     
}

2.6.2. result返回结果集说明

无。通过code响应码表示是否成功。

2.7. 暂停外呼任务

功能：暂时停止任务呼叫。可以通过启动外呼任务接口恢复任务呼叫。

接口地址：https://callapi.xfyun.cn/v1/service/v1/aicall/outbound/v1/task/pause?token=08236d0aeeee4d5b566db5f4adc41a63

2.7.1. 请求参数说明

请求示例

{
   "task_id": "129"
}

响应示例

{
    "code": 0,  
    "message": "ok",  
    "result": {}     
}

2.7.2. result返回结果集说明

无。通过code响应码表示是否成功。

2.8. 删除外呼任务

功能：对外呼任务进行强制停止并删除，删除后不能再次启动。接口地址：https://callapi.xfyun.cn/v1/service/v1/aicall/outbound/v1/task/delete?token=08236d0aeeee4d5b566db5f4adc41a63

2.8.1. 请求参数说明

请求示例

{
   "task_id": "129"
}

响应示例

{
    "code": 0,  
    "message": "ok",  
    "result": {}     
}

2.8.2. result返回结果集说明

无。通过code响应码表示是否成功。

2.9. 查询任务

功能：查询任务信息和任务列表。

接口地址：https://callapi.xfyun.cn/v1/service/v1/aicall/outbound/v1/task/query?token=08236d0aeeee4d5b566db5f4adc41a63

2.9.1. 请求参数说明

请求示例

{
  "time_begin": 153000000
}

响应示例

{
    "code":0,
    "message":"ok",
    "result":{
        "total_rows":30,
        "rows":[
            {
                "task_id":"1909",
                "task_name":"task_test1",
                "status":4,
                "task_type":0,
                "deleted":0,
                "time_task_start":1533289491345,
                "time_task_finish":1533820104848,
                "count_total_task":4,
                "count_tel":4,
                "count_recalled":0,
                "time_task_estimate_begin":1478157571217,
                "time_task_estimate_end":0,
                "line_num":"69101338",
                "robot_id":"719",
                "robot_name":"测试话术无参数",
                "voice_code":"60030",
                "voice_speed":1,
                "count_max_recall":2,
                "status_recall":"[1,1]",
                "time_recall_wait":2000,
                "time_range":"["07:30:00-23:30:00"]",
                "intention_push":"["A","B"]",
                "process_count":7,
                "process_tel_count":7,
                "process_through_count":4,
                "process_through_rate":1
            }
        ]
    }
}

2.9.2. result返回结果集说明

3. 结果数据推送

接口协议说明：

请求方向：由开放平台主动请求应用方

请求方式：HTTP POST

字符编码：UTF-8

返回格式：text

对接说明：

应用方应当按照开放平台的数据推送接口协议，实现并提供各类数据接收服务的接口URL地址；开放平台将会在每通电话结束后，主动向应用方URL进行HTTP POST话单、对话、录音的json数据；应用方应当立即进行响应，响应内容不限格式，但必须包含success关键字。

强烈建议应用方在接收推送数据时采用异步处理机制，接收到推送数据后立即缓存数据并响应，然后再使用异步服务对数据进行业务处理，避免因为网络传输、超时等原因造成推送数据丢失。

3.1. 话单推送

接口模块名称：receiveCallRecord

接口地址：[企业预先配置url]

注意：为了满足应用方对即时性的要求，平台对外呼的话单可能会进行两次推送。两次推送分别为基本属性话单消息和外呼属性话单消息，外呼话单消息中包含基本话单消息的所有字段项，两种消息可以通过是否包含task_row_index属性进行区分。受限于网络等因素，两次话单推送的顺序不做保证。

3.1.1. 请求参数说明

外呼结果说明

请求示例

{
    "business_id":"2745",
    "app_id":"test",
    "robot_id":"2745001",
    "call_uuid":"123425c-6483-11e8-b8fa-2769c24918cd",
    "call_relation_id":"test-123",
    "task_id":"0",
    "task_data_id":"262381",
    "caller":"69102939",
    "callee":"15556985227",
    "direction":1,
    "time_dial":1527737756729,
    "time_ring":1527737757449,
    "time_answer":1527737763429,
    "time_hangup":1527737784829,
    "duration_ring":7,
    "duration_call":28
}

响应结果示例

success

3.2. 录音推送

接口模块名称：receiveVoice接口地址：[企业预先配置url]

3.2.1. 请求参数说明

请求示例

{
    "call_uuid":"809c825c-6483-11e8-b8db-2769c24918cd",
    "url":"ant/4/ivr/0/2018/05/31/0/452263-7571100e-7afc-42aa-9d69-ac25805d45b6.wav",
    "size":1043244,
    "duration":32,
    "business_id":"10527",
    "app_id":"123",
    "robot_id":"10527"
}

响应结果示例

success

3.3. 会话推送

接口模块名称：receiveDialog接口地址：[企业预先配置url]

3.3.1. 请求参数说明

node_type节点类型说明

请求示例

{
    "business_id":"10527",
    "app_id":"123",
    "robot_id":"10527",
    "call_uuid":"f3b13ebc-6394-11e8-907d-ebcc4d560c04",
    "dialog":[
        {
            "seq":"3",
            "role":"robot",
            "node_id":"word_node_70601",
            "node_name":"开头语",
            "text_robot":"喂，您好！",
            "text_man":"",
            "question_id":""
        },
        {
            "seq":"4",
            "role":"customer",
            "node_id":"word_node_70601",
            "node_name":"开头语",
            "text_robot":"喂，您好！",
            "text_man":"",
            "question_id":"",
            "hits":[
                {
                    "hit":"任意回答",
                    "pick":true,
                    "answer_id":""
                }
            ]
        }
    ]
}

响应结果示例

success

4. 呼入话术上下文动态数据获取

此接口仅面向电话呼入对接，且话术存在动态数据的业务场景，其它场景可以不实现此接口。

4.1. 接口协议说明

请求方向：由开放平台在电话呼入时主动请求应用方

请求方式：HTTP POST

字符编码：UTF-8

返回格式：json

对接说明：

应用方应当按照开放平台的接口协议，实现并提供此服务的接口URL地址；开放平台将会在每通电话开始时，主动向应用方URL进行HTTP POST请求，获取此通电话对应的话术动态数据并执行。

强烈建议应用方的接口响应时间建议不超过500毫秒，且具备高可用性，避免影响客户电话交互体验。

接口模块名称：getDialogContext接口地址：[企业预先配置url]

4.2. 请求参数说明

4.3. 请求示例

{
    "call_relation_id":"1111",
    "business_id":"167",
    "app_id":"3333",
    "robot_id":"4444"
}

4.4. 响应结果说明

map 当前通话话术话术要求的上下文动态数据

4.5. 响应结果示例

{
"key1": "value1",
"性别": "男",
"姓名": "张三"
}

5. 调用示例

请下载 Java Demo

说明：请将Demo中APP_KEY 和 APP_SECRET换成讯飞开放平台提供的appKey和appSecret，详细内容可在相应的应用控制台 ==> 已开通服务中查看。

6. 附录

6.1. 成功码参照

6.2. 服务级错误码参照

6.3. 系统级错误码参照

6.4. 错误码格式说明（示例：200201）

Copyright © iflytek.com 2018 all right reserved，powered by Gitbook该文件修订时间：2019-05-07 07:12:51