简要描述:

  • 呼叫中心来去电弹屏接口,采用 websocket 方式订阅弹屏事件

初始加载:

<!--  websocket事件框架,测试服务器地址:http://sz666.mixcaller.com:8191 -->
<script type="text/javascript" src="http://sz666.mixcaller.com:8191/statics/js/mixcom.core.js"></script>
<!-- 引入事件订阅方法-->
<script type="text/javascript" src="http://sz666.mixcaller.com:8191/statics/js/mixcom.event.js"></script>

请求方式:

  • JavaScript 方法

调用的方法:

来电弹屏事件订阅:
mixpopscreen(popscrenn_params)

取消事件订阅:
mixpop.unsubscribe()

调用参数:

参数名 是否必须 类型 说明
extension int 分机号,订阅所有分机为 all 参数
poptime string 弹屏触发时机,有 RING、LINK 参数。RING:振铃弹屏、LINK:接通弹屏
popinout string 弹屏方式,有 all、dialout、dialin 参数。all:呼入呼出弹屏,dialout: 仅呼出弹屏,dialin:仅呼入弹屏
poptype int 弹屏方式,有 1、2 参数。1 为弹出新窗口、2 为执行回调方法
callback 可选 string 当 opentype 为 2 时,会执行设定回调方法
popurl 可选 string 当 opentype 为 1 时,会在新窗口打开 URL,会带相应参数

调用实例:

<script type="text/javascript">
//订阅弹屏
      var mix_popscreen = undefined;
      function start_popscreen() {
        var popscreen_params = {
          extension: "8002", //要订阅哪个分机的弹屏。必填
          popinout: "dialin", //弹屏类型,呼入(dialin)、呼出(dialout)或全部(all)弹屏。必填
          poptime: "RING", //弹屏时机,振铃(RING)或接通(LINK)。必填
          poptype: "1", //弹屏方式,1为弹出新窗口,2为指定js回调。必填
          popurl: "", //弹屏地址,只有当poptype为1时才有效
          cover_win: true, //是否覆盖弹屏窗口,true为覆盖,false为不覆盖。只有当poptype为1时才有效
          callback: function (data) {
            // 回调函数
            console.log("received data");
            console.log(data);
          }, //回调方法名,只有当poptype为2时才有效。选填
          trim_prefix: "", //号码前缀。选填
          phone_number_length: "", //限制对方电话号码的长度。选填
        };
        mix_popscreen = mixpopscreen(popscreen_params);
      }
      //取消订阅弹屏
      function end_popscreen() {
        mix_popscreen.unsubscribe();
      }

</script>

返回参数:

呼入

{
  'Event' => 'Popscreen',
  'Poptime' => 'Ring',
  'Callerid' => '18012346736',
  'CallerIDName' => '18012346736',
  'Calleeid' => '3211',
  'CalleeIDName' => '',
  'DID' => '66826688',
  'Recordfile' => '20200729-103553-3211-18012346736-1595990153.42861.mp3',
  'Uniqueid' => '1595990153.42861',
  'DateTime' => '2020-07-29 10:35:54',
  'Server' => 'localhost',
  'Method' => 'Dialin'
 }

呼出:

{
  'Event' => 'Popscreen',
  'Poptime' => 'Link',
  'Callerid' => '3209',
  'CallerIDName' => '<unknown>',
  'CID' => '66826688',
  'Calleeid' => '015512342777',
  'CalleeIDName' => '<unknown>',
  'Recordfile' => '20200729-195524-3209-015512342777-1596023723.44198.mp3',
  'Uniqueid' => '1596023723.44198',
  'DateTime' => '2020-07-29 19:55:43',
  'Server' => 'localhost',
  'Method' => 'Dialout',
}

返回参数说明:

参数名 类型 说明
Event string 弹屏事件名称,默认:Popscreen
Poptime string 有 RING、LINK 参数。RING:振铃弹屏、LINK:接通弹屏
Callerid number 主叫号码,呼入时是客户号码,呼出时是分机号码
CallerIDName string 主叫号码名称
CID number 外呼显示号码,外呼时此参数有效
DID number 呼入拨打号码,呼放时此参数有效
Calleeid number 被叫号码,呼入时是分机号码,呼出时是客户号码
CalleeIDName string 被叫号码名称
Recordfile string 录音文件名。格式:年月日-时分秒-主叫-被叫-唯一标识.mp3
Uniqueid string 呼叫唯一标识
DateTime date 呼叫时间,格式:年-月-日 时:分:秒
Server string 服务器 IP,默认 localhost
Method string 呼入呼出标识。参数(Dialout:呼出、Dialin:呼入)

备注:

弹屏事件是分机振铃或接通才会有事件,需要注册软电话才能测试。软电话使用

文档更新时间: 2020-11-03 08:38   作者:admin