Esta página foi traduzida pela API Cloud Translation.

Method: accounts.sendVerificationCode
Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Solicitação HTTP
Corpo da solicitação
- Representação JSON
Corpo da resposta
- Representação JSON
Escopos de autorização
AutoRetrievalInfo
- Representação JSON
Faça um teste

Envia um código de verificação por SMS para fazer login com o número de telefone.

Para localizar o texto do SMS enviado ao usuário, defina o cabeçalho HTTP X-Firebase-Locale como o código de idioma correspondente à localidade do usuário.

Uma chave de API é necessária na solicitação para identificar o projeto do Google Cloud.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON

Representação 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`) }

{
  "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` O número de telefone para o qual o código de verificação será enviado no formato E.164.
`iosReceipt`	`string` Recebimento de confirmação de validação do token do app iOS. Pelo menos um dos seguintes (`iosReceipt` e `iosSecret`), `recaptchaToken` ou `safetyNetToken` precisa ser especificado para verificar se o código de verificação está sendo enviado em nome de um app real e não de um emulador, se 'captchaResponse' não for usado (o reCAPTCHA Enterprise não estiver ativado). Isso precisa vir da resposta de verifyIosClient. Se estiver presente, o autor da chamada também precisará fornecer o `iosSecret`, bem como um ID de pacote no cabeçalho `x-ios-bundle-identifier`, que precisa corresponder ao ID de pacote da solicitação verifyIosClient.
`iosSecret`	`string` Secret enviado ao app iOS como uma notificação push. Precisa ser transmitida com um `iosReceipt` e o cabeçalho `x-ios-bundle-identifier`.
`recaptchaToken`	`string` Token reCAPTCHA para verificação de apps. Pelo menos um dos seguintes (`iosReceipt` e `iosSecret`), `recaptchaToken` ou `safetyNetToken` precisa ser especificado para verificar se o código de verificação está sendo enviado em nome de um app real e não de um emulador, se 'captchaResponse' não for usado (o reCAPTCHA Enterprise não estiver ativado). A reCaptcha precisa ser gerada chamando getRecaptchaParams, e o token de reCaptcha será gerado quando o usuário concluir o desafio de reCaptcha.
`tenantId`	`string` ID do locatário do Identity Platform em que o usuário está fazendo login.
`autoRetrievalInfo`	`object (AutoRetrievalInfo)` Somente no Android. Usado pelo Google Play Services para identificar o app para recuperação automática.
`safetyNetToken`	`string` Somente no Android. Usado para declarar a identidade do aplicativo no lugar de um token de reCaptcha. Pelo menos um dos seguintes (`iosReceipt` e `iosSecret`), `recaptchaToken` ou `safetyNetToken` precisa ser especificado para verificar se o código de verificação está sendo enviado em nome de um app real e não de um emulador, se 'captchaResponse' não for usado (o reCAPTCHA Enterprise não estiver ativado). Um token da SafetyNet pode ser gerado pela API SafetyNet Attestation para Android, com a codificação Base64 do campo `phoneNumber` como o valor de uso único.
`playIntegrityToken`	`string` Somente no Android. Usado para declarar a identidade do aplicativo no lugar de um token recaptcha (e safetyNetToken). Pelo menos um dos seguintes valores (`iosReceipt` e `iosSecret`), `recaptchaToken`, `playIntegrityToken` ou `playIntegrityToken` precisa ser especificado para verificar se o código de verificação está sendo enviado em nome de um app real e não de um emulador, se "captchaResponse" não for usado (o reCAPTCHA Enterprise não estiver ativado). Um token de integridade pode ser gerado pela API Play Integrity com a aplicação do SHA256 ao campo `phoneNumber` como o valor de uso único.
`captchaResponse`	`string` Opcional. O token reCAPTCHA Enterprise fornecido pela integração do reCAPTCHA no lado do cliente. Obrigatório quando o reCAPTCHA Enterprise está ativado.
`clientType`	`enum (ClientType)` Opcional. O tipo de cliente, Web, Android ou iOS. Obrigatório quando o reCAPTCHA Enterprise está ativado.
`recaptchaVersion`	`enum (RecaptchaVersion)` Opcional. A versão do reCAPTCHA do token reCAPTCHA no captchaResponse. Obrigatório quando o reCAPTCHA Enterprise está ativado.

Corpo da resposta

Mensagem de resposta para accounts.sendVerificationCode.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{ "sessionInfo": string }

Campos

Campos
`sessionInfo`	`string` Informações da sessão criptografada. Ele pode ser usado em signInWithPhoneNumber para autenticar o número de telefone.

sessionInfo

string

Informações da sessão criptografada. Ele pode ser usado em signInWithPhoneNumber para autenticar o número de telefone.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

AutoRetrievalInfo

As informações necessárias para recuperar automaticamente um SMS.

Representação JSON
{ "appSignatureHash": string }