云客智能语音客服接口文档

云客智能语音客服接口文档


5.1任务管理列表

<p><strong>简要描述:</strong> </p> <ul> <li>获取营销任务列表接口</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>{BaseUrl}/api/index</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;">pageIndex</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>分页:起始条索引(从0开始,0表示第一页,默认0)</td> </tr> <tr> <td style="text-align: left;">pageSize</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>分页:条数(默认5)</td> </tr> <tr> <td style="text-align: left;">start_create_at</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>创建开始时间(时间段),为空请求当天数据。</td> </tr> <tr> <td style="text-align: left;">end_create_at</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>创建结束时间(时间段),为空请求当天数据。</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>外呼状态:0 :发送中 1: 已发送 4: 暂停发送 6:终止发送</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>Ai用户唯一标识符</td> </tr> <tr> <td style="text-align: left;">ai_user_name</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>Ai用户名</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;">source_project</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>任务名称或者模板项目名称模糊搜索</td> </tr> </tbody> </table> <p><strong>请求示例</strong></p> <pre><code> { &amp;quot;pageIndex&amp;quot;:&amp;quot;0&amp;quot;, &amp;quot;pageSize&amp;quot;:&amp;quot;5&amp;quot;, &amp;quot;api_key&amp;quot;:&amp;quot;TEcAVs9a&amp;quot;, &amp;quot;user_sn&amp;quot;:&amp;quot;SYSUSER|cb31d43bc89487492bb0e0dd720705e0&amp;quot;, &amp;quot;start_create_at&amp;quot;:&amp;quot;2019-01-22&amp;quot;, &amp;quot;end_create_at&amp;quot;:&amp;quot;2019-01-22&amp;quot; }</code></pre> <p><strong>返回示例</strong></p> <pre><code> { &amp;quot;code&amp;quot;:0, &amp;quot;data&amp;quot;:{ &amp;quot;total&amp;quot;:329, &amp;quot;list&amp;quot;:[ { &amp;quot;dial_task_main_id&amp;quot;:1826, &amp;quot;dial_task_main_sn&amp;quot;:&amp;quot;dial_task_main_sn|e69342205b8bca83b06401a7705f4b7c&amp;quot;, &amp;quot;status&amp;quot;:&amp;quot;发送中&amp;quot;, &amp;quot;user_sn&amp;quot;:&amp;quot;SYSUSER|cdbe0021b3f5e11f43c9175757b11e2e&amp;quot;, &amp;quot;user_name&amp;quot;:&amp;quot;hln2&amp;quot;, &amp;quot;team_sn&amp;quot;:&amp;quot;ROOT|0008&amp;quot;, &amp;quot;team_name&amp;quot;:&amp;quot;测试&amp;quot;, &amp;quot;created_at&amp;quot;:&amp;quot;2018-05-08 15:40:10&amp;quot;, &amp;quot;last_modify&amp;quot;:&amp;quot;2018-05-08 15:40:10&amp;quot;, &amp;quot;started_at&amp;quot;:&amp;quot;2018-05-08 15:40:10&amp;quot;, &amp;quot;stoped_at&amp;quot;:&amp;quot;2018-05-08 15:41:44&amp;quot;, &amp;quot;total_count&amp;quot;:3, &amp;quot;send_count&amp;quot;:2, &amp;quot;remark&amp;quot;:null, &amp;quot;ring_groups&amp;quot;:null, &amp;quot;priority&amp;quot;:null, &amp;quot;project_sn&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;percentage&amp;quot;:null, &amp;quot;source&amp;quot;:&amp;quot;测试&amp;quot;, &amp;quot;batch&amp;quot;:&amp;quot;hln20180508154010&amp;quot;, &amp;quot;trunkgroup_sn&amp;quot;:null, &amp;quot;caller_group&amp;quot;:null, &amp;quot;mark&amp;quot;:null, &amp;quot;operator&amp;quot;:&amp;quot;hln&amp;quot;, &amp;quot;project_caption&amp;quot;:&amp;quot;测试&amp;quot;, &amp;quot;parent_sn&amp;quot;:&amp;quot;hln&amp;quot;, &amp;quot;success&amp;quot;:&amp;quot;1&amp;quot;, &amp;quot;fail&amp;quot;:&amp;quot;1&amp;quot;, &amp;quot;stops&amp;quot;:&amp;quot;0&amp;quot;, &amp;quot;unsend_count&amp;quot;:1, &amp;quot;percent&amp;quot;:&amp;quot;50%&amp;quot; } ] }, &amp;quot;msg&amp;quot;:&amp;quot;SUCCESS&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;">dial_task_main_id</td> <td style="text-align: left;">string</td> <td>任务ID</td> </tr> <tr> <td style="text-align: left;">dial_task_main_sn</td> <td style="text-align: left;">string</td> <td>任务唯一编号</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td>外呼状态;0 :发送中 1: 已发送 4: 暂停发送</td> </tr> <tr> <td style="text-align: left;">user_sn</td> <td style="text-align: left;">string</td> <td>子账号唯一编号</td> </tr> <tr> <td style="text-align: left;">user_name</td> <td style="text-align: left;">string</td> <td>子账号名称</td> </tr> <tr> <td style="text-align: left;">team_sn</td> <td style="text-align: left;">string</td> <td>团队编号</td> </tr> <tr> <td style="text-align: left;">team_name</td> <td style="text-align: left;">string</td> <td>团队名称</td> </tr> <tr> <td style="text-align: left;">created_at</td> <td style="text-align: left;">datetime</td> <td>创建时间</td> </tr> <tr> <td style="text-align: left;">last_modify</td> <td style="text-align: left;">datetime</td> <td>最后修改时间</td> </tr> <tr> <td style="text-align: left;">started_at</td> <td style="text-align: left;">datetime</td> <td>开始时间</td> </tr> <tr> <td style="text-align: left;">stoped_at</td> <td style="text-align: left;">datetime</td> <td>结束时间</td> </tr> <tr> <td style="text-align: left;">total_count</td> <td style="text-align: left;">int</td> <td>总呼数量</td> </tr> <tr> <td style="text-align: left;">send_count</td> <td style="text-align: left;">int</td> <td>已呼数量</td> </tr> <tr> <td style="text-align: left;">unsend_count</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;">stops</td> <td style="text-align: left;">int</td> <td>暂停数</td> </tr> <tr> <td style="text-align: left;">percent</td> <td style="text-align: left;">float</td> <td>成功率</td> </tr> <tr> <td style="text-align: left;">project_sn</td> <td style="text-align: left;">string</td> <td>项目编号</td> </tr> <tr> <td style="text-align: left;">project_caption</td> <td style="text-align: left;">string</td> <td>项目名称</td> </tr> <tr> <td style="text-align: left;">operator</td> <td style="text-align: left;">string</td> <td>创建人</td> </tr> <tr> <td style="text-align: left;">percentage</td> <td style="text-align: left;">string</td> <td>预测式倍率 (6.6版本添加)</td> </tr> <tr> <td style="text-align: left;">source</td> <td style="text-align: left;">string</td> <td>任务名称</td> </tr> <tr> <td style="text-align: left;">task_type</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;">string</td> <td>预览式 1抢拨,0平均 (6.6版本添加)</td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML