Skip to content

Most visited

Recently visited

navigation

TelecomManager

public class TelecomManager
extends Object

java.lang.Object
   ↳ android.telecom.TelecomManager


Provides access to information about active calls and registration/call-management functionality. Apps can use methods in this class to determine the current call state.

Apps do not instantiate this class directly; instead, they retrieve a reference to an instance through Context.getSystemService(Context.TELECOM_SERVICE).

Note that access to some telecom information is permission-protected. Your app cannot access the protected information or gain access to protected functionality unless it has the appropriate permissions declared in its manifest file. Where permissions apply, they are noted in the method descriptions.

Summary

Constants

String ACTION_CHANGE_DEFAULT_DIALER

Activity action: Shows a dialog asking the user whether or not they want to replace the current default Dialer with the one specified in EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME.

String ACTION_CHANGE_PHONE_ACCOUNTS

The Intent action used to show the settings page used to configure PhoneAccount preferences.

String ACTION_CONFIGURE_PHONE_ACCOUNT

An Intent action sent by the telecom framework to start a configuration dialog for a registered PhoneAccount.

String ACTION_DEFAULT_DIALER_CHANGED

Broadcast intent action indicating that the current default dialer has changed.

String ACTION_INCOMING_CALL

This constant was deprecated in API level O. Use addNewIncomingCall(PhoneAccountHandle, Bundle) instead.

String ACTION_SHOW_CALL_ACCESSIBILITY_SETTINGS

The Intent action used to show the call accessibility settings page.

String ACTION_SHOW_CALL_SETTINGS

The Intent action used to show the call settings page.

String ACTION_SHOW_MISSED_CALLS_NOTIFICATION

Broadcast intent action for letting custom component know to show the missed call notification.

String ACTION_SHOW_RESPOND_VIA_SMS_SETTINGS

The Intent action used to show the respond via SMS settings page.

char DTMF_CHARACTER_PAUSE

The dual tone multi-frequency signaling character sent to indicate the dialing system should pause for a predefined period.

char DTMF_CHARACTER_WAIT

The dual-tone multi-frequency signaling character sent to indicate the dialing system should wait for user confirmation before proceeding.

String EXTRA_CALL_BACK_NUMBER

The number which the party on the other side of the line will see (and use to return the call).

String EXTRA_CALL_DISCONNECT_CAUSE

Optional extra for ACTION_PHONE_STATE_CHANGED containing the disconnect code.

String EXTRA_CALL_DISCONNECT_MESSAGE

Optional extra for ACTION_PHONE_STATE_CHANGED containing the disconnect message.

String EXTRA_CALL_SUBJECT

Optional extra for ACTION_CALL containing a string call subject which will be associated with an outgoing call.

String EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME

Extra value used to provide the package name for ACTION_CHANGE_DEFAULT_DIALER.

String EXTRA_INCOMING_CALL_ADDRESS

The extra used by a ConnectionService to provide the handle of the caller that has initiated a new incoming call.

String EXTRA_INCOMING_CALL_EXTRAS

Optional extra for ACTION_INCOMING_CALL containing a Bundle which contains metadata about the call.

String EXTRA_NOTIFICATION_COUNT

The number of calls associated with the notification.

String EXTRA_NOTIFICATION_PHONE_NUMBER

The number associated with the missed calls.

String EXTRA_OUTGOING_CALL_EXTRAS

Optional extra for ACTION_CALL and ACTION_DIAL Intent containing a Bundle which contains metadata about the call.

String EXTRA_PHONE_ACCOUNT_HANDLE

The extra used with an ACTION_CALL and ACTION_DIAL Intent to specify a PhoneAccountHandle to use when making the call.

String EXTRA_START_CALL_WITH_RTT

A boolean extra, which when set on the ACTION_CALL intent or on the bundle passed into placeCall(Uri, Bundle), indicates that the call should be initiated with an RTT session open.

String EXTRA_START_CALL_WITH_SPEAKERPHONE

Optional extra for ACTION_CALL containing a boolean that determines whether the speakerphone should be automatically turned on for an outgoing call.

String EXTRA_START_CALL_WITH_VIDEO_STATE

Optional extra for ACTION_CALL containing an integer that determines the desired video state for an outgoing call.

String GATEWAY_ORIGINAL_ADDRESS

An optional ACTION_CALL intent extra corresponding to the original address to dial for the call.

String GATEWAY_PROVIDER_PACKAGE

An optional ACTION_CALL intent extra denoting the package name of the app specifying an alternative gateway for the call.

String METADATA_INCLUDE_EXTERNAL_CALLS

A boolean meta-data value indicating whether an InCallService wants to be informed of calls which have the PROPERTY_IS_EXTERNAL_CALL property.

String METADATA_IN_CALL_SERVICE_RINGING

A boolean meta-data value indicating whether an InCallService implements ringing.

String METADATA_IN_CALL_SERVICE_UI

A boolean meta-data value indicating whether an InCallService implements an in-call user interface.

int PRESENTATION_ALLOWED

Indicates that the address or number of a call is allowed to be displayed for caller ID.

int PRESENTATION_PAYPHONE

Indicates that the address or number of a call belongs to a pay phone.

int PRESENTATION_RESTRICTED

Indicates that the address or number of a call is blocked by the other party.

int PRESENTATION_UNKNOWN

Indicates that the address or number of a call is not specified or known by the carrier.

Public methods

void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras)

Registers a new incoming call.

void cancelMissedCallsNotification()

Removes the missed-call notification if one is present.

Intent createManageBlockedNumbersIntent()

Creates the Intent which can be used with startActivity(Intent) to launch the activity to manage blocked numbers.

Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle)

Requires permission: MODIFY_PHONE_STATE

List<PhoneAccountHandle> getCallCapablePhoneAccounts()

Returns a list of PhoneAccountHandles which can be used to make and receive phone calls.

String getDefaultDialerPackage()

Used to determine the currently selected default dialer package.

PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme)

Return the PhoneAccount which will be used to place outgoing calls to addresses with the specified uriScheme.

String getLine1Number(PhoneAccountHandle accountHandle)

Return the line 1 phone number for given phone account.

PhoneAccount getPhoneAccount(PhoneAccountHandle account)

Return the PhoneAccount for a specified PhoneAccountHandle.

PhoneAccountHandle getSimCallManager()

Returns the current SIM call manager.

String getVoiceMailNumber(PhoneAccountHandle accountHandle)

Return the voicemail number for a given phone account.

boolean handleMmi(String dialString)

Processes the specified dial string as an MMI code.

boolean handleMmi(String dialString, PhoneAccountHandle accountHandle)

Processes the specified dial string as an MMI code.

boolean isInCall()

Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding states).

boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle)

Determines whether Telecom would permit an incoming call to be added via the addNewIncomingCall(PhoneAccountHandle, Bundle) API for the specified PhoneAccountHandle.

boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle)

Determines whether Telecom would permit an outgoing call to be placed via the placeCall(Uri, Bundle) API for the specified PhoneAccountHandle.

boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number)

Return whether a given phone number is the configured voicemail number for a particular phone account.

void placeCall(Uri address, Bundle extras)

Places a new outgoing call to the provided address using the system telecom service with the specified extras.

void registerPhoneAccount(PhoneAccount account)

Register a PhoneAccount for use by the system that will be stored in Device Encrypted storage.

void showInCallScreen(boolean showDialpad)

Brings the in-call screen to the foreground if there is an ongoing call.

void silenceRinger()

Silences the ringer if a ringing call exists.

void unregisterPhoneAccount(PhoneAccountHandle accountHandle)

Remove a PhoneAccount registration from the system.

Inherited methods

From class java.lang.Object

Constants

ACTION_CHANGE_DEFAULT_DIALER

added in API level 23
String ACTION_CHANGE_DEFAULT_DIALER

Activity action: Shows a dialog asking the user whether or not they want to replace the current default Dialer with the one specified in EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME. Usage example:

 Intent intent = new Intent(TelecomManager.ACTION_CHANGE_DEFAULT_DIALER);
 intent.putExtra(TelecomManager.EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME,
         getActivity().getPackageName());
 startActivity(intent);
 

Constant Value: "android.telecom.action.CHANGE_DEFAULT_DIALER"

ACTION_CHANGE_PHONE_ACCOUNTS

added in API level 23
String ACTION_CHANGE_PHONE_ACCOUNTS

The Intent action used to show the settings page used to configure PhoneAccount preferences.

Constant Value: "android.telecom.action.CHANGE_PHONE_ACCOUNTS"

ACTION_CONFIGURE_PHONE_ACCOUNT

added in API level 23
String ACTION_CONFIGURE_PHONE_ACCOUNT

An Intent action sent by the telecom framework to start a configuration dialog for a registered PhoneAccount. There is no default dialog and each app that registers a PhoneAccount should provide one if desired.

A user can access the list of enabled PhoneAccounts through the Phone app's settings menu. For each entry, the settings app will add a click action. When triggered, the click-action will start this intent along with the extra EXTRA_PHONE_ACCOUNT_HANDLE to indicate the PhoneAccount to configure. If the PhoneAccount package does not register an Activity for this intent, then it will not be sent.

Constant Value: "android.telecom.action.CONFIGURE_PHONE_ACCOUNT"

ACTION_DEFAULT_DIALER_CHANGED

added in API level 23
String ACTION_DEFAULT_DIALER_CHANGED

Broadcast intent action indicating that the current default dialer has changed. The string extra EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME will contain the name of the package that the default dialer was changed to.

See also:

Constant Value: "android.telecom.action.DEFAULT_DIALER_CHANGED"

ACTION_INCOMING_CALL

added in API level 23
String ACTION_INCOMING_CALL

This constant was deprecated in API level O.
Use addNewIncomingCall(PhoneAccountHandle, Bundle) instead.

Activity action: Starts the UI for handing an incoming call. This intent starts the in-call UI by notifying the Telecom system that an incoming call exists for a specific call service (see ConnectionService). Telecom reads the Intent extras to find and bind to the appropriate ConnectionService which Telecom will ultimately use to control and get information about the call.

Input: get*Extra field EXTRA_PHONE_ACCOUNT_HANDLE contains the component name of the ConnectionService that Telecom should bind to. Telecom will then ask the connection service for more information about the call prior to showing any UI.

Constant Value: "android.telecom.action.INCOMING_CALL"

ACTION_SHOW_CALL_ACCESSIBILITY_SETTINGS

added in API level 23
String ACTION_SHOW_CALL_ACCESSIBILITY_SETTINGS

The Intent action used to show the call accessibility settings page.

Constant Value: "android.telecom.action.SHOW_CALL_ACCESSIBILITY_SETTINGS"

ACTION_SHOW_CALL_SETTINGS

added in API level 21
String ACTION_SHOW_CALL_SETTINGS

The Intent action used to show the call settings page.

Constant Value: "android.telecom.action.SHOW_CALL_SETTINGS"

ACTION_SHOW_MISSED_CALLS_NOTIFICATION

added in API level 24
String ACTION_SHOW_MISSED_CALLS_NOTIFICATION

Broadcast intent action for letting custom component know to show the missed call notification. If no custom component exists then this is sent to the default dialer which should post a missed-call notification.

Constant Value: "android.telecom.action.SHOW_MISSED_CALLS_NOTIFICATION"

ACTION_SHOW_RESPOND_VIA_SMS_SETTINGS

