呼叫接口

呼叫接口


语音菜单接口

<h4>接口说明:</h4> <h5>实行对某目标号码的呼叫发起,通话被接通后,自动播放语音内容,播放完之后会根据用户的按键或不按键,可将通话转入到分机组中,系统会根据分机状态,及后台配置的分机状态回调地址发送对应的回调数据。</h5> <h4>请求方式:POST,form-data格式</h4> <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>1</td> </tr> <tr> <td>userid</td> <td>string</td> <td>是</td> <td>用户转入坐席的按键和转入坐席的分机组名示例:”1@extGroup-1”</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> </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', 'voicetype' =&amp;gt; 2, 'destnumber' =&amp;gt; '13333333333', 'voicefile' =&amp;gt; 'wwww.baidu.com/test.mp3', 'chengshudu' =&amp;gt; 1, 'userid' =&amp;gt; '1@extGroup-1', 'disnumber' =&amp;gt; '13333333333', 'customuuid' =&amp;gt; '13333333333' ]; $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> <pre><code>{ &amp;quot;buuid&amp;quot;:&amp;quot;f4ffad68-4a0f-11ea-812d-fbc8753285b6&amp;quot;, &amp;quot;callee&amp;quot;:&amp;quot;85322888486&amp;quot;, &amp;quot;caller&amp;quot;:&amp;quot;20280003&amp;quot;, &amp;quot;companycode&amp;quot;:&amp;quot;2028&amp;quot;, &amp;quot;direction&amp;quot;:&amp;quot;callout&amp;quot;, &amp;quot;disnumber&amp;quot;:&amp;quot;2120280001&amp;quot;, &amp;quot;extnumber&amp;quot;:&amp;quot;20280003&amp;quot;, &amp;quot;isbleg&amp;quot;:&amp;quot;true&amp;quot;, &amp;quot;method&amp;quot;:&amp;quot;2&amp;quot;, &amp;quot;starttime&amp;quot;:&amp;quot;1581124302&amp;quot;, &amp;quot;status&amp;quot;:&amp;quot;ring&amp;quot;, &amp;quot;uuid&amp;quot;:&amp;quot;f4ee8e7a-4a0f-11ea-8126-fbc8753285b6&amp;quot;, &amp;quot;ip&amp;quot;:&amp;quot;149.129.249.47&amp;quot; }</code></pre> <h4>回调字段说明</h4> <table> <thead> <tr> <th>字段</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>buuid</td> <td>string</td> <td>B侧唯一id</td> </tr> <tr> <td>callee</td> <td>string</td> <td>被叫号码(用户号码)</td> </tr> <tr> <td>caller</td> <td>string</td> <td>呼叫号码(分机号)</td> </tr> <tr> <td>companycode</td> <td>string</td> <td>公司码</td> </tr> <tr> <td>direction</td> <td>string</td> <td>呼叫方向 callin 呼入、callout 呼出</td> </tr> <tr> <td>disnumber</td> <td>string</td> <td>显示号码</td> </tr> <tr> <td>extnumber</td> <td>string</td> <td>分机号</td> </tr> <tr> <td>isbleg</td> <td>string</td> <td>是否B侧</td> </tr> <tr> <td>method</td> <td>string</td> <td>呼叫方式、1分机、2手动、3接口、4双呼、5预测</td> </tr> <tr> <td>starttime</td> <td>string</td> <td>呼叫开始时间</td> </tr> <tr> <td>status</td> <td>string</td> <td>分机状态 ring 响铃 answer 接听 hangup 挂断</td> </tr> <tr> <td>uuid</td> <td>string</td> <td>通话唯一id</td> </tr> <tr> <td>ip</td> <td>string</td> <td>ip</td> </tr> </tbody> </table> <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>挂断方向</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