

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

# AWS エンドユーザーメッセージング SMS AWS CLI で を使用して登録を作成する
AWS CLIを使用して登録を作成する

次のセクションでは、 AWS CLIを使用して登録を作成、入力、送信する方法の例を示します。Python またはシェルスクリプトを使用して通話料無料の電話番号登録を作成して送信する方法の例については、[「Automate AWS End User Messaging US toll-free Number Registrations](https://aws.amazon.com/blogs/messaging-and-targeting/automate-us-tfn-registrations/)」を参照してください。登録は国によって異なります。単一ページのフォームの場合もあれば、10DLC など、特定の順序で複数のフォームを送信する必要がある場合もあります。注文の詳細と、承認書 (LOA) などの関連ドキュメントをアップロードする必要がある場合は、[個々の登録](registrations.md)を確認してください。

## 背景


一部の国では、発信元 ID を購入し、その国の受信者に送信するメッセージを審査するために、自社の企業情報を登録する必要があります。
+ 提供された登録情報は、第三者によって確認される場合があります。第三者は国によって異なりますが、審査を実行する政府機関またはモバイルキャリアである可能性があります。
+ 第三者企業が登録を確認するのにかかる時間は、登録タイプによって異なります。

## 前提条件


開始するには、以下が必要です。
+ をインストールして設定します AWS CLI。[AWS Command Line Interface 「 ユーザーガイド](https://docs.aws.amazon.com/cli/latest/userguide/)[」の「AWS CLI の設定](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)」を参照してください。
+ ターゲットリージョンで AWS エンドユーザーメッセージング SMS を使用する[アクセス許可](security-iam.md) AWS アカウント を持つ 。
+ 登録の **AssociationBehavior** は、登録情報を発信元 ID に関連付けたり、発信元 ID から関連解除したりする際の順序を指定します。詳細は「[SupportedAssociation](https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_SupportedAssociation.html)」を参照してください。
  + `ASSOCIATE_BEFORE_SUBMIT` 登録を送信するときは、発信元 ID を指定する必要があります。
  + `ASSOCIATE_ON_APPROVAL` これはすべての送信者 ID 登録に適用されます。送信者 ID は、登録が承認されると自動的にプロビジョニングされます。
  + `ASSOCIATE_AFTER_COMPLETE` これは、最初に登録を完了し、後で 1 つ以上の電話番号を関連付ける必要がある電話番号の登録に適用されます。
**重要**  
登録ステータスに関係なく、発信元 ID を購入したら、「[AWS End User Messaging の料金](https://aws.amazon.com/end-user-messaging/pricing/)」を参照してください。  
登録を送信すると、第三者によって審査され、返送されるまで、登録を変更したり、リソースと登録の関連付けを解除したりすることはできません。

以下は、登録用の追加のリソースです。
+ [準拠した SMS オプトインプロセスを構築する方法](https://aws.amazon.com/blogs/messaging-and-targeting/how-to-build-a-compliant-sms-opt-in-process-with-amazon-pinpoint/)
+ [AWS エンドユーザーメッセージングで SMS を送信するための 10DLC 登録のベストプラクティス](https://aws.amazon.com/blogs/messaging-and-targeting/10dlc-registration-best-practices-to-send-sms-with-amazon-pinpoint/)

# 登録を作成する (create-registration AWS CLI コマンド)


[create-registration](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/create-registration.html) コマンドを使用して、新しい空の登録を作成します。**RegistrationType** パラメータによって、作成する登録のタイプが決まります。作成する登録タイプの値がわからない場合は、[describe-registration-type-definitions](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-registration-type-definitions.html) コマンドを使用して、すべての登録タイプのリストを取得します。

次の例は、通話料無料番号の登録フォームを作成する方法を示しています。

```
$ aws pinpoint-sms-voice-v2 create-registration --registration-type US_TOLL_FREE_REGISTRATION --tags "Key=Name,Value=MyTFNRegistration"
```

正常に完了したら、他のコマンドに必要な **RegistrationId** の値を保存します。

**注記**  
登録にフレンドリ名を追加するには、**[キー]** を「**Name**」に設定し、**[値]** をフレンドリ名に設定してタグを追加する必要があります。  
請求目的でリソースにタグを追加することもできます。「[請求用のリソースのタグ付け](sms-billing-tag.md)」を参照してください。

以下は、`describe-registration-type-definitions` コマンドの部分的出力の例です。**AssociationBehavior** が `ASSOCIATE_BEFORE_SUBMIT`に設定されているため、登録を承認の用に送信する前に、通話料無料番号を購入して登録と関連付ける必要があります。**AssociationBehavior** と **DisassociationBehavior** の詳細については、「[SupportedAssociation](https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_SupportedAssociation.html)」を参照してください。

```
{
    "RegistrationTypeDefinitions": [
        {
            "RegistrationType": "US_TOLL_FREE_REGISTRATION",
            "SupportedAssociations": [
                {
                    "ResourceType": "TOLL_FREE",
                    "IsoCountryCode": "US",
                    "AssociationBehavior": "ASSOCIATE_BEFORE_SUBMIT",
                    "DisassociationBehavior": "DISASSOCIATE_ALL_CLOSES_REGISTRATION"
                }
            ],
            "DisplayHints": {
                "Title": "US toll-free number registration"
            }
        },
...
```

# フィールド定義を取得する (describe-registration-field-definitions AWS CLI コマンド)


次に、各フィールドの定義を取得して、フィールドの最大文字数など、要件を把握する必要があります。

各登録はセクションに分割され、各セクションには 1 つ以上のフィールドがあります。[describe-registration-field-definitions](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-registration-field-definitions.html) コマンドを使用して、登録のすべてのセクション定義とフィールド定義を取得します。値を設定できるようにするには、後で各フィールドの **FieldPath** が必要になります。また、**FieldRequirement** は、フィールドが必須か任意かを判断するために使用されます。

次の例は、通話料無料登録フォームのフィールド定義を取得する方法を示しています。

```
$ aws pinpoint-sms-voice-v2 describe-registration-field-definitions --registration-type  US_TOLL_FREE_REGISTRATION
```

以下は、コマンドからの出力例です。

```
{
    "RegistrationFieldDefinitions": [
        {
            "SectionPath": "companyInfo",
            "FieldPath": "companyInfo.companyName",
            "FieldType": "TEXT",
            "FieldRequirement": "REQUIRED",
            "TextValidation": {
                "MinLength": 1,
                "MaxLength": 100,
                "Pattern": "^(?=\\s*\\S)[\\s\\S]+$"
            },
            "DisplayHints": {
                "Title": "Company name",
                "ShortDescription": "Legal name which your company is registered under.",
                "ExampleTextValue": "Example Corp"
            }
        },
...
```

# 添付ファイルの作成 (create-registration-attachment AWS CLI コマンド)


登録によっては、承認書 (LOA)、オプトインワークフロー、または別のタイプの必須ドキュメントを完了してアタッチする必要がある場合があります。[個々の登録](registrations.md)で詳細を確認し、フォームをダウンロードします。

[create-registration-attachment](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/create-registration-attachment.html) コマンドを使用して、登録アタッチメントを作成します。ファイルを Amazon S3 バケットにアップロードし、URL を使用するか、コマンドの一部としてドキュメントをアタッチできます。**AttachmentUrl** または **AttachmentBody** のいずれかを使用します。両方が指定されている場合、例外が返されます。最大ファイルサイズは 500 KB で、有効なファイル拡張子は PDF、JPEG、PNG です。

次の例は、登録アタッチメントを作成し、**AttachmentUrl** パラメータを使用する方法を示しています。

```
$ aws pinpoint-sms-voice-v2 create-registration-attachment --attachment-url s3://BucketName/FileName
```

正常に完了すると、他のコマンドに必要な **RegistrationAttachmentID** が返されます。

 バケットの作成やファイルのアップロードなどの Amazon S3 コマンドの詳細については、「[Use high-level (s3) commands with the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-services-s3-commands.html)」を参照してください。

# フィールド定義値を設定する (put-registration-field-value AWS CLI コマンド)


次に、「*フィールド定義を取得する*」ステップで返されるすべての必須フィールドの値を追加する必要があります。これには、作成したアタッチメントが含まれます。ユースケースに該当する任意フィールドもすべて入力することをお勧めします。フィールドは、**FieldRequirement** 値に応じて必須またはオプションです。[put-registration-field-value](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/put-registration-field-value.html) コマンドを使用して、フィールド値を設定します。
+ 次の例は、会社名またはテキスト値の値を追加する方法を示しています。

  ```
  $ aws pinpoint-sms-voice-v2 put-registration-field-value --registration-id RegID --field-path companyInfo.companyName --text-value AnyCompany
  ```

  前述のコマンドで、以下を置き換えます。
  + *RegID* を、「*登録を作成する*」ステップで返された登録 ID に置き換えます。
  + *AnyCompany* を会社名に置き換えます。
+ 次の例は、選択フィールドの値を追加する方法を示しています。

  ```
  $ aws pinpoint-sms-voice-v2 put-registration-field-value --registration-id RegID --field-path messagingUseCase.monthlyMessageVolume --text-choices SelectValue
  ```

  前述のコマンドで、以下を置き換えます。
  + *RegID* を、「*登録を作成する*」ステップで返された登録 ID に置き換えます。
  + *SelectValue* を、フィールドのオプション値の 1 つに置き換えます。

    [describe-registration-field-definitions](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-registration-field-definitions.html) コマンドを使用して、1 つのフィールドのみのオプションを取得します。

    ```
    aws pinpoint-sms-voice-v2 describe-registration-field-definitions --registration-type  US_TOLL_FREE_REGISTRATION --field-paths messagingUseCase.monthlyMessageVolume
    ```

    ```
    {
        "RegistrationFieldDefinitions": [
            {
                "SectionPath": "messagingUseCase",
                "FieldPath": "messagingUseCase.monthlyMessageVolume",
                "FieldType": "SELECT",
                "FieldRequirement": "REQUIRED",
                "SelectValidation": {
                    "MinChoices": 1,
                    "MaxChoices": 1,
                    "Options": [
                        "10",
                        "100",
                        "1,000",
                        "10,000",
                        "100,000",
                        "250,000",
                        "500,000",
                        "750,000",
                        "1,000,000",
                        "5,000,000",
                        "10,000,000+"
                    ]
                },
                "DisplayHints": {
                    "Title": "Monthly SMS volume",
                    "ShortDescription": "Estimated number of SMS messages which will be sent from this toll-free number each month."
                }
            }
        ],
        "RegistrationType": "US_TOLL_FREE_REGISTRATION"
    }
    ```
+ 次のコード例は、アタッチメントを追加する方法を示しています。

  ```
  $ aws pinpoint-sms-voice-v2 put-registration-field-value --registration-id RegID --field-path messagingUseCase.optInImage --registration-attachment-id RegistrationAttachmentID
  ```

  前述のコマンドで、以下を置き換えます。
  + *RegID* を、「*登録を作成する*」ステップで返された登録 ID に置き換えます。
  + *RegistrationAttachmentID* を、*アタッチメントの作成*ステップから返されたアタッチメント ID に置き換えます。

# 発信元 ID をリクエストする (request-phone-number AWS CLI コマンド)


**注記**  
登録ステータスに関係なく、発信元 ID を購入したら、「[AWS End User Messaging の料金](https://aws.amazon.com/end-user-messaging/pricing/)」を参照してください。  
登録の **AssociationBehavior** が `ASSOCIATE_AFTER_COMPLETE` の場合、登録が送信および承認されるまで、発信元 ID を購入または関連付ける必要はありません。

次に、後で登録に関連付けられる発信元 ID をリクエストする必要があります。この例では、[request-phone-number](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/request-phone-number.html) コマンドを使用して、 AWS CLIを通じて通話料無料の電話番号をリクエストする方法を示します。[request-sender-id](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/request-sender-id.html) を使用して送信者 ID をリクエストします。

```
$ aws pinpoint-sms-voice-v2 request-phone-number --iso-country-code US --message-type TRANSACTIONAL --number-capabilities SMS --number-type TOLL_FREE
```

正常に完了すると、電話番号を登録に関連付けるために必要な電話番号の一意の識別子が返されます。

# リソースを登録に関連付ける (create-registration-association AWS CLI コマンド)


**注記**  
登録の **AssociationBehavior** が `ASSOCIATE_AFTER_COMPLETE` の場合、登録が送信および承認されるまで、発信元 ID を購入または関連付ける必要はありません。

発信元 ID を登録に関連付けるには、[create-registration-association](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/create-registration-association.html) AWS CLI コマンドを使用します。

```
$ aws pinpoint-sms-voice-v2 create-registration-association --registration-id RegID --resource-id PhoneNumberID
```

前述のコマンドで、以下を置き換えます。
+ *RegID* を、「*登録を作成する*」ステップで返された登録 ID に置き換えます。
+ *PhoneNumberID* を、*発信元 ID のリクエスト*ステップから返された電話番号 ID に置き換えます。

**注記**  
このコマンドは、該当するリソースを登録に関連付けるために使用します。例えば、10DLC キャンペーン登録を 10DLC ブランド登録に関連付けるために使用できます。

# 登録を送信する (submit-registration-version AWS CLI コマンド)


登録を送信すると、登録を変更できなくなります。登録を確認して、送信する前にすべてのデータが正しいことを確認してください。

**重要**  
登録を送信すると、第三者によって審査され、返送されるまで、登録を変更したり、リソースと登録の関連付けを解除したりすることはできません。

を使用して登録を送信するには、 [submit-registration-version](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/create-registration-association.html) コマンド AWS CLI を使用します。

```
$ aws pinpoint-sms-voice-v2 submit-registration-version --registration-id RegID
```

前述のコマンドで、以下を置き換えます。
+ *RegID* を、「*登録を作成する*」ステップで返された登録 ID に置き換えます。

## 登録ステータスを確認する (describe-registrations AWS CLI コマンド)


登録が送信されたら、[describe-registrations](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-registrations.html) コマンドまたは[コンソール](registrations-status.md)を使用してステータスを確認できます。

登録の **AssociationBehavior** が `ASSOCIATE_AFTER_COMPLETE` の場合、登録のステータスが **COMPLETE** に設定されると、発信元 ID を購入して登録に関連付けることができます。

登録のステータスが **REQUIRES\$1UPDATES** に変更されると、[フラグ付きフィールドを見つけて編集](registrations-edit.md)し、登録を再送信できます。登録拒否の理由のリストについては、「[登録に関する Gen-AI フィードバック](registrations-genai-feedback.md)」を参照してください。登録拒否 サポート について からサポートが必要な場合は、[チケットを開く](registrations-request-support.md)ことができます。