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

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


5.3.2任务取消呼叫接口(按号码)

<p><strong>简要描述:</strong> </p> <ul> <li>任务取消呼叫接口-根据手机号码取消呼叫(耗时,谨慎使用)</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>{BaseUrl}/api/cancelCallCallee</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;">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;">callee</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>需要取消呼叫的取消值(多个逗号分隔传输)</td> </tr> <tr> <td style="text-align: left;">filed</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>苏州12345定制字段,固定传(data13)</td> </tr> <tr> <td style="text-align: left;">apikey</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>登录账号的apikey</td> </tr> <tr> <td style="text-align: left;">user_sn</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>登录账号的user_sn</td> </tr> </tbody> </table> <p><strong>返回示例</strong></p> <pre><code> { &amp;quot;code&amp;quot;:0, &amp;quot;msg&amp;quot;:&amp;quot;操作完成&amp;quot;, &amp;quot;data&amp;quot;:{ &amp;quot;total&amp;quot;:3, &amp;quot;success&amp;quot;:2, &amp;quot;fail&amp;quot;:1, &amp;quot;failInfo&amp;quot;: [ &amp;quot;213&amp;quot; ], &amp;quot;successInfo&amp;quot;: [ { &amp;quot;callee&amp;quot;: &amp;quot;13111111117&amp;quot;, &amp;quot;filed&amp;quot;: &amp;quot;137&amp;quot; }, { &amp;quot;callee&amp;quot;: &amp;quot;13111111118&amp;quot;, &amp;quot;filed&amp;quot;: &amp;quot;138&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;">code</td> <td style="text-align: left;">int</td> <td>操作结果码,0成功,其他失败</td> </tr> <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;">failInfo</td> <td style="text-align: left;">string</td> <td>取消失败信息</td> </tr> <tr> <td style="text-align: left;">successInfo</td> <td style="text-align: left;">string</td> <td>取消成功信息</td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML