Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RtcSession

通过 ua.on('newRTCSession') 事件反馈，获取该实例对象

Hierarchy

  • RtcSession

Index

Properties

Methods

Properties

callee

callee: string

该通会话的被叫号码

//实例代码

ua.on('newRTCSession', ({session}) => {
  conosole.log('该session的被叫是: ', session.callee)
})

caller

caller: string

该通会话的主叫号码

//实例代码

ua.on('newRTCSession', ({session}) => {
  conosole.log('该session的主叫是: ', session.caller)
})

didNumber

didNumber: string

获取通话设置的企业购买的中继号码

direction

direction: "outgoing" | "incoming"

通话方向 ['outgoing' | 'incoming'] incoming 呼入 outgoing 呼出

originator

originator: "local" | "remote"

通话来源 ['remote' | 'local'] remote 呼入 local 呼出

receiverRole

receiverRole: 0 | 1

接收者角色 [0 | 1] 0主叫 1被叫

screenPopUp

screenPopUp: boolean

该通会话是否需要页面振铃

sessionId

sessionId: string

该通会话的唯一标识（即服务端的callId），云呼叫流程的全链路跟踪标识ID，用户反馈问题时，建议提供该值

state

state: sessionStateType

获取会话的状态

Methods

accept

  • 接听对端呼叫

    Returns Promise<void | BaseError>

    如果该方法执行失败，sdk会返回BaseError对象

bye

  • 挂断对端呼叫

    Returns Promise<void | BaseError>

    如果该方法执行失败，sdk会返回BaseError对象

destroy

  • destroy(): void

  • 销毁实例

    Returns void

hold

  • hold对端

    Returns Promise<void | BaseError>

    如果该方法执行失败，sdk会返回BaseError对象

isEnded

  • isEnded(): boolean

  • 判断会话是否已结束

    Returns boolean

isEstablished

  • isEstablished(): boolean

  • 判断会话是否已接通

    Returns boolean

isMuted

  • isMuted(): boolean

  • 判断当前是否mute

    Returns boolean

isOnHold

  • isOnHold(): boolean

  • 获取当前是否hold

    Returns boolean

mute

  • mute自己的音频

    Returns Promise<void | BaseError>

    如果该方法执行失败，sdk会返回BaseError对象

on

  • on(event: "accepted", callback: (evt: { callee: string; caller: string; originator: "local" | "remote" }) => void): void
  • on(event: "ended", callback: (evt: { callee: string; caller: string; cause: number; originator: "local" | "remote" }) => void): void
  • on(event: "failed", callback: (evt: { callee: string; caller: string; cause: null | BaseError; originator: "local" | "remote" }) => void): void
  • on(event: "jitterbuffer", callback: (evt: { jitterbuffer: number }) => void): void

  • 外呼时，收到对端的应答通知

    Parameters

    • event: "accepted"
    • callback: (evt: { callee: string; caller: string; originator: "local" | "remote" }) => void
        • (evt: { callee: string; caller: string; originator: "local" | "remote" }): void

        • Parameters

          • evt: { callee: string; caller: string; originator: "local" | "remote" }
            • callee: string

              被叫号码。自己呼叫别人，则是自己要呼叫的号码；别人呼叫自己，则是自己的account

            • caller: string

              主叫号码。自己呼叫别人，则是自己的account；别人呼叫自己，则是对端的号码

            • originator: "local" | "remote"

              通话来源 ['remote' | 'local'] remote 呼入 local 呼出

          Returns void

    Returns void

  • 建立的会话结束时的触发

    Parameters

    • event: "ended"
    • callback: (evt: { callee: string; caller: string; cause: number; originator: "local" | "remote" }) => void
        • (evt: { callee: string; caller: string; cause: number; originator: "local" | "remote" }): void

        • Parameters

          • evt: { callee: string; caller: string; cause: number; originator: "local" | "remote" }
            • callee: string

              被叫号码。自己呼叫别人，则是自己要呼叫的号码；别人呼叫自己，则是自己的account

            • caller: string

              主叫号码。自己呼叫别人，则是自己的account；别人呼叫自己，则是对端的号码

            • cause: number

              失败的原因

            • originator: "local" | "remote"

              通话来源 ['remote' | 'local'] remote 呼入 local 呼出

          Returns void

    Returns void

  • 当前会话无法建立时触发

    Parameters

    • event: "failed"
    • callback: (evt: { callee: string; caller: string; cause: null | BaseError; originator: "local" | "remote" }) => void
        • (evt: { callee: string; caller: string; cause: null | BaseError; originator: "local" | "remote" }): void

        • Parameters

          • evt: { callee: string; caller: string; cause: null | BaseError; originator: "local" | "remote" }
            • callee: string

              被叫号码。自己呼叫别人，则是自己要呼叫的号码；别人呼叫自己，则是自己的account

            • caller: string

              主叫号码。自己呼叫别人，则是自己的account；别人呼叫自己，则是对端的号码

            • cause: null | BaseError

              值为null，表示对端拒绝了你的呼叫；不为null，表示通话建立过程中发生了错误

            • originator: "local" | "remote"

              通话来源 ['remote' | 'local'] remote 呼入 local 呼出

          Returns void

    Returns void

  • 反馈当前网络延迟情况

    Parameters

    • event: "jitterbuffer"
    • callback: (evt: { jitterbuffer: number }) => void
        • (evt: { jitterbuffer: number }): void

        • Parameters

          • evt: { jitterbuffer: number }
            • jitterbuffer: number

              网络延时时间； 单位 ms

          Returns void

    Returns void

sendDTMF

  • sendDTMF(tone: string | number, option?: any): Promise<void | BaseError>

  • 发送拨号盘数字

    Parameters

    • tone: string | number

      要发送的数值

    • Optional option: any

      扩展

    Returns Promise<void | BaseError>

    如果该方法执行失败，sdk会返回BaseError对象

unhold

  • 取消hold对端

    Returns Promise<void | BaseError>

    如果该方法执行失败，sdk会返回BaseError对象

unmute

  • 取消mute自己的音频

    Returns Promise<void | BaseError>

    如果该方法执行失败，sdk会返回BaseError对象