Validar mensagens de OTP no Amazon Pinpoint - Amazon Pinpoint
Resposta VerifyOtpMessage

Aviso de fim do suporte: em 30 de outubro de 2026, AWS encerrará o suporte para o Amazon Pinpoint. Após 30 de outubro de 2026, você não poderá mais acessar o console do Amazon Pinpoint nem seus recursos (endpoints, segmentos, campanhas, jornadas e analytics). Para obter mais informações, consulte Fim do suporte do Amazon Pinpoint. Observação: APIs relacionados a SMS, voz, push móvel, OTP e validação de número de telefone não são afetados por essa alteração e são compatíveis com o AWS End User Messaging.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Validar mensagens de OTP no Amazon Pinpoint

Depois de enviar um one-time-password, seu aplicativo pode chamar a API do Amazon Pinpoint para verificá-lo. Para verificar um código OTP, chame a API VerifyOtpMessages. Essa solicitação precisam incluir os parâmetros a seguir:

  • DestinationIdentity: o número de telefone, no formato E.164, para o qual o código OTP foi enviado.

  • ReferenceId: o ID de referência que você usou ao enviar o código OTP ao destinatário. O ID de referência deve corresponder exatamente.

  • Otp: o código OTP que você está validando.

Você pode usar o AWS CLI para testar o processo de validação. Para obter mais informações sobre como instalar e configurar o AWS CLI, consulte o Guia do AWS Command Line Interface usuário.

Para verificar uma OTP usando o AWS CLI, execute o verify-otp-messagecomando no terminal:

aws pinpoint verify-otp-message --application-id 7353f53e6885409fa32d07cedexample --verify-otp-message-request-parameters DestinationIdentity=+12065550007,ReferenceId=SampleReferenceId,Otp=01234

No comando anterior, faça o seguinte:

  • 7353f53e6885409fa32d07cedexampleSubstitua pelo ID do seu aplicativo.

  • +12065550007DestinationIdentitySubstitua pelo número de telefone para o qual o código OTP foi enviado.

  • SampleReferenceIdReferenceIdSubstitua por um ID de referência exclusivo para a solicitação. Esse valor deve corresponder ao ReferenceID que foi usado para enviar a solicitação.

  • 01234OtpSubstitua por um Otp que foi enviado para o. DestinationIdentity

Resposta VerifyOtpMessage

Quando você envia uma solicitação para a API VerifyOTPMessage, ela retorna um objeto VerificationResponse, que contém uma única propriedade, Valid. Se o ID de referência, o número de telefone e a OTP corresponderem aos valores esperados pelo Amazon Pinpoint e se a OTP não tiver expirado, o valor de Valid será true; caso contrário, será false. Veja a seguir um exemplo de uma verificação de OTP bem sucedida:

{
    "VerificationResponse": {
        "Valid": true
    }
}