5.7.2新建外呼任务接口(json方式)
<p><strong>简要描述:</strong> </p>
<ul>
<li>新建外呼任务接口(json方式)</li>
</ul>
<p>添加营销任务。有俩种方式添加,一种是新建一条营销任务的数据,一种是在原来数据的基础上添加外呼数据。俩种区别就是是否传入营销任务的唯一标识符(dial_task_main_sn)参数。如果当前任务状态为《发送中》,则会在后面继续添加,如果当前营销任务状态《已发送》,添加后任务状态会由《已发送》状态改为《暂停发送》状态。需要手动开启来继续任务。此接口只适用于json数据格式导入的方式。</p>
<p><strong>新建外呼任务每天有限量100次调用,如果需要频繁的创建任务,请使用追加的方式,追加只需要多传一个dial_task_main_sn字段值,这个值通过创建任务时返回,或者通过获取任务列表获得</strong></p>
<hr />
<p><strong>异步请求URL:</strong> </p>
<ul>
<li><code>{BaseUrl}/api/addJsonOfAsync</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;">client_info_json</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">json</td>
<td>导入对象(限Json)格式:字段根据模板不同而不同。</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:自动启动,off:手动启动,2:定时启动)</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> "号码状态识别结果")),当未开启自动失败重呼,值为空</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;">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,多个子账号的主叫按@@符号拼接),例如单个主叫就可以:user_sn@vos:主叫</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;">model_type</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>任务模式 0单任务 1多任务 (7.7版本新增)</td>
</tr>
<tr>
<td style="text-align: left;">auto_intervention</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>任务临停 0否 1是 (7.7版本新增)</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>RPA助手推送对象 对应user_sn 多个用英文,隔开 (7.8版本新增)</td>
</tr>
<tr>
<td style="text-align: left;">task_open_auto_add_wechat</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>RPA助手 0关闭 1开启 (7.8版本新增)</td>
</tr>
<tr>
<td style="text-align: left;">number_check_rule_id</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>号码检测规则id (7.8版本新增)</td>
</tr>
<tr>
<td style="text-align: left;">user_group_sn</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>子账号组 多个用英文,分开 (7.8版本新增)</td>
</tr>
<tr>
<td style="text-align: left;">customer_type</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>自动分配 off关闭 0自动分配开启并且选择企业预设 1 自动分配开启并且选择自定义 customer_set_json字段有json数据 (7.8版本新增)</td>
</tr>
<tr>
<td style="text-align: left;">recall_auto</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>自动重呼方式 0新建任务重呼 1原任务呼完重呼 2原任务立即重呼 (7.8版本新增)</td>
</tr>
<tr>
<td style="text-align: left;">talktimesmin_recall_of_reason</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>重呼条件 <=通话时长 (7.8版本新增)</td>
</tr>
<tr>
<td style="text-align: left;">talktimesmax_recall_of_reason</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>重呼条件 &=通话时长 (7.8版本新增)</td>
</tr>
<tr>
<td style="text-align: left;">success_recall_of_reason</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>重呼条件 选择成功结果 可选 "接通后客户挂机,接通后我方挂机" (7.8版本新增)</td>
</tr>
<tr>
<td style="text-align: left;">classify_recall_of_reason</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>重呼条件 通话分类 "A,B,C"(7.8版本新增)</td>
</tr>
<tr>
<td style="text-align: left;">is_push_crm</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>公众号接收客户分配提醒:0、关;1、开(默认)(7.8版本新增)</td>
</tr>
<tr>
<td style="text-align: left;">start_at</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>外呼开始时间段。跟time_bitmap配合使用 (7.8版本新增)默认值 00:00</td>
</tr>
<tr>
<td style="text-align: left;">end_at</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>外呼结束时间段。跟time_bitmap配合使用 (7.8版本新增)默认值 239:59</td>
</tr>
<tr>
<td style="text-align: left;">customer_set_json</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>自定义分配规则 json格式 (7.8版本新增)任务自定义进入crm条件设置(格式 display1私海,2公海,0不处理</td>
</tr>
</tbody>
</table>
<p><strong>Json传参格式:</strong></p>
<pre><code> {
&quot;user_sn&quot;:&quot;{{aiusn}}&quot;,
&quot;api_key&quot;:&quot;{{aikey}}&quot;,
&quot;source&quot;:&quot;新建任务1&quot;,
&quot;project_sn&quot;:&quot;{{pj}}&quot;,
&quot;ai_user_sn&quot;:&quot;{{aius}}&quot;,
&quot;is_zidong&quot;:&quot;on&quot;,
&quot;time_bitmap&quot;:&quot;09:30-12:00,14:00-18:00&quot;,
&quot;date_bitmap&quot;:&quot;week1,week2,week3,week4,week5,week6,week7,holiday&quot;,
&quot;timed_end_at&quot;:&quot;2024-07-09&quot;,
&quot;timed_started_at&quot;:&quot;2024-07-09&quot;,
&quot;start_at&quot;:&quot;08:30:00&quot;,
&quot;end_at&quot;:&quot;21:00:00&quot;,
&quot;client_info_json&quot;:{
&quot;data&quot;:[
{
&quot;姓名&quot;:&quot;xxxx&quot;,
&quot;电话&quot;:&quot;12345678901&quot;,
&quot;地址&quot;:&quot;深圳&quot;,
&quot;公司名称&quot;:&quot;xxxx&quot;,
&quot;备注&quot;:&quot;xxxx&quot;
},
{
&quot;姓名&quot;:&quot;xxx&quot;,
&quot;电话&quot;:&quot;12345678901&quot;,
&quot;地址&quot;:&quot;深圳&quot;,
&quot;公司名称&quot;:&quot;xxxx&quot;,
&quot;备注&quot;:&quot;xxxx&quot;
}
]
},
&quot;recall_auto&quot;:&quot;0&quot;,
&quot;is_auto_fail_recall&quot;:1,
&quot;total_fail_recall_times&quot;:1,
&quot;fail_recall_interval&quot;:1,
&quot;fail_recall_of_reason&quot;:&quot;关机,来电提醒,稍后再拨,停机,无法接通,正在通话中,用户正忙,用户拒接,欠费,无人应答,其他&quot;,
&quot;talktimesmin_recall_of_reason&quot;:1,
&quot;talktimesmax_recall_of_reason&quot;:100,
&quot;success_recall_of_reason&quot;:&quot;接通后客户挂机,接通后我方挂机&quot;,
&quot;classify_recall_of_reason&quot;:&quot;A,B,C&quot;,
&quot;is_open_remove_duplication&quot;:1,
&quot;yd_display_phone&quot;:&quot;{{aius}}@vos:900002&quot;,
&quot;model_type&quot;:1
}</code></pre>
<p><strong>异步返回示例</strong></p>
<pre><code> {
&quot;code&quot;: 0,
&quot;data&quot;: {
&quot;total&quot;: 1,
&quot;dial_task_main_sn&quot;: &quot;dial_task_main_sn|xxxxxx&quot;,
&quot;dial_task_main_id&quot;: &quot;33&quot;
},
&quot;msg&quot;: &quot;新建成功,等待处理&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;">dial_task_main_sn</td>
<td style="text-align: left;">string</td>
<td>任务sn</td>
</tr>
<tr>
<td style="text-align: left;">dial_task_main_id</td>
<td style="text-align: left;">int</td>
<td>导入任务id</td>
</tr>
</tbody>
</table>
<p><strong>备注</strong> </p>
<p><strong>Json传输方式:</strong>
对需要导入client_info_json数据有明文跟密文俩种传输方式,明文传输只需传入原生json即可。
密文传输采用的是AES加密模式,以防数据被抓包。如果需要密文传输则需要传入一个aes字段,值为true,
另外得到的密串在client_info_json字段传入即可。AES加密各个参数说明如下</p>
<p><strong> AES加密模式:</strong></p>
<table>
<thead>
<tr>
<th>键</th>
<th>值</th>
</tr>
</thead>
<tbody>
<tr>
<td>CBC</td>
<td>pkcs7</td>
</tr>
<tr>
<td>数据块</td>
<td>128位</td>
</tr>
<tr>
<td>密码</td>
<td>user_sn的后面(SYSUSER后面)前16位字符串</td>
</tr>
<tr>
<td>偏移量</td>
<td>1234567890123456</td>
</tr>
<tr>
<td>输出</td>
<td>base64</td>
</tr>
<tr>
<td>字符集</td>
<td>utf8</td>
</tr>
</tbody>
</table>
<p><strong>Json数据格式:</strong>
json数据格式为一般以下载的模板文档为主,第一第二个字段必须为姓名,电话,其余字段根据每个项目的不同传入不同的数据。</p>
<p><strong>明文示例:</strong></p>
<pre><code class="language-json">{
&quot;data&quot;:[
{
&quot;姓名&quot;:&quot;xxxx&quot;,
&quot;电话&quot;:&quot;12345678901&quot;,
&quot;地址&quot;:&quot;深圳&quot;,
&quot;公司名称&quot;:&quot;xxxx&quot;,
&quot;备注&quot;:&quot;xxxx&quot;
},
{
&quot;姓名&quot;:&quot;xxx&quot;,
&quot;电话&quot;:&quot;12345678901&quot;,
&quot;地址&quot;:&quot;深圳&quot;
&quot;公司名称&quot;:&quot;xxxx&quot;,
&quot;备注&quot;:&quot;xxxx&quot;
}
]
}</code></pre>
<p><strong>密文示例:</strong></p>
<pre><code>WN0a5NVF6idFYVU23Zl4LgBxujTsZmaJiMHWDPFHK42VaD7IeGtMBaZn8Ni9P9CHxHehltg5boSX9pCaoUFkpw53KrvyeCXjppx+4GjKjSMhq2e9kh5pxudgBv8R0pgTD7p9sV+MbBRi7kZ23pI+voaDDbakijQHC3wb5GP4wIs=</code></pre>
<ul>
<li>更多返回错误代码请看首页的错误代码描述</li>
</ul>