大麦库房-API


创建外呼任务

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>创建外呼任务</li> </ul> <h5>请求URL</h5> <ul> <li><code>https://api.solinkup.com/trigger/api/e2c1fea4c6dc4ec6959fbf66d4ed23d1/ai_outbound</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST </li> </ul> <h5>参数</h5> <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;">userID</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>用户ID</td> </tr> <tr> <td style="text-align: left;">companyID</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>企业ID</td> </tr> <tr> <td style="text-align: left;">operateType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>操作类型(创建外呼任务操作类型编号为:12,这个字段直接填“12”即可)</td> </tr> <tr> <td style="text-align: left;">taskName</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>任务名称</td> </tr> <tr> <td style="text-align: left;">selectSceneID</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>呼叫场景ID(请使用场景状态sceneStatus为“2”,可使用的场景的场景ID)</td> </tr> <tr> <td style="text-align: left;">callType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>呼叫类型:&lt;br&gt;立即呼叫&lt;br&gt;定时呼叫</td> </tr> <tr> <td style="text-align: left;">chinaOutcallStartTime</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>如果选择的是国内呼叫场景,且是定时呼叫,需要传呼叫开始时间,国内立即呼叫、国外及港澳台呼叫不用传</td> </tr> <tr> <td style="text-align: left;">callNumbersList</td> <td style="text-align: left;">是</td> <td style="text-align: left;">array</td> <td>外呼名单信息列表</td> </tr> </tbody> </table> <h5>下面是中国大陆地区呼叫callNumbersList中每条呼叫信息需要的参数</h5> <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;">callName</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>呼叫人姓名</td> </tr> <tr> <td style="text-align: left;">callNumber</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>呼叫人电话(中国大陆地区手机号码,不需要加“86”的前缀)</td> </tr> <tr> <td style="text-align: left;">customData</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>自定义数据</td> </tr> </tbody> </table> <h5>下面是国外及港澳台地区呼叫callNumbersList中每条呼叫信息需要的参数</h5> <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;">callName</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>呼叫人姓名</td> </tr> <tr> <td style="text-align: left;">callNumber</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>呼叫人电话(国外及港澳台地区手机号码)&lt;br&gt;号码格式是:国家+区号+号码(呼叫手机号码没有区号可以省略),比如 上海的号码是 021 65241234 ,要用这个格式 862165241234 , 不要加 00, 不要加 +, 不要在国家和区号前加 0。</td> </tr> <tr> <td style="text-align: left;">numberCountry</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>呼叫号码所属国家(可不传)</td> </tr> <tr> <td style="text-align: left;">planCallingTime1</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>第一计划呼出时间(立即呼叫不填,定时呼叫必填)</td> </tr> <tr> <td style="text-align: left;">planCallingTime2</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>第二计划呼出时间(是定时呼叫且呼叫时间1有值,可选填呼叫时间2,时间2必须大于时间1)</td> </tr> <tr> <td style="text-align: left;">planCallingTime3</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>第三计划呼出时间(是定时呼叫且呼叫时间1、呼叫时间2有值,可选填呼叫时间3,时间3必须大于时间2)</td> </tr> <tr> <td style="text-align: left;">customData</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>自定义数据</td> </tr> </tbody> </table> <h5>【备注】:</h5> <p>1、所有的呼叫时间都是北京时间,国外及港澳台地区的呼叫,请根据呼叫地区将时间转成北京时间; 2、呼叫时间格式:yyyy-MM-dd HH:mm (2025-01-09 08:30 或 2025-01-09 08:00); 时间规则:月、日、时、分,都必须为两位数,时间支持整点、半点,呼叫时间必须大于当前时间; 3、一个呼叫任务的呼叫数量不要超过100个。</p> <h5>返回示例</h5> <pre><code> { &amp;quot;success&amp;quot;: true, &amp;quot;message&amp;quot;: &amp;quot;任务创建成功&amp;quot;, &amp;quot;task_id&amp;quot;: 1789887876678 }</code></pre> <h5>返回参数说明</h5> <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;">success</td> <td style="text-align: left;">bool</td> <td>请求状态</td> </tr> <tr> <td style="text-align: left;">message</td> <td style="text-align: left;">string</td> <td>请求描述信息</td> </tr> <tr> <td style="text-align: left;">task_id</td> <td style="text-align: left;">string</td> <td>创建成功任务的ID</td> </tr> </tbody> </table>

页面列表

ITEM_HTML