Gere senhas de uso único (OTPs) com o Amazon Pinpoint

O Amazon Pinpoint inclui um recurso de gerenciamento de senha de uso único (OTP) que você pode usar para gerar novas senhas de uso único e enviá-las aos destinatários como mensagens SMS.

Importante

Para usar esse recurso, sua conta deve ter acesso de produção e uma identidade de origem ativa. Para obter mais informações, consulte About the SMS/MMS and Voice sandbox e Request a phone number no Guia do usuário do AWS End User Messaging SMS.

Em alguns países e regiões, você deve obter um número de telefone dedicado ou ID de origem antes de poder enviar mensagens SMS. Por exemplo, ao enviar mensagens para os destinatários nos Estados Unidos, você deve ter um número de ligação gratuita dedicado, um número 10DLC ou um código curto. Ao enviar mensagens para destinatários na Índia, você deve ter um ID de remetente registrado, que inclui um ID de entidade principal (PEID) e um ID de modelo. Esses requisitos ainda se aplicam ao usar o atributo OTP.

Para usar esse atributo, você precisa de permissões para enviar e verificar mensagens OTP. Consulte Senhas de uso único. Se precisar de ajuda para determinar as permissões, consulte Solução de problemas de gerenciamento de identidade e acesso do Amazon Pinpoint.

Você pode usar a operação SendOtpMessages na API do Amazon Pinpoint para enviar um código OTP a um usuário do aplicativo. Quando você usa essa API, o Amazon Pinpoint gera um código aleatório e o envia ao usuário como uma mensagem SMS. Sua solicitação pode incluir os parâmetros a seguir:

• Channel: o canal de comunicação pelo qual o código OTP é enviado. Atualmente, somente mensagens SMS são compatíveis, então o único valor aceitável é SMS.

• BrandName: o nome da marca, empresa ou produto associado ao código OTP. O nome pode conter até 20 caracteres.

  nota

  Quando o Amazon Pinpoint envia a mensagem OTP, o nome da marca é inserido automaticamente no seguinte modelo de mensagem:

  This is your One Time Password: {{otp}} from {{brand}}

  Portanto, se você especificar ExampleCorp o nome da sua marca e o Amazon Pinpoint gerar uma senha de uso único de 123456, ele enviará a seguinte mensagem ao seu usuário:

  This is your One Time Password: 123456 from ExampleCorp

• CodeLength: o número de dígitos que estarão no código OTP enviado ao destinatário. Os códigos OTP podem conter entre 5 e 8 dígitos, inclusive.

• ValidityPeriod: a quantidade de tempo, em minutos, em que o código OTP será válido. O período de validade pode ser entre 5 e 60 minutos.

• AllowedAttempts: o número de vezes que o destinatário pode tentar, sem sucesso, verificar a OTP. Se o número de tentativas exceder esse valor, a OTP se tornará automaticamente inválida. A quantidade máxima de tentativas é 5.

• Language: o idioma, no formato IETF BCP-47, a ser usado ao enviar a mensagem. Os valores aceitáveis são:

  • de-DE: Alemão

  • en-GB: Inglês (Reino Unido)

  • en-US: Inglês (EUA)

  • es-419: Espanhol (América Latina)

  • es-ES: Espanhol

  • fr-CA: Francês (Canadá)

  • fr-FR: Francês

  • it-IT: Italiano

  • ja-JP: Japonês

  • ko-KR: Coreano

  • pt-BR: Português (Brasil)

  • zh-CN: Chinês (simplificado)

  • zh-TW: Chinês (tradicional)

• OriginationIdentity: a identidade de origem (como código longo, código curto ou ID do remetente) usada para enviar o código OTP. Se você usar um código longo ou um número gratuito para enviar a OTP, o número de telefone deverá estar no formato E.164.

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

• ReferenceId: um ID exclusivo de referência para a solicitação. O ID de referência corresponde exatamente ao ID de referência que você fornece ao verificar a OTP. O ID de referência pode conter entre 1 e 48 caracteres.

• EntityId: um ID de entidade registrado em uma agência reguladora. Atualmente, esse parâmetro é usado somente ao enviar mensagens a destinatários na Índia. Se você não estiver enviando para destinatários na Índia, poderá omitir esse parâmetro.

• TemplateId: um ID de modelo registrado em uma agência reguladora. Atualmente, esse parâmetro é usado somente ao enviar mensagens a destinatários na Índia. Se você não estiver enviando para destinatários na Índia, poderá omitir esse parâmetro.

  nota

  Para obter mais informações sobre os requisitos de envio de mensagens para destinatários na Índia, consulte India sender ID registration process no Guia do usuário do Amazon Pinpoint.

Para garantir que sua conta do Amazon Pinpoint esteja configurada corretamente para enviar mensagens OTP, você pode usar o AWS CLI para enviar uma mensagem de teste. Para obter mais informações sobre o AWS CLI, consulte o Guia AWS Command Line Interface do usuário.

Para enviar uma mensagem OTP de teste usando o AWS CLI, execute o send-otp-messagecomando no terminal:

aws pinpoint send-otp-message --application-id 7353f53e6885409fa32d07cedexample --send-otp-message-request-parameters Channel=SMS,BrandName=ExampleCorp,CodeLength=5,ValidityPeriod=20,AllowedAttempts=5,OriginationIdentity=[phone],DestinationIdentity=[phone],ReferenceId=SampleReferenceId

No comando anterior, faça o seguinte:

• 7353f53e6885409fa32d07cedexampleSubstitua pelo ID do seu aplicativo.

• ExampleCorpSubstitua pelo nome da sua empresa.

• 5CodeLegthSubstitua pelo número de dígitos que estarão no código OTP enviado ao destinatário.

• Substitua pela 20 quantidade de tempo, em minutos, em que o código OTP será válido. ValidityPeriod

• 5AllowedAttemptsSubstitua pelo número de vezes que o destinatário pode tentar verificar a OTP sem sucesso.

• OriginationIdentitySubstitua [phone] in pela identidade de origem usada para enviar o código OTP.

• [phone]DestinationIdentitySubstitua pelo número de telefone para o qual enviar o código OTP.

• SampleReferenceIdReferenceIdSubstitua por um ID de referência exclusivo para a solicitação.

Resposta SendOtpMessage

Ao enviar uma mensagem OTP com êxito, você recebe uma resposta semelhante ao seguinte exemplo:

{
    "MessageResponse": {
        "ApplicationId": "7353f53e6885409fa32d07cedexample",
        "RequestId": "255d15ea-75fe-4040-b919-096f2example",
        "Result": {
            "[phone]": {
                "DeliveryStatus": "SUCCESSFUL",
                "MessageId": "nvrmgq9kq4en96qgp0tlqli3og1at6aexample",
                "StatusCode": 200,
                "StatusMessage": "MessageId: nvrmgq9kq4en96qgp0tlqli3og1at6aexample"
            }
        }
    }
}