@94ai/softphone 4.0.1

package/src/types/index.ts

@@ -0,0 +1,343 @@
+import type { UserAgentDelegate } from 'sip.js/lib/api/user-agent-delegate'
+import type { UserAgentOptions as SipUserAgentOptions } from 'sip.js/lib/api/user-agent-options'
+import { URI } from 'sip.js'
+import { InvitationRejectOptions } from 'sip.js/lib/api/invitation-reject-options'
+import { SessionByeOptions } from 'sip.js/lib/api/session-bye-options'
+import { RegistererOptions } from 'sip.js/lib/api/registerer-options'
+import { RegistererRegisterOptions } from 'sip.js/lib/api/registerer-register-options'
+import { InviterInviteOptions } from 'sip.js/lib/api/inviter-invite-options'
+import { SessionInfoOptions } from 'sip.js/lib/api/session-info-options'
+import { InvitationAcceptOptions } from 'sip.js/lib/api/invitation-accept-options'
+
+export type InviterInviteOptionsExtend = InviterInviteOptions & {extraHeaders?: string[]}
+export type SessionInfoOptionsExtend = SessionInfoOptions & {extraHeaders?: string[]}
+export type InvitationAcceptOptionsExtend = InvitationAcceptOptions & {onAck?: Function, onAckTimeout?: Function }
+
+/**
+ * 挂断配置
+ */
+export type HandUpInviteOption = {
+  /** 当会话尚在建立中,配置挂断请求 */
+  rejectOptions?: InvitationRejectOptions,
+  /** 当会话已建立,配置挂断请求 */
+  byeOptions?: SessionByeOptions
+  /** sip自定义头 */
+  extraHeaders?: string[]
+  /** 是否开启响应返回检测 */
+  scoutResponse?: boolean
+}
+
+/**
+ * 注册配置
+ */
+export type RegisterOptions = {
+  /** sip自定义头 */
+  extraHeaders?: string[]
+  /** new Registerer Options */
+  registererOptions?: RegistererOptions
+  /** Registerer Instance register Options */
+  registererRegisterOptions?: RegistererRegisterOptions
+}
+
+/**
+ * 签入配置
+ */
+export type PrepareUserAgentOptions = {
+  /** sip服务地址,可以用于切换签入服务器 */
+  uri?: URI,
+  /** 分机号,可以用于切换签入服务器 */
+  authorizationUsername?: string,
+  /** 分机密码,可以用于切换签入服务器 */
+  authorizationPassword?: string,
+  /** transport层协议配置,可以用于切换签入服务器 */
+  transportOptions?: TransportOptions,
+  /** 一般设置同authorizationUsername，相当于MicroSIP的显示名称,可以用于切换签入服务器 */
+  contactName?: string
+  /** sip自定义头 */
+  extraHeaders?: string[]
+  /** 当软电话状态变化时会实时刷新这个方法 */
+  refresh?: (path: UserAgentStatusKey, value: boolean) => void,
+  /** new Registerer Options */
+  registererOptions?: RegistererOptions
+  /** Registerer Instance register Options */
+  registererRegisterOptions?: RegistererRegisterOptions
+  agentId?: number
+  agentTag?: string
+  appKey?: string
+  appSecret?: string
+  openBaseUrl?: string
+  sg?: '1' | '0'
+  sgOpen?: '1' | '0'
+}
+
+/**
+ * 软电话代理实例状态
+ */
+export type UserAgentStatus = {
+  /** 软电话是否已签入 */
+  connectStatus: boolean,
+  /** 软电话是否已注册 */
+  registerStatus: boolean,
+  /** 软电话是否正拨出 */
+  invitatingStatus: boolean,
+  /** 软电话是否正来电 */
+  incomingStatus: boolean,
+  /** 软电话是否正接听 */
+  answerStatus: boolean
+  /**
+   * 软电话是否正在重连
+   * 网络断掉，服务器重启，宕机等引起服务不可达时软电话代理会尝试重新连接并签入
+   * 这个时候用户拨出等动作可以通过此状态做拦截，通知用户软电话服务器可能正重启或断网等导致服务不可用
+   * */
+  reconnectStatus: boolean
+}
+export type UserAgentDelegateKey = keyof UserAgentDelegate
+export type UserAgentStatusKey = 'connectStatus' | 'registerStatus' | 'invitatingStatus' | 'incomingStatus' | 'answerStatus'
+
+/**
+ * transport层配置
+ */
+export interface TransportOptions {
+  /** websocket协商地址, server和wsServers 必须二选一*/
+  server?: string
+  /** 多个地址开启负载均衡模式 */
+  wsServers?: string | string[] | {
+    /** websocket协商地址 */
+    ws_uri: string,
+    /** 权重 */
+    weight: number
+  }[]
+  /**
+   * websocke初始化连接等待超时时间
+   * @default 5
+   */
+  connectionTimeout?: number
+  /**
+   * transport层客户端保活最大重连尝试次数
+   * @default 3
+   */
+  maxReconnectionAttempts?: number
+  /**
+   * transport层客户端保活重连动作执行间隔时间，单位秒，同UserAgentOptionsSDK.reconnectionDelay
+   * @default 4
+   */
+  reconnectionTimeout?: number
+  /**
+   * transport层The time (Number) in seconds to wait in between CLRF keepAlive sequences are sent.
+   * @default 0
+   */
+  keepAliveInterval?: number
+  /**
+   * transport层The time (Number) in seconds to debounce sending CLRF keepAlive sequences by
+   * @default 10
+   */
+  keepAliveDebounce?: number
+  /**
+   * transport层If true, messages sent and received by the transport are logged.
+   * @default false
+   */
+  traceSip?: boolean
+}
+
+/**
+ * sip层配置
+ */
+export interface UserAgentOptionsSDK {
+  /**
+   * 通过openApi获取坐席账号分机密码
+   * @default ''
+   */
+  authorizationPassword: string,
+  /**
+   * 通过openApi获取坐席账号分机用户名
+   * @default ''
+   */
+  authorizationUsername: string,
+  /**
+   * 指纹,唯一标志,用来排查线路故障,默认随机指纹,可选
+   * @default createRandomToken(12) + ".invalid"
+   */
+  viaHost?: string,
+  /**
+   * sip服务地址,必填，需要服务可达的地址
+   * @default new URI("sip", "anonymous." + createRandomToken(6), "anonymous.invalid") })
+   */
+  uri: URI,
+  /**
+   * sip日志查看等级，一般情况下生产开error,开发用debugger
+   * @default 'log'
+   */
+  logLevel?: 'debug' | 'log' | 'warn' | 'error',
+  /**
+   * 一般设置同authorizationUsername，相当于MicroSIP的显示名称
+   * @default createRandomToken(8)
+   */
+  contactName?: string
+  /**
+   * 签入来电后多长时间不执行接听会话自动结束会话，单位秒
+   * @default 60
+   */
+  noAnswerTimeout?: number,
+  /**
+   * sip层 - 重连尝试间隔，为了兼容sipjs，同reconnectionInterval
+   * @deprecated
+   * @default 100
+   */
+  reconnectionDelay?: number,
+  /**
+   * transport层协议配置
+   */
+  transportOptions: TransportOptions,
+  /**
+   * sip层 - 重连尝试间隔，单位秒
+   * @default 100
+   */
+  reconnectionInterval?: number,
+  /**
+   * sip层 - 重连失败最大尝试次数
+   * @default
+   */
+  reconnectionAttempts?: number,
+  /**
+   * sip层 - 重连成功后尝试重新注册检间隔，单位秒
+   * @default 3
+   */
+  registerInterval?: number,
+  /**
+   * sip层 - 重连成功最大尝试注册次数
+   * @default 3
+   */
+  registerAttempts?: number
+  /**
+   * sip层 - ping动作间隔，单位秒
+   * @default 8
+   */
+  optionsPingInterval?: number
+  /**
+   * sip层 - ping最大失败尝试次数后开始重连，防止网络抖动引起非必要重连
+   * @default 3
+   */
+  optionsPingAttempts?: number
+  /**
+   * sip层 - 自定义通讯header
+   */
+  sipHeaders?: Array<string>
+  appKey?: string
+  appSecret?: string
+  agentTag?: string
+  agentId?: number
+  openBaseUrl?: string
+  sg?: '1' | '0'
+  sgOpen?: '1' | '0'
+  token: string,
+  tokenTimestamp: string | number,
+  tokenExpirationTime:  number,
+  sign: string,
+  timestamp: string | number,
+  signExpirationTime:  number,
+  signCheck?: Function
+  tokenCheck?: Function
+  signOverdued?: Function
+  tokenOverdued?: Function
+  openXhrIntercept?: Function
+  gatewayXhrIntercept?: Function
+  refreshChatErrorCallback?: Function
+  refreshSpeekVolumn?: Function
+  refreshRequirementCheck?: Function
+  refreshChat?: Function
+  enableChatInfoPush?: boolean
+  enableVolumnTrack?: boolean
+}
+
+export type UserAgentOptions = SipUserAgentOptions & UserAgentOptionsSDK
+
+export type ajaxOption = {
+  type: 'GET' | 'POST',
+  url: string,
+  data: Record<string, any>,
+  contentType: string,
+}
+
+export enum CallType {
+  '坐席-人工外呼' = 1001,
+  '坐席-AI 外呼-不转人工' = 1002,
+  '坐席-AI 外呼-接通转人工' = 1003,
+  '坐席-AI 外呼-智能转人工' = 1004,
+  '批量-预测外呼' = 2001,
+  '批量-AI 外呼-不转人工' = 2002,
+  '批量-AI 外呼-接通转人工' = 2003,
+  '批量-AI 外呼-智能转人工' = 2004,
+  '批量-语音通知' = 2005,
+}
+
+export interface PushData {
+  /**
+   * 是否停止轮询
+   */
+  stop: boolean
+  /**
+   * 任务 ID
+   */
+  taskId: string
+  /**
+   * 分机号
+   */
+  extensionNumber: string
+  /**
+   * 外呼 ID
+   */
+  callid: string
+  /**
+   * 外呼 ID
+   */
+  callId: string
+  /**
+   * 外呼类型
+   */
+  callType: CallType
+  /**
+   * 意向标签
+   */
+  intentTag: string
+  /**
+   * 外呼号码
+   */
+  number: string
+  /**
+   * 号码 ID
+   */
+  numberMD5: string
+  /**
+   * 分配坐席 ID
+   */
+  agentId: number
+  /**
+   * 坐席标签
+   */
+  agentTag: string
+  /**
+   * 用户标签
+   */
+  tag: string
+  /**
+   * AI 话术 ID
+   */
+  templateId: string
+  chats: {
+    /**
+     * 说话内容
+     */
+    "content": string,
+    /**
+     * 说话时间
+     */
+    "createTime": string,
+    /**
+     * 说话号码
+     */
+    "fromNumber": string
+  }[]
+  [index:string]:any
+}
+
+