added in API level 23
String ACTION_SHOW_RESPOND_VIA_SMS_SETTINGS

The Intent action used to show the respond via SMS settings page.

Constant Value: "android.telecom.action.SHOW_RESPOND_VIA_SMS_SETTINGS"

DTMF_CHARACTER_PAUSE

added in API level 21
char DTMF_CHARACTER_PAUSE

The dual tone multi-frequency signaling character sent to indicate the dialing system should pause for a predefined period.

Constant Value: 44 (0x0000002c)

DTMF_CHARACTER_WAIT

added in API level 21
char DTMF_CHARACTER_WAIT

The dual-tone multi-frequency signaling character sent to indicate the dialing system should wait for user confirmation before proceeding.

Constant Value: 59 (0x0000003b)

EXTRA_CALL_BACK_NUMBER

added in API level 23
String EXTRA_CALL_BACK_NUMBER

The number which the party on the other side of the line will see (and use to return the call).

ConnectionServices which interact with RemoteConnections should only populate this if the getLine1Number() value, as that is the user's expected caller ID.

Constant Value: "android.telecom.extra.CALL_BACK_NUMBER"

EXTRA_CALL_DISCONNECT_CAUSE

added in API level 21
String EXTRA_CALL_DISCONNECT_CAUSE

Optional extra for ACTION_PHONE_STATE_CHANGED containing the disconnect code.

Constant Value: "android.telecom.extra.CALL_DISCONNECT_CAUSE"

EXTRA_CALL_DISCONNECT_MESSAGE

added in API level 21
String EXTRA_CALL_DISCONNECT_MESSAGE

Optional extra for ACTION_PHONE_STATE_CHANGED containing the disconnect message.

Constant Value: "android.telecom.extra.CALL_DISCONNECT_MESSAGE"

EXTRA_CALL_SUBJECT

added in API level 23
String EXTRA_CALL_SUBJECT

Optional extra for ACTION_CALL containing a string call subject which will be associated with an outgoing call. Should only be specified if the PhoneAccount supports the capability CAPABILITY_CALL_SUBJECT.

Constant Value: "android.telecom.extra.CALL_SUBJECT"

EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME

added in API level 23
String EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME

Extra value used to provide the package name for ACTION_CHANGE_DEFAULT_DIALER.

Constant Value: "android.telecom.extra.CHANGE_DEFAULT_DIALER_PACKAGE_NAME"

EXTRA_INCOMING_CALL_ADDRESS

added in API level 23
String EXTRA_INCOMING_CALL_ADDRESS

The extra used by a ConnectionService to provide the handle of the caller that has initiated a new incoming call.

Constant Value: "android.telecom.extra.INCOMING_CALL_ADDRESS"

EXTRA_INCOMING_CALL_EXTRAS

added in API level 23
String EXTRA_INCOMING_CALL_EXTRAS

Optional extra for ACTION_INCOMING_CALL containing a Bundle which contains metadata about the call. This Bundle will be returned to the ConnectionService.

Constant Value: "android.telecom.extra.INCOMING_CALL_EXTRAS"

EXTRA_NOTIFICATION_COUNT

added in API level 24
String EXTRA_NOTIFICATION_COUNT

The number of calls associated with the notification. If the number is zero then the missed call notification should be dismissed.

Constant Value: "android.telecom.extra.NOTIFICATION_COUNT"

EXTRA_NOTIFICATION_PHONE_NUMBER

added in API level 24
String EXTRA_NOTIFICATION_PHONE_NUMBER

The number associated with the missed calls. This number is only relevant when EXTRA_NOTIFICATION_COUNT is 1.

Constant Value: "android.telecom.extra.NOTIFICATION_PHONE_NUMBER"

EXTRA_OUTGOING_CALL_EXTRAS

added in API level 23
String EXTRA_OUTGOING_CALL_EXTRAS

