概述

智能外呼开放平台支持用户通过API接口调用智能外呼能力，按照业务类型，可分为批量任务和实时调用两种，此外，还支持将呼叫数据回调给用户业务系统。

业务流程

批量任务

批量任务整体业务流程如下图所示。

相关说明

• 获取AK/SK和生成认证Token，租户在配置台-API配置中，创建AK/SK，并填写回调地址，根据按照「生成认证Token」文档，生成认证Token，每次调用接口时，均需认证Token进行认证鉴权；
• 创建外呼机器人，在「配置台」-「机器人组装」中创建、配置以及发布外呼机器人；
• 获取外呼机器人，调用「获取机器人列表」，获取租户下已发布的外呼机器人list；
• 获取主叫号码，调用「获取主叫号码列表」，获取租户下的主叫号码list；
• 创建任务，调用「创建任务」,创建外呼任务；
• 导入名单，调用「导入名单」，向目标任务导入待呼叫名单，并返回名单ID（即MemberID）；
• 任务启动，调用「任务状态变更」，以启动任务，若需暂停/恢复/结束任务，则调用「任务状态变更接口」，可实现任务的暂停、结束、恢复；
• 呼叫被叫号码；
• 数据回调：当有回调数据产生时，则向回调地址（用户在「API配置」配置的回调地址）进行外呼数据的回调。

实时调用

开发平台支持用户对系统进行实时调用，满足业务系统实时产生名单且实时外呼需求，且支持排队功能。

相关说明

• 获取AK/SK和AccessToken，租户在配置台-API配置中，创建AK/SK，并填写回调地址并配置实时呼叫通路数，根据按照「生成认证Token」文档，生成认证Token，每次调用接口时，均需认证Token进行认证鉴权；
• 创建外呼机器人，在「配置台」-「机器人组装」中创建、配置以及发布外呼机器人；
• 获取外呼机器人，调用「获取机器人列表」接口，获取租户下已发布的外呼机器人list；
• 获取主叫号码，调用「获取主叫号码列表」接口，获取租户下的主叫号码list；
• 实时呼叫，调用「实时调用」接口，并传入主叫号码、被叫号码、机器人 id、呼叫截止时间、扩展字段、加密方式等字段，发起实时调用；
• 呼叫被叫号码；
• 数据回调，当有回调数据产生时（呼叫结束后），则向回调地址（用户在「API配置」配置的回调地址）进行外呼数据的回调

数据回调

回调类型

回调类型，包括：任务单通电话回调、任务号码终态回调、任务状态变更回调、实时调用单通电话回调。

• 任务单通电话回调：批量任务中，当单通电话呼叫结束后，包括未接通和已接通，将话单+会话内容一并回调；
• 任务号码组终态回调：号码组进入终态后，包括已完成和已打完，将号码组信息一并回调；
• 任务状态变更回调：任务状态发生变更后，需将任务变更后状态进行回调。
• 实时调用单通电话回调：针对实时调用，当单通电话呼叫结束后，包括未接通和已接通，将话单+会话内容一并回调；

回调触发时间点

• 单通电话回调：电话呼叫结束后，包括未接通和已接通；
• 号码组终态回调：号码组进入终态；
• 任务状态变更回调：任务状态发生变更，变更为「执行中」/「已暂停」/「已完成」。

回调说明

回调成功后，状态码为200，表明本次回调成功，否则会认为回调失败。