View a markdown version of this page

Notify テンプレートの使用 - AWS エンドユーザーメッセージング SMS

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Notify テンプレートの使用

通知テンプレートは、OTP および検証メッセージを送信するための事前承認済みの AWSマネージドメッセージテンプレートです。テンプレートは、サポートされている国全体で事前に検証されています。使用可能なテンプレートから選択できますが、作成または変更することはできません。

テンプレートプロパティ

[テンプレート ID]

テンプレートの一意の識別子。

テンプレートのタイプ

ユースケースカテゴリ。現在、 CODE_VERIFICATION が利用可能です。

チャンネル

テンプレートがサポートするチャネル: SMSVOICE、またはその両方。

言語コード

テンプレートコンテンツの言語 (、、 などenesfr)。

サポートされている国

このテンプレートを使用できる国。

階層アクセス

このテンプレートを使用できる階層 (BASICADVANCED、またはその両方)。

[変数]

送信時に値を指定するテンプレートコンテンツのプレースホルダー。各変数には、名前、型、制約があります。のソースを持つ変数は、ユーザーが指定CUSTOMERする必要があります。のソースを持つ変数は自動的にSYSTEM入力されます。

コンテンツ

{{variable}} プレースホルダーを含むメッセージ本文。

テンプレートの表示

Console
  1. https://console.aws.amazon.com/sms-voice/ で AWS エンドユーザーメッセージング SMS コンソールを開きます。

  2. Notify 設定に移動し、Templates タブを選択します。

  3. すべてのテンプレートセクションには、使用可能なすべてのテンプレートが表示されます。プロパティフィルターを使用して、サポートされている国、言語コード、またはその他のプロパティでフィルタリングします。

AWS CLI

すべてのテンプレートを一覧表示します。

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

テンプレートタイプでフィルタリング:

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

チャネルでフィルタリングする:

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

国によるフィルタリング:

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

言語によるフィルタリング:

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

テンプレート変数

テンプレート変数は、メッセージコンテンツのプレースホルダーであり、メッセージを送信するときに指定した値に置き換えられます。各変数には次のメタデータがあります。

  • Type – 論理データ型: STRINGINTEGER、または BOOLEAN。タイプに関係なく、すべての値は API で文字列として渡されます。たとえば、整数値を として"42"、ブール値を として渡します"true"

  • 必須 – 変数を指定する必要があるかどうか。デフォルト値のない必須変数は、省略するとエラーが発生します。

  • ソースCUSTOMER (値を指定) または SYSTEM (自動入力)。

  • 制約 – 最大長、最小値/最大値、正規表現パターンなどの検証ルール。

デフォルトテンプレートの設定

Notify 設定でデフォルトのテンプレートを設定できます。テンプレート ID を指定せずにメッセージを送信すると、デフォルトのテンプレートが使用されます。デフォルトのテンプレートが設定されておらず、送信リクエストにテンプレート ID が指定されていない場合、リクエストは失敗します。

デフォルトのテンプレートを設定または変更するには、「」を参照してください通知設定の管理