AWS End User Messaging SMS で AWS CLI を使用して登録を作成する

create-registration コマンドを使用して、新しい空の登録を作成します。RegistrationType パラメータによって、作成する登録のタイプが決まります。作成する登録タイプの値がわからない場合は、describe-registration-type-definitions コマンドを使用して、すべての登録タイプのリストを取得します。

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

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

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

以下は、describe-registration-type-definitions コマンドの部分的出力の例です。AssociationBehavior が ASSOCIATE_BEFORE_SUBMITに設定されているため、登録を承認の用に送信する前に、通話料無料番号を購入して登録と関連付ける必要があります。AssociationBehavior と DisassociationBehavior の詳細については、「SupportedAssociation」を参照してください。

{
    "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"
            }
        },
...

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

各登録はセクションに分割され、各セクションには 1 つ以上のフィールドがあります。describe-registration-field-definitions コマンドを使用して、登録のすべてのセクション定義とフィールド定義を取得します。値を設定できるようにするには、後で各フィールドの 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"
            }
        },
...

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

create-registration-attachment コマンドを使用して、登録アタッチメントを作成します。ファイルを 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」を参照してください。

次に、「フィールド定義を取得する」ステップで返されるすべての必須フィールドの値を追加する必要があります。これには、作成したアタッチメントが含まれます。ユースケースに該当する任意フィールドもすべて入力することをお勧めします。フィールドは、FieldRequirement 値に応じて必須またはオプションです。put-registration-field-value コマンドを使用して、フィールド値を設定します。

次に、後で登録に関連付けられる発信元 ID をリクエストする必要があります。この例では、request-phone-number コマンドを使用して、AWS CLI を通じて通話料無料の電話番号をリクエストする方法を示します。request-sender-id を使用して送信者 ID をリクエストします。

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

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

発信元 ID を登録に関連付けるには、create-registration-association AWS CLI コマンドを使用します。

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

前述のコマンドで、以下を置き換えます。

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

AWS CLI を使用して登録を送信するには、submit-registration-version コマンドを使用します。

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

前述のコマンドで、以下を置き換えます。

登録が送信されたら、describe-registrations コマンドまたはコンソールを使用してステータスを確認できます。

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

登録のステータスが REQUIRES_UPDATES に変更されると、フラグ付きフィールドを見つけて編集し、登録を再送信できます。登録拒否の理由のリストについては、「登録拒否に関するヘルプ」を参照してください。登録拒否について サポート のサポートが必要な場合は、チケットを開くことができます。