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á. # Crie um registro usando o SMS AWS CLI no AWS End User Messaging A seção a seguir fornece exemplos de como criar, preencher e enviar um registro usando o AWS CLI. Para obter exemplos de como criar e enviar um registro de número de telefone gratuito usando python ou shell script, consulte [Automatizar mensagens para usuários AWS finais. Registros de números gratuitos nos EUA](https://aws.amazon.com/blogs/messaging-and-targeting/automate-us-tfn-registrations/). Os registros variam de país para país, alguns são formulários de uma única página, enquanto outros, como o 10DLC, podem exigir que vários formulários sejam enviados em uma ordem específica. Verifique o [registro individual](registrations.md) para obter detalhes sobre o pedido e se você precisar fazer o upload de alguma documentação de apoio, como uma Carta de Autorização (LOA). ## Contexto Alguns países exigem que você registre a identidade da sua empresa para poder adquirir uma identidade de origem e revisar as mensagens que você envia a destinatários em seu país. + As informações de registro fornecidas por você podem ser revisadas por terceiros. O terceiro varia de país para país, mas pode ser uma agência reguladora governamental ou uma operadora de celular que realiza a análise. + O tempo que a empresa terceirizada leva para revisar seu registro varia de acordo com o tipo de registro. ## Pré-requisitos Antes de começar, você deve: + Instale e configure o AWS CLI, consulte [Configurar a AWS CLI no Guia](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) do [AWS Command Line Interface usuário](https://docs.aws.amazon.com/cli/latest/userguide/). + E Conta da AWS com [permissões](security-iam.md) para usar SMS de mensagens de usuário AWS final na região de destino. + Um registro **AssociationBehavior**especifica a ordem em que um registro pode ser associado a uma identidade de origem e desassociado de uma identidade de origem, consulte. [SupportedAssociation](https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_SupportedAssociation.html) + `ASSOCIATE_BEFORE_SUBMIT` A identidade de origem deve ser fornecida ao enviar um registro. + `ASSOCIATE_ON_APPROVAL` Isso se aplica a todos os registros de ID de remetente. O ID do remetente será provisionado automaticamente assim que o registro for aprovado. + `ASSOCIATE_AFTER_COMPLETE` Isso se aplica aos registros de números de telefone quando você deve primeiro concluir um registro e depois associar um ou mais números de telefone. **Importante** Depois de comprar uma identidade de originação, ela é alterada, independentemente do status dos registros, consulte [Preços do AWS End User Messaging](https://aws.amazon.com/end-user-messaging/pricing/). Depois de enviar seu registro, você não poderá fazer nenhuma alteração no registro ou desassociar nenhum recurso do registro até que ele tenha sido revisado por terceiros e devolvido a você. A seguir estão os recursos adicionais para registros. + [Como criar um processo de aceitação de SMS compatível](https://aws.amazon.com/blogs/messaging-and-targeting/how-to-build-a-compliant-sms-opt-in-process-with-amazon-pinpoint/) + [10Práticas recomendadas de registro do DLC para enviar SMS com mensagens de usuário AWS final](https://aws.amazon.com/blogs/messaging-and-targeting/10dlc-registration-best-practices-to-send-sms-with-amazon-pinpoint/) # Criar um registro (comando create-registration) AWS CLI Use o comando [create-registration](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/create-registration.html) para criar um novo registro em branco. O **RegistrationType**parâmetro determina o tipo de registro a ser criado. Se você não souber o valor do tipo de registro que deseja criar, use o [describe-registration-type-definitions](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-registration-type-definitions.html)comando para recuperar uma lista de todos os tipos de registro. Os exemplos a seguir mostram como criar um formulário de registro de número gratuito. ``` $ aws pinpoint-sms-voice-v2 create-registration --registration-type US_TOLL_FREE_REGISTRATION --tags "Key=Name,Value=MyTFNRegistration" ``` Na conclusão bem-sucedida, salve o valor de, **RegistrationId**pois será necessário para outros comandos. **nota** Para adicionar um nome amigável ao seu registro, você deve adicionar uma tag com a **Chave** definida como **Name** e o **Valor** definido como o nome amigável a ser usado. Você também pode adicionar tags aos recursos para fins de cobrança. Consulte [Recursos de tags para faturamento](sms-billing-tag.md). O exemplo a seguir é a saída parcial do comando `describe-registration-type-definitions`. Como **AssociationBehavior**está definido como `ASSOCIATE_BEFORE_SUBMIT` o número gratuito, deve ser comprado e associado ao registro antes que o registro possa ser enviado para aprovação. Para obter mais informações sobre **AssociationBehavior**e **DisassociationBehavior**, consulte [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" } }, ... ``` # Obtenha as definições de campo (describe-registration-field-definitions AWS CLI comando) Em seguida, você precisa obter as definições de cada campo para saber quais são os requisitos, como o número máximo de caracteres do campo. Cada registro é dividido em seções e cada seção tem um ou mais campos. Use o [describe-registration-field-definitions](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-registration-field-definitions.html)comando para recuperar todas as definições de seção e campo para um registro. Posteriormente, você precisará do **FieldPath**para cada campo para poder definir seu valor. Também **FieldRequirement**é usado para determinar se um campo será obrigatório ou opcional. Os exemplos a seguir mostram como recuperar definições de campo para o formulário de registro de ligação gratuita. ``` $ aws pinpoint-sms-voice-v2 describe-registration-field-definitions --registration-type US_TOLL_FREE_REGISTRATION ``` A seguir está uma saída parcial do 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" } }, ... ``` # Criar anexos (comando) create-registration-attachment AWS CLI Dependendo do registro, talvez seja necessário preencher e anexar uma Carta de Autorização (LOA), um fluxo de trabalho opcional ou outro tipo de documento obrigatório. Verifique o [registro individual](registrations.md) para obter detalhes e baixar quaisquer formulários. Use o [create-registration-attachment](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/create-registration-attachment.html)comando para criar o anexo de registro. Você pode carregar o arquivo em um bucket do Amazon S3 e usar o URL ou anexar o documento como parte do comando. Use um **AttachmentUrl**ou **AttachmentBody**, se ambos forem especificados, uma exceção será retornada. O tamanho máximo do arquivo é 500 KB, e as extensões de arquivo válidas são PDF, JPEG e PNG. O exemplo a seguir mostra como criar o anexo de registro e usar o **AttachmentUrl**parâmetro. ``` $ aws pinpoint-sms-voice-v2 create-registration-attachment --attachment-url s3://BucketName/FileName ``` Após a conclusão bem-sucedida, o comando retorna um **RegistrationAttachmentID** que é necessário para outros comandos. Para obter mais informações sobre os comandos do Amazon S3, como criar um bucket ou fazer upload de um arquivo, consulte [Usar comandos de alto nível (s3) com a AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-services-s3-commands.html). # Defina os valores de definição de campo (put-registration-field-value AWS CLI comando) Em seguida, você precisa adicionar valores para todos os campos obrigatórios retornados da etapa *Obter as definições de campo*, incluindo todos os anexos que você criou. Recomendamos preencher os campos opcionais quando aplicável ao seu caso de uso. Um campo é obrigatório ou opcional, dependendo do **FieldRequirement**valor. Use o [put-registration-field-value](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/put-registration-field-value.html)comando para definir os valores do campo. + Os exemplos a seguir mostram como adicionar um valor ao nome da empresa ou ao valor do texto. ``` $ aws pinpoint-sms-voice-v2 put-registration-field-value --registration-id RegID --field-path companyInfo.companyName --text-value AnyCompany ``` No comando anterior, substitua o seguinte: + *RegID*Substitua pela ID de registro retornada da etapa *Criar um registro*. + *AnyCompany*Substitua pelo nome da sua empresa. + Os exemplos a seguir mostram como adicionar um valor a um campo selecionado. ``` $ aws pinpoint-sms-voice-v2 put-registration-field-value --registration-id RegID --field-path messagingUseCase.monthlyMessageVolume --text-choices SelectValue ``` No comando anterior, substitua o seguinte: + *RegID*Substitua pela ID de registro retornada da etapa *Criar um registro*. + *SelectValue*Substitua por um dos valores de opção do campo. Use o [describe-registration-field-definitions](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-registration-field-definitions.html)comando para obter as opções para apenas um campo: ``` 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" } ``` + Os exemplos a seguir mostram como adicionar um anexo. ``` $ aws pinpoint-sms-voice-v2 put-registration-field-value --registration-id RegID --field-path messagingUseCase.optInImage --registration-attachment-id RegistrationAttachmentID ``` No comando anterior, substitua o seguinte: + *RegID*Substitua pela ID de registro retornada da etapa *Criar um registro*. + *RegistrationAttachmentID*Substitua pelo ID do anexo de registro retornado na *etapa Criar anexos.* # Solicitar uma identidade de origem (request-phone-number AWS CLI comando) **nota** Depois que você adquirir uma identidade de origem, será cobrado por ela independentemente do status do registro, consulte [Preços do AWS End User Messaging](https://aws.amazon.com/end-user-messaging/pricing/). Se o registro **AssociationBehavior**`ASSOCIATE_AFTER_COMPLETE`for, você não precisará comprar ou associar a identidade de origem até que o registro tenha sido enviado e aprovado. Agora você precisa solicitar uma identidade de origem que será posteriormente associada ao registro. Este exemplo mostra como usar o [request-phone-number](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/request-phone-number.html)comando para solicitar um número de telefone gratuito por meio do. AWS CLI Use o [request-sender-id](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/request-sender-id.html)para solicitar um ID de remetente. ``` $ aws pinpoint-sms-voice-v2 request-phone-number --iso-country-code US --message-type TRANSACTIONAL --number-capabilities SMS --number-type TOLL_FREE ``` Após a conclusão bem-sucedida, o comando retorna o identificador exclusivo do número de telefone necessário para associar o número de telefone ao registro. # Associar um recurso a um registro (create-registration-association AWS CLI comando) **nota** Se o registro **AssociationBehavior**`ASSOCIATE_AFTER_COMPLETE`for, você não precisará comprar ou associar a identidade de origem até que o registro tenha sido enviado e aprovado. Para associar uma identidade de origem ao registro, use o [create-registration-association](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/create-registration-association.html) AWS CLI comando. ``` $ aws pinpoint-sms-voice-v2 create-registration-association --registration-id RegID --resource-id PhoneNumberID ``` No comando anterior, substitua o seguinte: + *RegID*Substitua pela ID de registro retornada da etapa *Criar um registro*. + *PhoneNumberID*Substitua pelo ID do número de telefone retornado na etapa *Solicitar uma identidade de origem*. **nota** Esse comando é usado para associar qualquer recurso aplicável ao registro. Por exemplo, ele pode ser usado para associar um registro de campanha de 10DLC a um registro de marca de 10DLC. # Envie seu registro (submit-registration-version AWS CLI comando) Depois de enviar seu registro, você não poderá fazer nenhuma alteração nele. Revise seu registro para garantir que todos os seus dados estejam corretos antes de enviá-los. **Importante** Depois que você enviar o seu registro, não será possível fazer qualquer alteração no registro ou desassociar quaisquer recursos dele até que ele seja analisado por uma terceira parte e devolvido a você. Para enviar um registro com o, AWS CLI use o [submit-registration-version](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/create-registration-association.html)comando. ``` $ aws pinpoint-sms-voice-v2 submit-registration-version --registration-id RegID ``` No comando anterior, substitua o seguinte: + *RegID*Substitua pela ID de registro retornada da etapa *Criar um registro*. ## Verifique o status de seus registros (comando AWS CLI describe-registrations) Depois que seu registro for enviado, você poderá verificar seu status usando o comando [describe-registrations](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-registrations.html) ou o [console](registrations-status.md). Se o registro **AssociationBehavior**for, `ASSOCIATE_AFTER_COMPLETE` você poderá comprar uma identidade de originação e associá-la ao registro, uma vez que o status do registro esteja definido como **CONCLUÍDO**. Se o status do seu registro for alterado para **REQUIRES\$1UPDATES**, você poderá encontrar e [editar os campos sinalizados](registrations-edit.md) e reenviar o registro. Para obter uma lista dos motivos da rejeição do registro, consulte[Feedback da Gen-AI sobre registros](registrations-genai-feedback.md). Se precisar de ajuda Suporte com a rejeição do seu registro, você pode [abrir um ticket](registrations-request-support.md).