一、背景
二、修改记录
三、错误码定义
四、请求数据包格式规范
五、响应数据包格式规范
六、接口细则
1.开始开发
2.组织管理
3.角色权限
4.外呼时间设置
5.任务管理
5.1任务管理列表
5.2操作任务接口(暂停、继续、停止、删除)
5.3任务取消呼叫接口
5.3.2任务取消呼叫接口(按号码)
5.4获取任务详情列表接口
5.5任务失败重呼接口
5.6任务详情停播记录列表接口
5.8 新建批次接口
5.9 任务详情停播接口
5.10批次任务是否全部呼叫完成
5.11下载话术模板接口
5.12任务取消呼叫(定制)
5.7新建外呼任务
5.7.1新建外呼任务接口(excel方式)
5.7.2新建外呼任务接口(json方式)
5.7.3异步建任务后获取结果
5.7.4获取异步导入任务结果数据接口
5.7.15异步导入推送
5.7.20上虞新建人工外呼任务接口(json方式)
5.7.20上虞新建人工外呼任务接口(文件方式)
5.8新建任务批次
6.客户管理
7.话术管理
8.企业防打扰
9.后台设置

狄阁老智能AI客服接口文档

狄阁老机器人是AI人工智能时代专为企业量身打造的AI+SaaS全智能营销客服系统平台。在呼叫中心系统的基础上,融入人工智能技术,通过自动外呼、自动应答进行电话营销与客户服务,助力企业提升电话营销与客服效率、优化运营成本,最终实现降本增效。


5.7.1新建外呼任务接口(excel方式)

