Class RingCentralSoftphoneHandle

constructor

• new RingCentralSoftphoneHandle(
      client: SoftphoneClient,
      rtp: RtpConstructors,
  ): RingCentralSoftphoneHandle

  Parameters

  • client: SoftphoneClient

    The live softphone (constructed from SIP creds; the only object touching the real SDK).

  • rtp: RtpConstructors

    The werift-rtp constructors the outbound RTP sender needs.

  Returns RingCentralSoftphoneHandle

Readonlyrtp

answerCall

• answerCall(callId: string): Promise<SoftphoneCallSession>

  Parameters

  • callId: string

  Returns Promise<SoftphoneCallSession>

  Inherit Doc: —

  answers the INVITE parked under callId; throws if none is parked (stale/unknown call).

declineCall

• declineCall(callId: string): Promise<void>

  Declines + forgets a parked INVITE (no agent resolved for the DID). Safe for an unknown call id.

  Parameters

  • callId: string

  Returns Promise<void>

dispose

• dispose(): void

  Best-effort teardown of the registration + parked state (server shutdown).

  Returns void

onInvite

• onInvite(listener: (info: InboundInviteInfo) => void): void

  Subscribes a listener to inbound INVITEs (the coordinator).

  Parameters

  • listener: (info: InboundInviteInfo) => void

  Returns void

placeCall

• placeCall(toNumber: string): Promise<SoftphoneCallSession>

  Places an OUTBOUND call (the caller-id is fixed by the registration; toNumber is the destination).

  Parameters

  • toNumber: string

  Returns Promise<SoftphoneCallSession>

register

• register(): Promise<void>

  REGISTERs the SIP device so the softphone can place + receive calls. Called once at boot.

  Returns Promise<void>