Skip to content

webPhone.on('inboundCall', callback)

When the inboundCall event is triggered, you will receive as input an inbound call session. You may invoke any number of call session methods as well as a few others listed below.

Sample

webPhone.on("inboundCall", (inboundCall: InboundCallSession) => {
  // do something with the inbound call
});

Properties

Property Description
sipMessage The message that triggered the event. You do not typically need to access this property directly.
localPeer The user's device and connection.
remotePeer The remote user's device and connection.
direction Always equal to "inbound."
state The current state of the call. Either: init, ringing, answered, or disposed

Methods

Method Description
callId() The current call ID.
sessionId() The telephony session ID.
partyId() The ID of the remote party.
remoteNumber() The remote number connected to.
localNumber() The local number.
isConference() Boolean. true if the current call is a conference call.