Stay organized with collections
Save and categorize content based on your preferences.
public final class SmsRetriever
SmsRetriever
provides access to Google services that help you retrieve SMS messages sent to your app without having to ask for android.permission.READ_SMS
or android.permission.RECEIVE_SMS
.
To use SmsRetriever
, obtain an instance of SmsRetrieverClient
using getClient
or getClient
, then start the SMS retriever service by calling startSmsRetriever
or startSmsUserConsent
. The service waits for a matching SMS message until timeout (5 minutes).
Summary
Constants
public static final String
EXTRA_CONSENT_INTENT
= "com.google.android.gms.auth.api.phone.EXTRA_CONSENT_INTENT"
Intent extra key of the consent intent to be launched from client app.
public static final String
EXTRA_SIM_SUBSCRIPTION_ID
= "com.google.android.gms.auth.api.phone.EXTRA_SIM_SUBSCRIPTION_ID"
[Optional] Intent extra key of the retrieved Sim card subscription Id if any, as an int
.
public static final String
EXTRA_SMS_MESSAGE
= "com.google.android.gms.auth.api.phone.EXTRA_SMS_MESSAGE"
Intent extra key of the retrieved SMS message as a String
.
public static final String
EXTRA_SMS_ORIGINATING_ADDRESS
= "com.google.android.gms.auth.api.phone.EXTRA_SMS_ORIGINATING_ADDRESS"
Intent extra key of the SMS originating address as a String
.
public static final String
EXTRA_STATUS
= "com.google.android.gms.auth.api.phone.EXTRA_STATUS"
Intent extra key of Status
, which indicates SUCCESS or TIMEOUT.
public static final String
SEND_PERMISSION
= "com.google.android.gms.auth.api.phone.permission.SEND"
Permission that's used to register the receiver to detect that the broadcaster is the SMS Retriever.
public static final String
SMS_RETRIEVED_ACTION
= "com.google.android.gms.auth.api.phone.SMS_RETRIEVED"
Intent action when SMS message is retrieved.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-26 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-26 UTC."],[[["\u003cp\u003e\u003ccode\u003eSmsRetriever\u003c/code\u003e enables SMS message retrieval without needing \u003ccode\u003eREAD_SMS\u003c/code\u003e or \u003ccode\u003eRECEIVE_SMS\u003c/code\u003e permissions by utilizing Google services.\u003c/p\u003e\n"],["\u003cp\u003eTo initiate retrieval, obtain an \u003ccode\u003eSmsRetrieverClient\u003c/code\u003e instance and start the service using \u003ccode\u003estartSmsRetriever()\u003c/code\u003e or \u003ccode\u003estartSmsUserConsent()\u003c/code\u003e, which waits for a matching SMS for a 5-minute timeout period.\u003c/p\u003e\n"],["\u003cp\u003eKey constants like \u003ccode\u003eEXTRA_SMS_MESSAGE\u003c/code\u003e, \u003ccode\u003eEXTRA_STATUS\u003c/code\u003e, and \u003ccode\u003eSMS_RETRIEVED_ACTION\u003c/code\u003e provide access to the retrieved SMS message, status, and retrieval action, respectively.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use \u003ccode\u003egetClient(Activity)\u003c/code\u003e or \u003ccode\u003egetClient(Context)\u003c/code\u003e to create an instance of \u003ccode\u003eSmsRetrieverClient\u003c/code\u003e within their application's context.\u003c/p\u003e\n"]]],["`SmsRetriever` allows SMS retrieval without requiring SMS permissions. To use it, obtain an `SmsRetrieverClient` instance via `getClient(Context)` or `getClient(Activity)`. Then, initiate the service with `startSmsRetriever()` or `startSmsUserConsent(String)`. The service monitors for matching SMS messages for up to five minutes. Constants such as `EXTRA_SMS_MESSAGE` and `EXTRA_STATUS` are used as Intent extras to retrieve the message and status, respectively.\n"],null,["# SmsRetriever\n============\n\n[Kotlin](/android/reference/kotlin/com/google/android/gms/auth/api/phone/SmsRetriever \"View this page in Kotlin\") \\|Java \n\n\n```\npublic final class SmsRetriever\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\n`SmsRetriever` provides access to Google services that help you retrieve SMS messages sent to your app without having to ask for `android.permission.READ_SMS` or `\nandroid.permission.RECEIVE_SMS`.\n\nTo use `SmsRetriever`, obtain an instance of [SmsRetrieverClient](/android/reference/com/google/android/gms/auth/api/phone/SmsRetrieverClient) using [getClient](/android/reference/com/google/android/gms/auth/api/phone/SmsRetriever#getClient(android.content.Context)) or [getClient](/android/reference/com/google/android/gms/auth/api/phone/SmsRetriever#getClient(android.app.Activity)), then start the SMS retriever service by calling [startSmsRetriever](/android/reference/com/google/android/gms/auth/api/phone/SmsRetrieverClient#startSmsRetriever()) or [startSmsUserConsent](/android/reference/com/google/android/gms/auth/api/phone/SmsRetrieverClient#startSmsUserConsent(java.lang.String)). The service waits for a matching SMS message until timeout (5 minutes).\n\nSummary\n-------\n\n| ### Constants |\n|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `static final `[String](https://developer.android.com/reference/java/lang/String.html) | [EXTRA_CONSENT_INTENT](/android/reference/com/google/android/gms/auth/api/phone/SmsRetriever#EXTRA_CONSENT_INTENT())` = \"com.google.android.gms.auth.api.phone.EXTRA_CONSENT_INTENT\"` Intent extra key of the consent intent to be launched from client app. |\n| `static final `[String](https://developer.android.com/reference/java/lang/String.html) | [EXTRA_SIM_SUBSCRIPTION_ID](/android/reference/com/google/android/gms/auth/api/phone/SmsRetriever#EXTRA_SIM_SUBSCRIPTION_ID())` = \"com.google.android.gms.auth.api.phone.EXTRA_SIM_SUBSCRIPTION_ID\"` \\[Optional\\] Intent extra key of the retrieved Sim card subscription Id if any, as an ` int`. |\n| `static final `[String](https://developer.android.com/reference/java/lang/String.html) | [EXTRA_SMS_MESSAGE](/android/reference/com/google/android/gms/auth/api/phone/SmsRetriever#EXTRA_SMS_MESSAGE())` = \"com.google.android.gms.auth.api.phone.EXTRA_SMS_MESSAGE\"` Intent extra key of the retrieved SMS message as a `String`. |\n| `static final `[String](https://developer.android.com/reference/java/lang/String.html) | [EXTRA_SMS_ORIGINATING_ADDRESS](/android/reference/com/google/android/gms/auth/api/phone/SmsRetriever#EXTRA_SMS_ORIGINATING_ADDRESS())` = \"com.google.android.gms.auth.api.phone.EXTRA_SMS_ORIGINATING_ADDRESS\"` Intent extra key of the SMS originating address as a `String`. |\n| `static final `[String](https://developer.android.com/reference/java/lang/String.html) | [EXTRA_STATUS](/android/reference/com/google/android/gms/auth/api/phone/SmsRetriever#EXTRA_STATUS())` = \"com.google.android.gms.auth.api.phone.EXTRA_STATUS\"` Intent extra key of [Status](/android/reference/com/google/android/gms/common/api/Status), which indicates SUCCESS or TIMEOUT. |\n| `static final `[String](https://developer.android.com/reference/java/lang/String.html) | [SEND_PERMISSION](/android/reference/com/google/android/gms/auth/api/phone/SmsRetriever#SEND_PERMISSION())` = \"com.google.android.gms.auth.api.phone.permission.SEND\"` Permission that's used to register the receiver to detect that the broadcaster is the SMS Retriever. |\n| `static final `[String](https://developer.android.com/reference/java/lang/String.html) | [SMS_RETRIEVED_ACTION](/android/reference/com/google/android/gms/auth/api/phone/SmsRetriever#SMS_RETRIEVED_ACTION())` = \"com.google.android.gms.auth.api.phone.SMS_RETRIEVED\"` Intent action when SMS message is retrieved. |\n\n| ### Public methods |\n|------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `static `[SmsRetrieverClient](/android/reference/com/google/android/gms/auth/api/phone/SmsRetrieverClient) | [getClient](/android/reference/com/google/android/gms/auth/api/phone/SmsRetriever#getClient(android.app.Activity))`(`[Activity](https://developer.android.com/reference/android/app/Activity.html)` activity)` Create a new instance of [SmsRetrieverClient](/android/reference/com/google/android/gms/auth/api/phone/SmsRetrieverClient) for use in an [Activity](https://developer.android.com/reference/android/app/Activity.html). |\n| `static `[SmsRetrieverClient](/android/reference/com/google/android/gms/auth/api/phone/SmsRetrieverClient) | [getClient](/android/reference/com/google/android/gms/auth/api/phone/SmsRetriever#getClient(android.content.Context))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context)` Create a new instance of [SmsRetrieverClient](/android/reference/com/google/android/gms/auth/api/phone/SmsRetrieverClient) for use in a [Context](https://developer.android.com/reference/android/content/Context.html). |\n\nConstants\n---------\n\n### EXTRA_CONSENT_INTENT\n\n```\npublic static final String EXTRA_CONSENT_INTENT = \"com.google.android.gms.auth.api.phone.EXTRA_CONSENT_INTENT\"\n```\n\nIntent extra key of the consent intent to be launched from client app. \n\n### EXTRA_SIM_SUBSCRIPTION_ID\n\n```\npublic static final String EXTRA_SIM_SUBSCRIPTION_ID = \"com.google.android.gms.auth.api.phone.EXTRA_SIM_SUBSCRIPTION_ID\"\n```\n\n\\[Optional\\] Intent extra key of the retrieved Sim card subscription Id if any, as an `\nint`. \n\n### EXTRA_SMS_MESSAGE\n\n```\npublic static final String EXTRA_SMS_MESSAGE = \"com.google.android.gms.auth.api.phone.EXTRA_SMS_MESSAGE\"\n```\n\nIntent extra key of the retrieved SMS message as a `String`. \n\n### EXTRA_SMS_ORIGINATING_ADDRESS\n\n```\npublic static final String EXTRA_SMS_ORIGINATING_ADDRESS = \"com.google.android.gms.auth.api.phone.EXTRA_SMS_ORIGINATING_ADDRESS\"\n```\n\nIntent extra key of the SMS originating address as a `String`. \n\n### EXTRA_STATUS\n\n```\npublic static final String EXTRA_STATUS = \"com.google.android.gms.auth.api.phone.EXTRA_STATUS\"\n```\n\nIntent extra key of [Status](/android/reference/com/google/android/gms/common/api/Status), which indicates SUCCESS or TIMEOUT. \n\n### SEND_PERMISSION\n\n```\npublic static final String SEND_PERMISSION = \"com.google.android.gms.auth.api.phone.permission.SEND\"\n```\n\nPermission that's used to register the receiver to detect that the broadcaster is the SMS Retriever. \n\n### SMS_RETRIEVED_ACTION\n\n```\npublic static final String SMS_RETRIEVED_ACTION = \"com.google.android.gms.auth.api.phone.SMS_RETRIEVED\"\n```\n\nIntent action when SMS message is retrieved. \n\nPublic methods\n--------------\n\n### getClient\n\n```\npublic static SmsRetrieverClient getClient(Activity activity)\n```\n\nCreate a new instance of [SmsRetrieverClient](/android/reference/com/google/android/gms/auth/api/phone/SmsRetrieverClient) for use in an [Activity](https://developer.android.com/reference/android/app/Activity.html). \n\n### getClient\n\n```\npublic static SmsRetrieverClient getClient(Context context)\n```\n\nCreate a new instance of [SmsRetrieverClient](/android/reference/com/google/android/gms/auth/api/phone/SmsRetrieverClient) for use in a [Context](https://developer.android.com/reference/android/content/Context.html)."]]
