View a markdown version of this page

Trabalhando com modelos de notificação - AWS SMS de mensagens para o usuário final

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á.

Trabalhando com modelos de notificação

Os modelos de notificação são modelos de mensagem AWS pré-aprovados e gerenciados para enviar mensagens OTP e de verificação. Os modelos são pré-validados em todos os países compatíveis. Você seleciona entre os modelos disponíveis, mas não pode criá-los ou modificá-los.

Propriedades do modelo

ID do modelo

Um identificador exclusivo para o modelo.

Tipo de modelo

A categoria do caso de uso. Atualmente, CODE_VERIFICATION está disponível.

Canais

Os canais que o modelo suporta:SMS,VOICE, ou ambos.

Código do idioma

O idioma do conteúdo do modelo (por exemplo,en,es,fr).

Países suportados

Os países em que esse modelo pode ser usado.

Acesso por níveis

Quais camadas podem usar esse modelo (BASICADVANCED, ou ambos).

Variáveis

Espaços reservados no conteúdo do modelo para o qual você fornece valores no momento do envio. Cada variável tem um nome, tipo e restrições. Variáveis com uma fonte de CUSTOMER devem ser fornecidas por você. As variáveis com uma fonte de SYSTEM são preenchidas automaticamente.

Conteúdo

O corpo da mensagem com {{variable}} espaços reservados.

Modelos de navegação

Console
  1. Abra o console SMS do AWS End User Messaging em https://console.aws.amazon.com/sms-voice/.

  2. Navegue até a configuração Notificar e escolha a guia Modelos.

  3. A seção Todos os modelos mostra todos os modelos disponíveis. Use o filtro de propriedades para filtrar por países compatíveis, código de idioma ou outras propriedades.

AWS CLI

Liste todos os modelos:

aws pinpoint-sms-voice-v2 describe-notify-templates

Filtrar por tipo de modelo:

aws pinpoint-sms-voice-v2 describe-notify-templates \ --filters Name=template-type,Values=CODE_VERIFICATION

Filtrar por canal:

aws pinpoint-sms-voice-v2 describe-notify-templates \ --filters Name=channels,Values=SMS

Filtrar por país:

aws pinpoint-sms-voice-v2 describe-notify-templates \ --filters Name=supported-countries,Values=US

Filtrar por idioma:

aws pinpoint-sms-voice-v2 describe-notify-templates \ --filters Name=language-code,Values=en

Variáveis de modelo

Variáveis de modelo são espaços reservados no conteúdo da mensagem que são substituídos por valores que você fornece ao enviar uma mensagem. Cada variável tem os seguintes metadados:

  • Tipo — O tipo lógico de dados:STRING,INTEGER, ouBOOLEAN. Todos os valores são passados como strings na API, independentemente do tipo. Por exemplo, passe um valor inteiro como "42" e um booleano como. "true"

  • Obrigatório — Se a variável deve ser fornecida. Variáveis obrigatórias sem um valor padrão causam um erro se forem omitidas.

  • Fonte — Ou CUSTOMER (você fornece o valor) ou SYSTEM (preenchido automaticamente).

  • Restrições — regras de validação, como comprimento máximo, minimum/maximum valor ou padrão de regex.

Definindo um modelo padrão

Você pode definir um modelo padrão em uma configuração do Notify. Quando você envia uma mensagem sem especificar uma ID de modelo, o modelo padrão é usado. Se nenhum modelo padrão for definido e nenhum ID de modelo for fornecido na solicitação de envio, a solicitação falhará.

Para definir ou alterar o modelo padrão, consulteGerenciando as configurações do Notify.