<p><strong>简要描述:</strong> </p> <ul> <li>新建外呼任务接口(excel方式)</li> </ul> <p>添加营销任务。有俩种方式添加,一种是新建一条营销任务的数据,一种是在原来数据的基础上添加外呼数据。俩种区别就是是否传入营销任务的唯一标识符(dial_task_main_sn)参数。如果当前任务状态为《发送中》,则会在后面继续添加,如果当前营销任务状态《已发送》,添加后任务状态会又《已发送》状态改为《暂停发送》状态。需要手动开启来继续任务。此接口只适用于excel文件导入的方式。</p> <p><strong>新建外呼任务每天有限量100次调用,如果需要频繁的创建任务,请使用追加的方式,追加只需要多传一个dial_task_main_sn字段值,这个值通过创建任务时返回,或者通过获取任务列表获得</strong></p> <hr /> <p><strong>异步方式请求URL:</strong> </p> <ul> <li><code>{BaseUrl}/api/addExcelOfAsync</code> </li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST </li> </ul> <p><strong>参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">project_sn</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>营销项目模板的唯一标识符(sn号)</td> </tr> <tr> <td style="text-align: left;">source</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>营销任务名称,只支持中英文小括号数字</td> </tr> <tr> <td style="text-align: left;">upload</td> <td style="text-align: left;">是</td> <td style="text-align: left;">file</td> <td>导入对象(限xlsx),填写好内容的项目excel文件</td> </tr> <tr> <td style="text-align: left;">ai_user_sn</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>销售人员的唯一标识符(sn号)</td> </tr> <tr> <td style="text-align: left;">is_zidong</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>呼叫类型:设置型字段,提供该字段且值为on=自动呼叫,无此字段=不自动呼叫</td> </tr> <tr> <td style="text-align: left;">mark</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>备注</td> </tr> <tr> <td style="text-align: left;">dial_task_main_sn</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>营销任务唯一标识符(sn号),导入到对应的营销任务</td> </tr> <tr> <td style="text-align: left;">is_append</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>是否是追加外呼 (0否 1是)</td> </tr> <tr> <td style="text-align: left;">timed_started_at</td> <td style="text-align: left;">否</td> <td style="text-align: left;">datetime</td> <td>定时任务开启时间,(时间格式YYYY-mm-dd xx:xx:xx)</td> </tr> <tr> <td style="text-align: left;">is_auto_fail_recall</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>开启自动失败重呼(0:不开启,1:开启)</td> </tr> <tr> <td style="text-align: left;">total_fail_recall_times</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>重呼次数,开启自动失败重呼时,只能取1到5的值,当未开启自动失败重呼,值为0</td> </tr> <tr> <td style="text-align: left;">fail_recall_interval</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>重呼间隔(分钟),开启自动失败重呼时,只能取大于1的值,当未开启自动失败重呼,值为0</td> </tr> <tr> <td style="text-align: left;">fail_recall_of_reason</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>选择通话结果,可选的值参考文档([号码状态识别结果](<a href="http://wiki.ciopaas.com:8888/web/#/4?page_id=172">http://wiki.ciopaas.com:8888/web/#/4?page_id=172</a> &quot;号码状态识别结果&quot;)),当未开启自动失败重呼,值为空</td> </tr> <tr> <td style="text-align: left;">nextday_auto_stop</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>是否隔天自动暂停(0否 1是)</td> </tr> <tr> <td style="text-align: left;">recall_auto</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>重呼方式(0新建任务重呼 1原任务重呼)</td> </tr> <tr> <td style="text-align: left;">is_open_remove_duplication</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>是否根据号码去重 1 是 0 否</td> </tr> <tr> <td style="text-align: left;">task_type</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>任务类型 0AI外呼 1人工预测式 2人工预览式 3AI预测式 (6.6版本新增)</td> </tr> <tr> <td style="text-align: left;">ai_distribution_type</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>预览式外呼 1抢拨 0平均 (6.6版本新增)</td> </tr> <tr> <td style="text-align: left;">percentage</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>预测式倍率 (6.6版本新增)</td> </tr> <tr> <td style="text-align: left;">yd_display_phone</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>外呼主叫号码,存储格式:user_sn@vos:9003#id:002@@user_sn!vos:9003#id:002 ( user_sn对应子账号sn,跟@符号拼接多个主叫号码,多个主叫号码用#拼接,主叫号码又分vos跟自定义网关的主叫,vos主叫填“vos”,网关的主叫填写对应的ID,多个子账号的主叫按@@符号拼接)</td> </tr> <tr> <td style="text-align: left;">ai_count</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>任务共享ai数时所需的ai数</td> </tr> <tr> <td style="text-align: left;">is_open_number_check</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>是否开启大数据号码检查 1是 0否 (7.1异步接口支持)</td> </tr> <tr> <td style="text-align: left;">is_open_second_dialing</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>是否开启二次拨号 1是 0否 (7.3异步接口支持)</td> </tr> <tr> <td style="text-align: left;">time_bitmap</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>外呼时间段(09:30-12:00,14:00-18:00)(7.6版本新增 只在定时任务下生效该参数)</td> </tr> <tr> <td style="text-align: left;">date_bitmap</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>呼叫星期,节假日外呼(week1,week2,week3,week4,week5,week6,week7,holiday)有”holiday”值表示开启节假日外呼(7.6版本新增 只在定时任务下生效该参数</td> </tr> <tr> <td style="text-align: left;">timed_end_at</td> <td style="text-align: left;">否</td> <td style="text-align: left;">datetime</td> <td>结束任务时间,(时间格式YYYY-mm-dd xx:xx:xx )(7.6版本新增 只在定时任务下生效该参数)</td> </tr> <tr> <td style="text-align: left;">push_client_users</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>结束任务时间,(时间格式YYYY-mm-dd xx:xx:xx )(7.8版本新增 )</td> </tr> </tbody> </table> <p><strong>同步方式返回示例</strong></p> <pre><code> { &amp;quot;total&amp;quot;:1, &amp;quot;success&amp;quot;:1, &amp;quot;fail&amp;quot;:0, &amp;quot;dial_task_main_sn&amp;quot;:&amp;quot;dial_task_main_sn|e049cf55e4bbb97fbaf688af31c31e1f&amp;quot;, &amp;quot;out_repeat&amp;quot;:0 }</code></pre> <p><strong>异步方式返回示例</strong></p> <pre><code> { &amp;quot;code&amp;quot;: 0, &amp;quot;data&amp;quot;: { &amp;quot;total&amp;quot;: 1, &amp;quot;dial_task_main_sn&amp;quot;: &amp;quot;dial_task_main_sn|xxxxxxxx&amp;quot; }, &amp;quot;msg&amp;quot;: &amp;quot;新建成功,等待处理&amp;quot; }</code></pre> <p><strong>返回参数说明</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">total</td> <td style="text-align: left;">int</td> <td>导入总数</td> </tr> <tr> <td style="text-align: left;">success</td> <td style="text-align: left;">int</td> <td>成功条数</td> </tr> <tr> <td style="text-align: left;">fail</td> <td style="text-align: left;">int</td> <td>失败条数</td> </tr> <tr> <td style="text-align: left;">dial_task_main_sn</td> <td style="text-align: left;">string</td> <td>添加成功后返回的营销任务sn</td> </tr> <tr> <td style="text-align: left;">out_repeat</td> <td style="text-align: left;">int</td> <td>重复导入条数</td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML