Method: accounts.sendVerificationCode

Envía un código de verificación por SMS para el acceso con número de teléfono.

Para localizar el texto del SMS que se envía al usuario, establece el encabezado HTTP X-Firebase-Locale en el código de idioma que corresponde a la configuración regional del usuario.

Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.

Solicitud HTTP

POST https://identitytoolkit.googleapis.com/v1/accounts:sendVerificationCode

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "phoneNumber": string,
  "iosReceipt": string,
  "iosSecret": string,
  "recaptchaToken": string,
  "tenantId": string,
  "autoRetrievalInfo": {
    object (AutoRetrievalInfo)
  },
  "safetyNetToken": string,
  "playIntegrityToken": string,
  "captchaResponse": string,
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion)
}
Campos
phoneNumber

string

Es el número de teléfono al que se enviará el código de verificación en formato E.164.
iosReceipt

string

Recibir una validación correcta del token de la app para iOS Se debe especificar al menos uno de (iosReceipt y iosSecret), recaptchaToken o safetyNetToken para verificar que el código de verificación se envíe en nombre de una app real y no de un emulador, si no se usa "captchaResponse" (no se habilitó reCAPTCHA Enterprise). Debe provenir de la respuesta de verifyIosClient. Si está presente, el llamador también debe proporcionar el iosSecret, así como un ID de paquete en el encabezado x-ios-bundle-identifier, que debe coincidir con el ID de paquete de la solicitud verifyIosClient.
iosSecret

string

El secreto se entrega a la app para iOS como una notificación push. Se debe pasar con un iosReceipt y el encabezado x-ios-bundle-identifier.
recaptchaToken

string

Token de reCAPTCHA para la verificación de apps. Se debe especificar al menos uno de (iosReceipt y iosSecret), recaptchaToken o safetyNetToken para verificar que el código de verificación se envíe en nombre de una app real y no de un emulador, si no se usa "captchaResponse" (no se habilitó reCAPTCHA Enterprise). Para generar el reCAPTCHA, llama a getRecaptchaParams y el token de reCAPTCHA se generará cuando el usuario complete el desafío de reCAPTCHA.
tenantId

string

Es el ID de grupo de usuarios de Identity Platform al que accede el usuario.
autoRetrievalInfo

object (AutoRetrievalInfo)

Solo para Android. Los Servicios de Google Play lo usan para identificar la app para la recuperación automática.
safetyNetToken

string

Solo para Android. Se usa para confirmar la identidad de la aplicación en lugar de un token de reCAPTCHA. Se debe especificar al menos uno de (iosReceipt y iosSecret), recaptchaToken o safetyNetToken para verificar que el código de verificación se envíe en nombre de una app real y no de un emulador, si no se usa "captchaResponse" (no se habilitó reCAPTCHA Enterprise). Se puede generar un token de SafetyNet a través de la API de SafetyNet Android Attestation, con la codificación Base64 del campo phoneNumber como nonce.
playIntegrityToken

string

Solo para Android. Se usa para confirmar la identidad de la aplicación en lugar de un token de reCAPTCHA (y safetyNetToken). Se debe especificar al menos uno de (iosReceipt y iosSecret), recaptchaToken o playIntegrityToken para verificar que el código de verificación se envíe en nombre de una app real y no de un emulador, si no se usa "captchaResponse" (no se habilitó reCAPTCHA Enterprise). Se puede generar un token de Play Integrity a través de la API de PlayIntegrity aplicando SHA256 al campo phoneNumber como nonce.
captchaResponse

string

Opcional. El token de reCAPTCHA Enterprise que proporciona la integración del cliente de reCAPTCHA. Obligatorio cuando reCAPTCHA Enterprise está habilitado.
clientType

enum (ClientType)

Opcional. El tipo de cliente, web, Android o iOS. Obligatorio cuando reCAPTCHA Enterprise está habilitado.
recaptchaVersion

enum (RecaptchaVersion)

Opcional. La versión de reCAPTCHA del token de reCAPTCHA en captchaResponse. Obligatorio cuando reCAPTCHA Enterprise está habilitado.

Cuerpo de la respuesta

Mensaje de respuesta para accounts.sendVerificationCode.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "sessionInfo": string
}
Campos
sessionInfo

string

Información de la sesión encriptada Se puede usar en signInWithPhoneNumber para autenticar el número de teléfono.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

AutoRetrievalInfo

Es la información necesaria para recuperar automáticamente un SMS.

Representación JSON 
{
  "appSignatureHash": string
}
Campos
appSignatureHash

string

El hash de firma de la app para Android para la API de SMS Retriever de los Servicios de Google Play