Creación de un registro con la AWS CLI en Mensajes SMS para usuarios finales de AWS

Utilice el comando create-registration para crear un registro nuevo en blanco. El parámetro Tipo de registro determina el tipo de registro que se va a crear. Si desconoce el valor del tipo de registro que desea crear, utilice el comando describe-registration-type-definitions para recuperar una lista de todos los tipos de registro.

Los siguientes ejemplos muestran cómo crear un formulario de registro de número gratuito.

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

Al completarlo correctamente, guarde el valor de ID de registro, ya que se necesitará para otros comandos.

El siguiente ejemplo es el resultado parcial del comando describe-registration-type-definitions. Dado que Comportamiento de asociación está configurado en ASSOCIATE_BEFORE_SUBMIT, el número gratuito debe adquirirse y asociarse al registro a fin de poder enviar el registro para su aprobación. Para obtener más información sobre Comportamiento de asociación y Desasociación de comportamiento, consulte Asociación admitida.

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

A continuación, debe obtener las definiciones de cada campo para saber cuáles son los requisitos, como el número máximo de caracteres del campo.

Cada registro está dividido en secciones y cada sección tiene uno o varios campos. Utilice el comando describe-registration-field-definition para recuperar todas las definiciones de secciones y campos de un registro. Más adelante necesitará la Ruta de cada campo para poder establecer su valor. Además, Requisito de campo se utiliza para determinar si un campo será obligatorio u opcional.

En los siguientes ejemplos se muestra cómo recuperar definiciones de campo del formulario de registro de número gratuito.

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

A continuación, se muestra un ejemplo de salida parcial del comando:

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

Dependiendo del registro, es posible que deba completar y adjuntar una carta de autorización (LOA), un flujo de trabajo opcional u otro tipo de documento obligatorio. Compruebe el registro individual para obtener más información y descargar cualquier formulario.

Utilice el comando create-registration-attachment para crear el archivo adjunto de registro. Puede cargar el archivo en un bucket de Amazon S3 y utilizar la URL o adjuntar el documento como parte del comando. Utilice URL de archivo adjunto o Cuerpo de archivo adjunto. Si se especifican ambos, se devolverá una excepción. El tamaño máximo del archivo es de 500 KB y las extensiones de archivo admitidas son PDF, JPEG y PNG.

En el siguiente ejemplo se muestra cómo crear el archivo adjunto de registro y cómo utilizar el parámetro URL de archivo adjunto.

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

Al completarlo correctamente, el comando devuelve un ID de registro de archivo adjunto que se necesita para otros comandos.

Para obtener más información sobre los comandos de Amazon S3, como la creación de un bucket o la carga de un archivo, consulte Uso de comandos de alto nivel (s3) con la AWS CLI.

A continuación, debe agregar valores para todos los campos obligatorios devueltos en el paso Obtención de las definiciones de campo, incluidos los archivos adjuntos que haya creado. Le recomendamos que también complete todos los campos opcionales aplicables a su caso de uso. Un campo es obligatorio u opcional en función del valor de Requisito de campo. Utilice el comando put-registration-field-value para configurar los valores de campos.

Ahora tiene que solicitar una identidad de origen que luego se asociará al registro. En este ejemplo se muestra cómo utilizar el comando request-phone-number para solicitar un número de teléfono gratuito a través de la AWS CLI. Use request-sender-id para solicitar un ID de remitente.

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

Al completarlo correctamente, el comando devuelve el identificador único de número de teléfono necesario para asociar el número de teléfono al registro.

Para asociar una identidad de origen al registro, utilice el comando create-registration-association de la AWS CLI.

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

En el comando anterior, sustituya lo siguiente:

Una vez que envíe el registro, no podrá modificarlo. Revíselo para asegurarse de que todos sus datos son correctos antes de enviarlo.

Para enviar un registro con la AWS CLI, utilice el comando submit-registration-version.

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

En el comando anterior, sustituya lo siguiente:

Una vez que se haya enviado el registro, podrá comprobar su estado mediante el comando describe-registrations o la consola.

Si el Comportamiento del registro es ASSOCIATE_AFTER_COMPLETE, puede adquirir una identidad de origen y asociarla al registro, una vez que el estado del registro esté configurado como COMPLETADO.

Si el estado de su registro cambia a REQUIRES_UPDATES, podrá buscar y editar los campos marcados y volver a enviar el registro. Para ver una lista de los motivos por los que se ha rechazado el registro, consulte Ayuda con los rechazos de registro. Si necesita ayuda de Soporte sobre el rechazo de su registro, puede abrir un ticket.