Optional extra for ACTION_CALL and ACTION_DIAL Intent containing a Bundle which contains metadata about the call. This Bundle will be saved into Call.Details and passed to the ConnectionService when placing the call.

Constant Value: "android.telecom.extra.OUTGOING_CALL_EXTRAS"

EXTRA_PHONE_ACCOUNT_HANDLE

added in API level 23
String EXTRA_PHONE_ACCOUNT_HANDLE

The extra used with an ACTION_CALL and ACTION_DIAL Intent to specify a PhoneAccountHandle to use when making the call.

Retrieve with getParcelableExtra(String).

Constant Value: "android.telecom.extra.PHONE_ACCOUNT_HANDLE"

EXTRA_START_CALL_WITH_RTT

String EXTRA_START_CALL_WITH_RTT

A boolean extra, which when set on the ACTION_CALL intent or on the bundle passed into placeCall(Uri, Bundle), indicates that the call should be initiated with an RTT session open. See Call.RttCall for more information on RTT.

Constant Value: "android.telecom.extra.START_CALL_WITH_RTT"

EXTRA_START_CALL_WITH_SPEAKERPHONE

added in API level 21
String EXTRA_START_CALL_WITH_SPEAKERPHONE

Optional extra for ACTION_CALL containing a boolean that determines whether the speakerphone should be automatically turned on for an outgoing call.

Constant Value: "android.telecom.extra.START_CALL_WITH_SPEAKERPHONE"

EXTRA_START_CALL_WITH_VIDEO_STATE

added in API level 23
String EXTRA_START_CALL_WITH_VIDEO_STATE

Optional extra for ACTION_CALL containing an integer that determines the desired video state for an outgoing call. Valid options: STATE_AUDIO_ONLY, STATE_BIDIRECTIONAL, STATE_RX_ENABLED, STATE_TX_ENABLED.

Constant Value: "android.telecom.extra.START_CALL_WITH_VIDEO_STATE"

GATEWAY_ORIGINAL_ADDRESS

added in API level 21
String GATEWAY_ORIGINAL_ADDRESS

An optional ACTION_CALL intent extra corresponding to the original address to dial for the call. This is used when an alternative gateway address is provided to recall the original address. The value is a Uri. (See GATEWAY_PROVIDER_PACKAGE for details)

Constant Value: "android.telecom.extra.GATEWAY_ORIGINAL_ADDRESS"

GATEWAY_PROVIDER_PACKAGE

added in API level 21
String GATEWAY_PROVIDER_PACKAGE

An optional ACTION_CALL intent extra denoting the package name of the app specifying an alternative gateway for the call. The value is a string. (The following comment corresponds to the all GATEWAY_* extras) An app which sends the ACTION_CALL intent can specify an alternative address to dial which is different from the one specified and displayed to the user. This alternative address is referred to as the gateway address.

Constant Value: "android.telecom.extra.GATEWAY_PROVIDER_PACKAGE"

METADATA_INCLUDE_EXTERNAL_CALLS

added in API level 25
String METADATA_INCLUDE_EXTERNAL_CALLS

A boolean meta-data value indicating whether an InCallService wants to be informed of calls which have the PROPERTY_IS_EXTERNAL_CALL property. An external call is one which a ConnectionService knows about, but is not connected to directly. Dialer implementations (see getDefaultDialerPackage()) which would like to be informed of external calls should set this meta-data to true in the manifest registration of their InCallService. By default, the InCallService will NOT be informed of external calls.

Constant Value: "android.telecom.INCLUDE_EXTERNAL_CALLS"

METADATA_IN_CALL_SERVICE_RINGING

added in API level 24
String METADATA_IN_CALL_SERVICE_RINGING

A boolean meta-data value indicating whether an InCallService implements ringing. Dialer implementations (see getDefaultDialerPackage()) which would also like to override the system provided ringing should set this meta-data to true in the manifest registration of their InCallService.

Constant Value: "android.telecom.IN_CALL_SERVICE_RINGING"

METADATA_IN_CALL_SERVICE_UI

added in API level 23
String METADATA_IN_CALL_SERVICE_UI

A boolean meta-data value indicating whether an InCallService implements an in-call user interface. Dialer implementations (see getDefaultDialerPackage()) which would also like to replace the in-call interface should set this meta-data to true in the manifest registration of their InCallService.

Constant Value: "android.telecom.IN_CALL_SERVICE_UI"

PRESENTATION_ALLOWED

added in API level 21
int PRESENTATION_ALLOWED

Indicates that the address or number of a call is allowed to be displayed for caller ID.

Constant Value: 1 (0x00000001)

PRESENTATION_PAYPHONE

added in API level 21
int PRESENTATION_PAYPHONE

Indicates that the address or number of a call belongs to a pay phone.

Constant Value: 4 (0x00000004)

PRESENTATION_RESTRICTED

added in API level 21
int PRESENTATION_RESTRICTED

Indicates that the address or number of a call is blocked by the other party.

Constant Value: 2 (0x00000002)

PRESENTATION_UNKNOWN

added in API level 21
int PRESENTATION_UNKNOWN

Indicates that the address or number of a call is not specified or known by the carrier.

Constant Value: 3 (0x00000003)

Public methods

addNewIncomingCall

added in API level 23
void addNewIncomingCall (PhoneAccountHandle phoneAccount, 
                Bundle extras)

Registers a new incoming call. A ConnectionService should invoke this method when it has an incoming call. For managed ConnectionServices, the specified PhoneAccountHandle must have been registered with registerPhoneAccount(PhoneAccount) and the user must have enabled the corresponding PhoneAccount. This can be checked using getPhoneAccount(PhoneAccountHandle). Self-managed ConnectionServices must have MANAGE_OWN_CALLS to add a new incoming call.

Once invoked, this method will cause the system to bind to the ConnectionService associated with the PhoneAccountHandle and request additional information about the call (See onCreateIncomingConnection(PhoneAccountHandle, ConnectionRequest)) before starting the incoming call UI.

For a managed ConnectionService, a SecurityException will be thrown if either the PhoneAccountHandle does not correspond to a registered PhoneAccount or the associated PhoneAccount is not currently enabled by the user.

For a self-managed ConnectionService, a SecurityException will be thrown if the PhoneAccount has CAPABILITY_SELF_MANAGED and the calling app does not have MANAGE_OWN_CALLS.

Parameters
phoneAccount PhoneAccountHandle: A PhoneAccountHandle registered with registerPhoneAccount(PhoneAccount).
extras Bundle: A bundle that will be passed through to onCreateIncomingConnection(PhoneAccountHandle, ConnectionRequest).

cancelMissedCallsNotification

added in API level 21
void cancelMissedCallsNotification ()

Removes the missed-call notification if one is present.

Requires that the method-caller be set as the system dialer app.

Requires permission: MODIFY_PHONE_STATE

createManageBlockedNumbersIntent

added in API level 24
Intent createManageBlockedNumbersIntent ()

Creates the Intent which can be used with startActivity(Intent) to launch the activity to manage blocked numbers.

The activity will display the UI to manage blocked numbers only if canCurrentUserBlockNumbers(Context) returns true for the current user.

Returns
Intent

getAdnUriForPhoneAccount

added in API level 23
Uri getAdnUriForPhoneAccount (PhoneAccountHandle accountHandle)

Requires permission: MODIFY_PHONE_STATE

