呼叫接口

呼叫接口


播放IVR语音

<h4>接口说明:</h4> <h5>呼叫目标号码,并将语音音频内容进行自动播放,播放结束后系统自动挂机。</h5> <h4>请求参数</h4> <table> <thead> <tr> <th>参数名</th> <th>类型</th> <th>是否必须</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>service</td> <td>string</td> <td>是</td> <td>App.Sip_Call.PlayVoice</td> </tr> <tr> <td>token</td> <td>string</td> <td>是</td> <td>通过授权接口获取的token</td> </tr> <tr> <td>destnumber</td> <td>string</td> <td>是</td> <td>目标号码</td> </tr> <tr> <td>voicetype</td> <td>int</td> <td>是</td> <td>播放的语音文件类型。1:离线语音文件、2:在线语音(url)</td> </tr> <tr> <td>voicefile</td> <td>string</td> <td>是</td> <td>离线音频文件名或在线语音url地址</td> </tr> <tr> <td>chengshudu</td> <td>string</td> <td>否</td> <td>客户自定义数据,在通话结束之后的回调数据中原样返回。</td> </tr> <tr> <td>disnumber</td> <td>string</td> <td>否</td> <td>主叫号码,留空则随机取一个主叫号码</td> </tr> <tr> <td>customuuid</td> <td>string</td> <td>否</td> <td>客户自定义数据,在通话结束之后的回调数据中原样返回</td> </tr> <tr> <td>waittime</td> <td>int</td> <td>否</td> <td>呼叫等待时间</td> </tr> <tr> <td>conntime</td> <td>int</td> <td>否</td> <td>呼叫通话时间</td> </tr> </tbody> </table> <h4>接口请求示例(PHP)</h4> <pre><code>&amp;lt;?php $apiUrl = 'http://127.0.0.1:8080'; $postFields = [ 'service' =&amp;gt; 'App.Sip_Call.PlayVoice', 'token' =&amp;gt; 'ABCDEFG', 'destnumber' =&amp;gt; 'abcdefg', 'voicetype' =&amp;gt; 'abcdefg', 'voicefile' =&amp;gt; 'abcdefg', 'chengshudu' =&amp;gt; 'abcdefg', 'disnumber' =&amp;gt; 'abcdefg', 'customuuid' =&amp;gt; 'abcdefg' ]; $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, $apiUrl); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_POSTFIELDS, $postFields); curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); $response = curl_exec($curl); $curlError = curl_error($curl); curl_close($curl); var_dump($response); ?&amp;gt;</code></pre> <h4>返回数据结构示例</h4> <pre><code>{ &amp;quot;ret&amp;quot;: 200, &amp;quot;data&amp;quot;: { &amp;quot;status&amp;quot;: 0, &amp;quot;desc&amp;quot;: &amp;quot;播放命令发送成功&amp;quot;, &amp;quot;reqtime&amp;quot;: 1581307099, &amp;quot;rsptime&amp;quot;: 1581307099 }, &amp;quot;msg&amp;quot;: &amp;quot;&amp;quot; }</code></pre> <h4>接口返回说明</h4> <h5>该接口请求之后会向目标号码呼叫,目标号码接通之后会直接播放语音文件中的内容。呼叫结果会在通话结束之后,以回调方式通知到后台配置的通话详单回调地址。</h5> <h4>回调是的数据结构示例</h4> <pre><code>{ &amp;quot;answertime&amp;quot;:&amp;quot;2020-02-09 12:32:51&amp;quot;, &amp;quot;hangupcause&amp;quot;:10001, &amp;quot;duration&amp;quot;:13, &amp;quot;id&amp;quot;:220739, &amp;quot;extnumber&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;uuid&amp;quot;:&amp;quot;3418035c-4af5-11ea-afb2-fbc8753285b6&amp;quot;, &amp;quot;downloadip&amp;quot;:&amp;quot;149.129.249.47&amp;quot;, &amp;quot;customuuid&amp;quot;:&amp;quot;110001168&amp;quot;, &amp;quot;chengshudu&amp;quot;:&amp;quot;0&amp;quot;, &amp;quot;callmethod&amp;quot;:6, &amp;quot;recordfilename&amp;quot;:&amp;quot;1111.mp3&amp;quot;, &amp;quot;companycode&amp;quot;:9017, &amp;quot;memberid&amp;quot;:&amp;quot;0&amp;quot;, &amp;quot;hangupdirection&amp;quot;:10040, &amp;quot;billsec&amp;quot;:10, &amp;quot;endtime&amp;quot;:&amp;quot;2020-02-09 12:33:01&amp;quot;, &amp;quot;starttime&amp;quot;:&amp;quot;2020-02-09 12:32:38&amp;quot;, &amp;quot;type&amp;quot;:&amp;quot;callout&amp;quot;, &amp;quot;disnumber&amp;quot;:&amp;quot;2190170001&amp;quot;, &amp;quot;crmid&amp;quot;:&amp;quot;0&amp;quot;, &amp;quot;userkey&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;destnumber&amp;quot;:&amp;quot;85781218893&amp;quot; }</code></pre> <h4>回调数据字段说明</h4> <table> <thead> <tr> <th>字段</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>answertime</td> <td>string</td> <td>接听时间</td> </tr> <tr> <td>hangupcause</td> <td>string</td> <td>挂断原因</td> </tr> <tr> <td>duration</td> <td>string</td> <td>等待接听时长</td> </tr> <tr> <td>id</td> <td>string</td> <td>话单id</td> </tr> <tr> <td>extnumber</td> <td>string</td> <td>分机号</td> </tr> <tr> <td>uuid</td> <td>string</td> <td>通话唯一id</td> </tr> <tr> <td>downloadip</td> <td>string</td> <td>下载ip</td> </tr> <tr> <td>customuuid</td> <td>string</td> <td>自定义参数</td> </tr> <tr> <td>chengshudu</td> <td>string</td> <td>自定义参数</td> </tr> <tr> <td>callmethod</td> <td>string</td> <td>呼叫方式</td> </tr> <tr> <td>recordfilename</td> <td>string</td> <td>通话文件名</td> </tr> <tr> <td>companycode</td> <td>string</td> <td>公司码</td> </tr> <tr> <td>memberid</td> <td>string</td> <td>自定义参数</td> </tr> <tr> <td>hangupdirection</td> <td>string</td> <td>挂断方向:caller为主叫,callee为被叫</td> </tr> <tr> <td>billsec</td> <td>string</td> <td>通话时长</td> </tr> <tr> <td>endtime</td> <td>string</td> <td>挂机时间</td> </tr> <tr> <td>starttime</td> <td>string</td> <td>呼叫时间</td> </tr> <tr> <td>type</td> <td>string</td> <td>呼叫方式</td> </tr> <tr> <td>disnumber</td> <td>string</td> <td>主叫号码</td> </tr> <tr> <td>crmid</td> <td>string</td> <td>坐席id</td> </tr> <tr> <td>userkey</td> <td>string</td> <td>用户按键</td> </tr> <tr> <td>destnumber</td> <td>string</td> <td>目标号码</td> </tr> </tbody> </table>

页面列表

ITEM_HTML