anchorSign in and Out of Phone Services

Applications can disconnect from Webex calling phone services, enabling users to cease making and receiving calls while continuing to use other features, such as messaging and meetings.

Sign in to Phone Services

To sign in to phone services:

webex.phone.connectPhoneServices{ result ->
    if (result.isSuccessful) {
        // Connecting to phone services succeeded
    } else {
        // Connecting to phone services failed
    }
}

Sign out of phone services

To sign out of phone services:

webex.phone.disconnectPhoneServices{ result ->
    if (result.isSuccessful) {
        // Disconnecting from phone services succeeded
    } else {
        // Disconnecting from phone services failed
    }
}

anchorGet the Calling Type of a User

The SDK supports various calling types, such as CUCM and WebexCalling. A user is associated with one calling type at most. Use webex.phone.getCallingType() method to check the user's calling type:

if(webex.phone.getCallingType() == Phone.CallingType.WebexCalling){
    // Indicates Webex Calling is supported for the signed in user.
}

anchorGet an External Tracking ID

For logging and tracking metrics, use call.getExternalTrackingId() to retrieve a tracking ID. This is available in the onInfoChanged callback in CallObserver.

call.getExternalTrackingId()
// Use the trackingId after the onInfoChanged callback has fired.

anchorVideo Enabled in Control Hub

The isVideoEnabled() method determines whether video calling is enabled for a user in the Control Hub, affecting the availability of local and remote video features for calls. It is applicable to Locus, CUCM, WebexCalling, and WebexForBroadworks calls only. This setting does not influence video availability for meetings. Available since v3.9.0:

webex.phone.call.isVideoEnabled()
// Returns true if video is enabled for the user in Control Hub or false if not.

anchorBandwidth Extension / Speech Enhancement

The Bandwidth Extension Support feature allows developers to enhance receiver-side audio quality during WebexCalling and CUCM calls. These APIs are available from SDK v3.14 onwards.

Phone-Level APIs (Before a Call)

Use these APIs before making a call.

Enable Legacy Receiver Noise Removal

// Enable legacy receiver noise removal
webex.phone.useLegacyReceiverNoiseRemoval(true)

// Disable legacy receiver noise removal to use new speech enhancement
webex.phone.useLegacyReceiverNoiseRemoval(false)

Check if Speech Enhancement Is Enabled by Default

// Check if speech enhancement is enabled by default
var isEnabled = webex.phone.isReceiverSpeechEnhancementEnabled()

Enable/Disable Speech Enhancement by Default

// Enable speech enhancement by default for all calls
webex.phone.enableReceiverSpeechEnhancement(true) {
    if (it.isSuccessful) {
        // Speech Enhancement was successfully set
    } else {
        // Handle error
    }
}

// Disable speech enhancement by default for all calls
webex.phone.enableReceiverSpeechEnhancement(false) {
    if (it.isSuccessful) {
        // Speech Enhancement was successfully set
    } else {
        // Handle error
    }
}

Call-Level APIs (During a Call)

Use these APIs while in an active call.

Check if Speech Enhancement Is Enabled for the Current Call

// Check if speech enhancement is enabled for the current call
var isEnabled = call.isReceiverSpeechEnhancementEnabled

Enable/Disable Speech Enhancement for the Current Call

// Enable speech enhancement for the current call
call.enableReceiverSpeechEnhancement(true) {
    if (it.isSuccessful) {
        // Speech Enhancement was successfully set
    } else {
        // Handle error
    }
}

// Disable speech enhancement for the current call
call.enableReceiverSpeechEnhancement(false) {
    if (it.isSuccessful) {
        // Speech Enhancement was successfully set
    } else {
        // Handle error
    }
}