Parameters
accountHandle PhoneAccountHandle: The handle for the account to derive an adn query URI for or null to return a URI which will use the default account.
Returns
Uri The URI (with the content:// scheme) specific to the specified PhoneAccount for the the content retrieve.

getCallCapablePhoneAccounts

added in API level 23
List<PhoneAccountHandle> getCallCapablePhoneAccounts ()

Returns a list of PhoneAccountHandles which can be used to make and receive phone calls. The returned list includes only those accounts which have been explicitly enabled by the user. Requires permission: READ_PHONE_STATE

Returns
List<PhoneAccountHandle> A list of PhoneAccountHandle objects.

See also:

getDefaultDialerPackage

added in API level 23
String getDefaultDialerPackage ()

Used to determine the currently selected default dialer package.

Returns
String package name for the default dialer package or null if no package has been selected as the default dialer.

getDefaultOutgoingPhoneAccount

added in API level 23
PhoneAccountHandle getDefaultOutgoingPhoneAccount (String uriScheme)

Return the PhoneAccount which will be used to place outgoing calls to addresses with the specified uriScheme. This PhoneAccount will always be a member of the list which is returned from invoking getCallCapablePhoneAccounts(). The specific account returned depends on the following priorities:

  • If the user-selected default PhoneAccount supports the specified scheme, it will be returned.
  • If there exists only one PhoneAccount that supports the specified scheme, it will be returned.

If no PhoneAccount fits the criteria above, this method will return null. Requires permission: READ_PHONE_STATE

Parameters
uriScheme String: The URI scheme.
Returns
PhoneAccountHandle The PhoneAccountHandle corresponding to the account to be used.

getLine1Number

added in API level 23
String getLine1Number (PhoneAccountHandle accountHandle)

Return the line 1 phone number for given phone account. Requires permission: READ_PHONE_STATE

Parameters
accountHandle PhoneAccountHandle: The handle for the account retrieve a number for.
Returns
String A string representation of the line 1 phone number.

getPhoneAccount

added in API level 23
PhoneAccount getPhoneAccount (PhoneAccountHandle account)

Return the PhoneAccount for a specified PhoneAccountHandle. Object includes resources which can be used in a user interface.

Parameters
account PhoneAccountHandle: The PhoneAccountHandle.
Returns
PhoneAccount The PhoneAccount object.

getSimCallManager

added in API level 23
PhoneAccountHandle getSimCallManager ()

Returns the current SIM call manager. Apps must be prepared for this method to return null, indicating that there currently exists no user-chosen default PhoneAccount.

Returns
PhoneAccountHandle The phone account handle of the current sim call manager.

getVoiceMailNumber

added in API level 23
String getVoiceMailNumber (PhoneAccountHandle accountHandle)

Return the voicemail number for a given phone account. Requires permission: READ_PHONE_STATE

Parameters
accountHandle PhoneAccountHandle: The handle for the phone account.
Returns
String The voicemail number for the phone account, and null if one has not been configured.

handleMmi

added in API level 21
boolean handleMmi (String dialString)

Processes the specified dial string as an MMI code. MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#". Some of these sequences launch special behavior through handled by Telephony. This method uses the default subscription.

Requires that the method-caller be set as the system dialer app.

Requires permission: MODIFY_PHONE_STATE

Parameters
dialString String: The digits to dial.
Returns
boolean True if the digits were processed as an MMI code, false otherwise.

handleMmi

added in API level 23
boolean handleMmi (String dialString, 
                PhoneAccountHandle accountHandle)

Processes the specified dial string as an MMI code. MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#". Some of these sequences launch special behavior through handled by Telephony.

Requires that the method-caller be set as the system dialer app.

Requires permission: MODIFY_PHONE_STATE

Parameters
dialString String: The digits to dial.
accountHandle PhoneAccountHandle: The handle for the account the MMI code should apply to.
Returns
boolean True if the digits were processed as an MMI code, false otherwise.

isInCall

added in API level 21
boolean isInCall ()

Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding states).

Requires permission: READ_PHONE_STATE

Returns
boolean

isIncomingCallPermitted

boolean isIncomingCallPermitted (PhoneAccountHandle phoneAccountHandle)

Determines whether Telecom would permit an incoming call to be added via the addNewIncomingCall(PhoneAccountHandle, Bundle) API for the specified PhoneAccountHandle.

