# CarrierConfigManager.ImsServiceEntitlement

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# ImsServiceEntitlement

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/telephony/CarrierConfigManager.ImsServiceEntitlement "View this page in Java")  

```
class ImsServiceEntitlement
```

|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                                               ||
| ↳ | [android.telephony.CarrierConfigManager.ImsServiceEntitlement](https://developer.android.com/reference/kotlin/android/telephony/CarrierConfigManager.ImsServiceEntitlement#) |

Configs used by ImsServiceEntitlement.

## Summary

|                                                                                                                                                                                                   Constants                                                                                                                                                                                                   ||
|----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| static[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [KEY_ENTITLEMENT_SERVER_URL_STRING](https://developer.android.com/reference/kotlin/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_ENTITLEMENT_SERVER_URL_STRING:kotlin.String) The address of the entitlement configuration server.                                                                 |
| static[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [KEY_FCM_SENDER_ID_STRING](https://developer.android.com/reference/kotlin/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_FCM_SENDER_ID_STRING:kotlin.String) The FCM sender ID for the carrier.                                                                                                     |
| static[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [KEY_IMS_PROVISIONING_BOOL](https://developer.android.com/reference/kotlin/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_IMS_PROVISIONING_BOOL:kotlin.String) For some carriers, the network is not provisioned by default to support IMS (VoLTE/VoWiFi/SMSoIP) service for all end users.         |
| static[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [KEY_PREFIX](https://developer.android.com/reference/kotlin/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_PREFIX:kotlin.String) Prefix of all ImsServiceEntitlement.                                                                                                                               |
| static[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [KEY_SHOW_VOWIFI_WEBVIEW_BOOL](https://developer.android.com/reference/kotlin/android/telephony/CarrierConfigManager.ImsServiceEntitlement#KEY_SHOW_VOWIFI_WEBVIEW_BOOL:kotlin.String) For some carriers, end-users may be presented with a web portal of the carrier before being allowed to use the VoWiFi service. |

## Constants

### KEY_ENTITLEMENT_SERVER_URL_STRING

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val KEY_ENTITLEMENT_SERVER_URL_STRING: String
```

The address of the entitlement configuration server. Reference: GSMA TS.43-v5, section 2.1 Default Entitlement Configuration Server.  

    Value: "imsserviceentitlement.entitlement_server_url_string"

### KEY_FCM_SENDER_ID_STRING

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val KEY_FCM_SENDER_ID_STRING: String
```

The FCM sender ID for the carrier. Used to trigger a carrier network requested entitlement configuration via Firebase Cloud Messaging (FCM). Do not set if the carrier doesn't use FCM for network requested entitlement configuration. Reference: GSMA TS.43-v5, section 2.4, Network Requested Entitlement Configuration.  

    Value: "imsserviceentitlement.fcm_sender_id_string"

**See Also**

### KEY_IMS_PROVISIONING_BOOL

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val KEY_IMS_PROVISIONING_BOOL: String
```

For some carriers, the network is not provisioned by default to support IMS (VoLTE/VoWiFi/SMSoIP) service for all end users. Some type of network-side provisioning must then take place before offering the IMS service to the end-user.`true`- need this ImsServiceEntitlement app to do IMS (VoLTE/VoWiFi/SMSoIP) provisioning in the background before offering the IMS service to the end-user. Note: this is effective only if the carrier needs IMS provisioning, i.e.[KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL](https://developer.android.com/reference/kotlin/android/telephony/CarrierConfigManager#KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL:kotlin.String)is set to true. Reference: GSMA TS.43-v5, section 3 - 5, VoWiFi/VoLTE/SMSoIP entitlement configuration.  

    Value: "imsserviceentitlement.ims_provisioning_bool"

### KEY_PREFIX

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val KEY_PREFIX: String
```

Prefix of all ImsServiceEntitlement.KEY_\* constants.  

    Value: "imsserviceentitlement."

### KEY_SHOW_VOWIFI_WEBVIEW_BOOL

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val KEY_SHOW_VOWIFI_WEBVIEW_BOOL: String
```

For some carriers, end-users may be presented with a web portal of the carrier before being allowed to use the VoWiFi service. To support this feature, the app hosts a[android.webkit.WebView](https://developer.android.com/reference/kotlin/android/webkit/WebView.html#)in the foreground VoWiFi entitlement configuration flow to show the web portal.`true`- show the VoWiFi portal in a webview. Note: this is effective only if the[KEY_WFC_EMERGENCY_ADDRESS_CARRIER_APP_STRING](https://developer.android.com/reference/kotlin/android/telephony/CarrierConfigManager#KEY_WFC_EMERGENCY_ADDRESS_CARRIER_APP_STRING:kotlin.String)is set to this app. Reference: GSMA TS.43-v5, section 3, VoWiFi entitlement configuration.  

    Value: "imsserviceentitlement.show_vowifi_webview_bool"