package/src/utils/index.ts

@@ -0,0 +1,301 @@
+import {
+  Inviter,
+  SessionState,
+  UserAgent
+} from 'sip.js'
+import { ajaxOption } from '../types'
+
+/**
+ * 获取音频标签
+ * @param id Element id
+ */
+export function getMedia (id: string): HTMLAudioElement | undefined {
+  return document.getElementById(id) as HTMLAudioElement
+}
+
+/**
+ * 释放 mediaStream
+ * @param stream
+ */
+export function stopStreamTracks (stream: any) {
+  if (!stream || !stream.getTracks) {
+    return
+  }
+  try {
+    const tracks = stream.getTracks()
+    tracks.forEach((it: any) => {
+      try {
+        it.stop()
+      } catch (errMsg) {
+        // debugger;
+      }
+    })
+  } catch (errMsg) {
+    // debugger;
+  }
+}
+
+/**
+ * 获取设备权限
+ * @param constraints
+ */
+export function getDevicePermission (constraints: any) {
+  return navigator.mediaDevices
+    .getUserMedia(constraints)
+    .then(stream => {
+      if (stream) {
+        stopStreamTracks(stream)
+        return true
+      }
+      return Promise.reject(new Error('EmptyStreamError'))
+    })
+    .catch(errMsg => {
+      if (errMsg && errMsg.name === 'NotAllowedError') {
+        return false
+      }
+      return Promise.reject(errMsg)
+    })
+}
+
+/**
+ * 请求设备权限
+ */
+export function requestMicroPhonePermission () {
+  try {
+    if (navigator.userAgent.indexOf('Firefox') === -1) {
+      return getDevicePermission({ video: false, audio: true }).catch(() => true)
+    }
+  } catch (e) {
+    console.log(e)
+  }
+}
+
+/**
+ * 来电振铃
+ * @param id Element id
+ */
+export function playMedia (id: string): void {
+  const localAudioDom = getMedia(id)
+  if (localAudioDom) {
+    localAudioDom.currentTime = 0
+    localAudioDom.play()
+  }
+}
+
+/**
+ * 关闭振铃
+ * @param id Element id
+ */
+export function pauseMedia (id: string): void {
+  const localAudioDom = getMedia(id)
+  if (localAudioDom) {
+    localAudioDom.currentTime = 0
+    localAudioDom.pause()
+  }
+}
+
+/**
+ * 挂断通话
+ * @param id Element id
+ */
+export function cleanupMedia (id: string): void {
+  const mediaElement = getMedia(id)
+  if (mediaElement) {
+    mediaElement.srcObject = null
+    mediaElement.pause()
+  }
+}
+
+/**
+ * 发送
+ */
+export const onSendCall = (userAgent: InstanceType<typeof UserAgent>, target: any) => {
+  const inviter = new Inviter(userAgent, target)
+  inviter.stateChange.addListener((state) => {
+    switch (state) {
+      case SessionState.Initial:
+        break
+      case SessionState.Establishing:
+        break
+      case SessionState.Established:
+        // setupMedia(inviter);
+        break
+      case SessionState.Terminating:
+      // fall through
+      case SessionState.Terminated:
+        cleanupMedia('remoteAudio')
+        break
+      default:
+        throw new Error('Unknown session state.')
+    }
+  })
+  inviter.invite()
+}
+
+/**
+ * 获取时间字符串
+ * @param { Date }} time 需要转换的时间对象
+ * @return xx:xx:xx
+ */
+export const getTimes = (time: Date) => {
+  return time.getHours().toString().padStart(2, '0') + ':' + time.getMinutes().toString().padStart(2, '0') + ':' + time.getSeconds().toString().padStart(2, '0')
+}
+/**
+ * 获取0点时间
+ * @return Date
+ */
+export const getZeorTime = () => {
+  return new Date(new Date(new Date().toLocaleDateString()).getTime())
+}
+/**
+ * 加1s时间
+ * @param { Date } date 需要操作的时间对象
+ * @return Date
+ */
+export const accumulateSec = (date: Date) => {
+  return new Date(date.setSeconds(date.getSeconds() + 1))
+}
+
+/**
+ * 计时器
+ * @param { Function } refresh 回调
+ * @return Function 销毁计时器
+ */
+export function accumulationTimer (refresh: Function) {
+  const date = getZeorTime()
+  refresh(getTimes(date))
+  const calc = () => {
+    const addtime = accumulateSec(date)
+    const times = getTimes(addtime)
+    refresh(times)
+  }
+  let timer = setInterval(calc, 1000);
+  return () => {
+    clearInterval(timer)
+    timer = null
+  }
+}
+
+/**
+ * 转换queryParams
+ * @param url
+ */
+export function getQueryObject (location = window.location) {
+  const hashUrl = location.hash
+  const searchUrl = location.search
+  const obj:Record<string, string> = {}
+  const reg = /([^?&=]+)=([^?&=]*)/g
+  const hash = hashUrl.substring(hashUrl.indexOf('?') + 1)
+  const search = searchUrl.substring(1)
+  // @ts-ignore
+  hash.replace(reg, (rs, $1, $2) => {
+    const name = decodeURIComponent($1)
+    let val = decodeURIComponent($2)
+    val = String(val)
+    obj[name] = val
+    return rs
+  })
+  // @ts-ignore
+  search.replace(reg, (rs, $1, $2) => {
+    const name = decodeURIComponent($1)
+    let val = decodeURIComponent($2)
+    val = String(val)
+    obj[name] = val
+    return rs
+  })
+  return obj
+}
+
+export function getTop () {
+  if (getQueryObject(location).cross === '1') {
+    return window
+  }
+  return top
+}
+
+export function params(json: Record<string, string>){
+  let paramArr = []
+  for (let p in json) {
+    paramArr.push(p + '=' + json[p])
+  }
+  return paramArr.join('&')
+}
+
+export function isDomainOrIP (str: string) {
+  if (!str) {
+    return false
+  }
+  const ipPattern = /^(\d{1,3}\.){3}\d{1,3}$/
+  const domainPattern = /^[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$/
+  if (ipPattern.test(str)) {
+    return true
+  }
+  if (str.slice(0, 2) === '//') {
+    return domainPattern.test(str.slice(2, str.length))
+  }
+  if (str.slice(0, 7) === 'http://') {
+    return domainPattern.test(str.slice(7, str.length))
+  }
+  if (str.slice(0, 8) === 'https://') {
+    return domainPattern.test(str.slice(8, str.length))
+  }
+  return domainPattern.test(str)
+}
+
+export function getAjax(resolve: Function, reject: Function, param: Partial<ajaxOption>) {
+  // @ts-ignore
+  const xhr = window.XMLHttpRequest ? new window.XMLHttpRequest() : window.ActiveXObject ? new window.ActiveXObject('Microsoft.XMLHTTP') : undefined // 兼容IE6  IE5
+  if (!xhr) {
+    reject(new Error('Your Browser does not support ajax'))
+  }
+  xhr.onreadystatechange = function () {
+    // 0：请求初始化，对象刚刚创建
+    // 1：服务器已连接
+    // 2：已发送，send发放已调用
+    // 3：已接收，此时只接收了响应(response)头部分
+    // 4：已接收，此时接收响应(response)体信息
+    if (xhr.readyState == 4) { // 每当 readyState 状态值发生改变时会，就会触发 onreadystatechange 事件，对应着每个状态值就会被触发五次。当状态值为 4 时表示网络请求响应完毕，就可以获取返回的值。
+      const res = xhr.response || xhr.responseText
+      // 1XX：信息类，表示收到web浏览器请求，正在进一步处理中
+      // 2XX：成功，表示用户请求被正确接收
+      // 3XX：重定向，表示请求没成功，需要客户采取进一步的动作（304表示请求的资源未修改，可以直接使用浏览器的缓存版本）
+      // 4XX：客户端错误，表示客户端提交的请求有错误，如：404 Not Found，意味着请求中所引用的文档不存在
+      // 5XX：服务器错误，表示服务器不能完成对请求的处理
+      if (xhr.status == 200) {
+        //接收返回的数据类型
+        const type = xhr.getResponseHeader('Content-Type');
+        if (type.indexOf('json') != -1){ //json格式
+          resolve(JSON.parse(xhr.responseText))
+        } else if(type.indexOf('xml') != -1){ //xml格式
+          resolve(xhr.responseXML);
+        } else{
+          resolve(xhr.responseText); //普通格式
+        }
+      } else {
+        reject(res)
+      }
+    }
+  }
+  const {
+    url,
+    data,
+    type,
+    contentType,
+  } = param
+  const ajaxType = type || 'POST' //判断data是否为空
+  let ajaxUrl = url
+  let ajaxData = null
+  if (data) {
+    if(ajaxType === 'GET'){
+      ajaxUrl = ajaxUrl + '?'+ params(data);
+    } else if (ajaxType === 'POST') {
+      ajaxData = JSON.stringify(data)
+    }
+  }
+  xhr.open(ajaxType, ajaxUrl, true)
+  return {
+    xhr,
+    ajaxData,
+    contentType
+  }
+}