# BlockedNumberContract

Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Nested Classes](https://developer.android.com/reference/android/provider/BlockedNumberContract#nestedclasses)\|[Constants](https://developer.android.com/reference/android/provider/BlockedNumberContract#constants)\|[Fields](https://developer.android.com/reference/android/provider/BlockedNumberContract#lfields)\|[Methods](https://developer.android.com/reference/android/provider/BlockedNumberContract#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/provider/BlockedNumberContract#inhmethods)  

# BlockedNumberContract

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/provider/BlockedNumberContract "View this page in Kotlin")\|Java

`
public


class
BlockedNumberContract
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|----------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.provider.BlockedNumberContract |

<br />

*** ** * ** ***

<br />

The contract between the blockednumber provider and applications. Contains definitions for the supported URIs and columns.

### Overview

The content provider exposes a table containing blocked numbers. The columns and URIs for accessing this table are defined by the[BlockedNumbers](https://developer.android.com/reference/android/provider/BlockedNumberContract.BlockedNumbers)class. Messages, and calls from blocked numbers are discarded by the platform. Notifications upon provider changes can be received using a[ContentObserver](https://developer.android.com/reference/android/database/ContentObserver).

The platform will not block messages, and calls from emergency numbers as defined by[PhoneNumberUtils.isEmergencyNumber(String)](https://developer.android.com/reference/android/telephony/PhoneNumberUtils#isEmergencyNumber(java.lang.String)). If the user contacts emergency services, number blocking is disabled by the platform for a duration defined by[CarrierConfigManager.KEY_DURATION_BLOCKING_DISABLED_AFTER_EMERGENCY_INT](https://developer.android.com/reference/android/telephony/CarrierConfigManager#KEY_DURATION_BLOCKING_DISABLED_AFTER_EMERGENCY_INT).

### Permissions

Only the system, the default SMS application, and the default phone app (See[TelecomManager.getDefaultDialerPackage()](https://developer.android.com/reference/android/telecom/TelecomManager#getDefaultDialerPackage())), and carrier apps (See[CarrierService](https://developer.android.com/reference/android/service/carrier/CarrierService)) can read, and write to the blockednumber provider. However,[canCurrentUserBlockNumbers(android.content.Context)](https://developer.android.com/reference/android/provider/BlockedNumberContract#canCurrentUserBlockNumbers(android.content.Context))can be accessed by any application.

### Data

Other than regular phone numbers, the blocked number provider can also store addresses (such as email) from which a user can receive messages, and calls. The blocked numbers are stored in the[BlockedNumbers.COLUMN_ORIGINAL_NUMBER](https://developer.android.com/reference/android/provider/BlockedNumberContract.BlockedNumbers#COLUMN_ORIGINAL_NUMBER)column. A normalized version of phone numbers (if normalization is possible) is stored in[BlockedNumbers.COLUMN_E164_NUMBER](https://developer.android.com/reference/android/provider/BlockedNumberContract.BlockedNumbers#COLUMN_E164_NUMBER)column. The platform blocks calls, and messages from an address if it is present in in the[BlockedNumbers.COLUMN_ORIGINAL_NUMBER](https://developer.android.com/reference/android/provider/BlockedNumberContract.BlockedNumbers#COLUMN_ORIGINAL_NUMBER)column or if the E164 version of the address matches the[BlockedNumbers.COLUMN_E164_NUMBER](https://developer.android.com/reference/android/provider/BlockedNumberContract.BlockedNumbers#COLUMN_E164_NUMBER)column.

### Operations

**Insert**

:   [BlockedNumbers.COLUMN_ORIGINAL_NUMBER](https://developer.android.com/reference/android/provider/BlockedNumberContract.BlockedNumbers#COLUMN_ORIGINAL_NUMBER)is a required column that needs to be populated. Apps can optionally provide the[BlockedNumbers.COLUMN_E164_NUMBER](https://developer.android.com/reference/android/provider/BlockedNumberContract.BlockedNumbers#COLUMN_E164_NUMBER)which is the phone number's E164 representation. The provider automatically populates this column if the app does not provide it. Note that this column is not populated if normalization fails or if the address is not a phone number (eg: email).

    Attempting to insert an existing blocked number (same[BlockedNumbers.COLUMN_ORIGINAL_NUMBER](https://developer.android.com/reference/android/provider/BlockedNumberContract.BlockedNumbers#COLUMN_ORIGINAL_NUMBER)column) will result in replacing the existing blocked number.

    Examples:  

    ```
     ContentValues values = new ContentValues();
     values.put(BlockedNumbers.COLUMN_ORIGINAL_NUMBER, "1234567890");
     Uri uri = getContentResolver().insert(BlockedNumbers.CONTENT_URI, values);
     
    ```  

    ```
     ContentValues values = new ContentValues();
     values.put(BlockedNumbers.COLUMN_ORIGINAL_NUMBER, "1234567890");
     values.put(BlockedNumbers.COLUMN_E164_NUMBER, "+11234567890");
     Uri uri = getContentResolver().insert(BlockedNumbers.CONTENT_URI, values);
     
    ```  

    ```
     ContentValues values = new ContentValues();
     values.put(BlockedNumbers.COLUMN_ORIGINAL_NUMBER, "12345@abdcde.com");
     Uri uri = getContentResolver().insert(BlockedNumbers.CONTENT_URI, values);
     
    ```

    <br />

**Update**

:   Updates are not supported. Use Delete, and Insert instead.

**Delete**

:   Deletions can be performed as follows:

    ```
     ContentValues values = new ContentValues();
     values.put(BlockedNumbers.COLUMN_ORIGINAL_NUMBER, "1234567890");
     Uri uri = getContentResolver().insert(BlockedNumbers.CONTENT_URI, values);
     getContentResolver().delete(uri, null, null);
     
    ```
    To check if a particular number is blocked, use the method[isBlocked(android.content.Context, java.lang.String)](https://developer.android.com/reference/android/provider/BlockedNumberContract#isBlocked(android.content.Context,%20java.lang.String)).

    <br />

**Query**

:   All blocked numbers can be enumerated as follows:

    ```
     Cursor c = getContentResolver().query(BlockedNumbers.CONTENT_URI,
              new String[]{BlockedNumbers.COLUMN_ID, BlockedNumbers.COLUMN_ORIGINAL_NUMBER,
              BlockedNumbers.COLUMN_E164_NUMBER}, null, null, null);
     
    ```

    <br />

**Unblock**

:   Use the method[unblock(android.content.Context, java.lang.String)](https://developer.android.com/reference/android/provider/BlockedNumberContract#unblock(android.content.Context,%20java.lang.String))to unblock numbers.