A ConnectionService may not add a call for the specified PhoneAccountHandle in the following situations:

Parameters
phoneAccountHandle PhoneAccountHandle: The PhoneAccountHandle the call will be added for.
Returns
boolean true if telecom will permit an incoming call to be added, false otherwise.

isOutgoingCallPermitted

boolean isOutgoingCallPermitted (PhoneAccountHandle phoneAccountHandle)

Determines whether Telecom would permit an outgoing call to be placed via the placeCall(Uri, Bundle) API for the specified PhoneAccountHandle.

A ConnectionService may not place a call for the specified PhoneAccountHandle in the following situations:

Parameters
phoneAccountHandle PhoneAccountHandle: The PhoneAccountHandle the call will be added for.
Returns
boolean true if telecom will permit an outgoing call to be placed, false otherwise.

isVoiceMailNumber

added in API level 23
boolean isVoiceMailNumber (PhoneAccountHandle accountHandle, 
                String number)

Return whether a given phone number is the configured voicemail number for a particular phone account. Requires permission: READ_PHONE_STATE

Parameters
accountHandle PhoneAccountHandle: The handle for the account to check the voicemail number against
number String: The number to look up.
Returns
boolean

placeCall

added in API level 23
void placeCall (Uri address, 
                Bundle extras)

Places a new outgoing call to the provided address using the system telecom service with the specified extras. This method is equivalent to placing an outgoing call using ACTION_CALL, except that the outgoing call will always be sent via the system telecom service. If method-caller is either the user selected default dialer app or preloaded system dialer app, then emergency calls will also be allowed. Placing a call via a managed ConnectionService requires permission: CALL_PHONE Usage example:

 Uri uri = Uri.fromParts("tel", "12345", null);
 Bundle extras = new Bundle();
 extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
 telecomManager.placeCall(uri, extras);
 
The following keys are supported in the supplied extras.

An app which implements the self-managed ConnectionService API uses placeCall(Uri, Bundle) to inform Telecom of a new outgoing call. A self-managed ConnectionService must include EXTRA_PHONE_ACCOUNT_HANDLE to specify its associated PhoneAccountHandle. Self-managed ConnectionServices require permission MANAGE_OWN_CALLS.

Parameters
address Uri: The address to make the call to.
extras Bundle: Bundle of extras to use with the call.

registerPhoneAccount

added in API level 23
void registerPhoneAccount (PhoneAccount account)

Register a PhoneAccount for use by the system that will be stored in Device Encrypted storage. When registering PhoneAccounts, existing registrations will be overwritten if the PhoneAccountHandle matches that of a PhoneAccount which is already registered. Once registered, the PhoneAccount is listed to the user as an option when placing calls. The user may still need to enable the PhoneAccount within the phone app settings before the account is usable.

A SecurityException will be thrown if an app tries to register a PhoneAccountHandle where the package name specified within getComponentName() does not match the package name of the app.

Parameters
account PhoneAccount: The complete PhoneAccount.

showInCallScreen

added in API level 21
void showInCallScreen (boolean showDialpad)

Brings the in-call screen to the foreground if there is an ongoing call. If there is currently no ongoing call, then this method does nothing.

Requires that the method-caller be set as the system dialer app or have the READ_PHONE_STATE permission.

Parameters
showDialpad boolean: Brings up the in-call dialpad as part of showing the in-call screen.

silenceRinger

added in API level 23
void silenceRinger ()

Silences the ringer if a ringing call exists. Requires permission: MODIFY_PHONE_STATE

unregisterPhoneAccount

added in API level 23
void unregisterPhoneAccount (PhoneAccountHandle accountHandle)

Remove a PhoneAccount registration from the system.

Parameters
accountHandle PhoneAccountHandle: A PhoneAccountHandle for the PhoneAccount to unregister.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.