You are viewing the Portuguese (Brazil) site, but your language preference is set to English. Switch to English site →

Menu

Expand
Classifique esta página:

Recurso de campanha App to Person nos EUA

Este recurso está relacionado ao registro de A2P 10DLC nos Estados Unidos. Para obter mais informações sobre o registro de A2P 10DLC, consulte nosso artigo de suporte O que é A2P 10DLC?

O recurso de campanha A2P (App to Person) nos EUA permite criar um caso de uso de campanha A2P nos EUA para um Messaging Service.

Um caso de uso de campanha A2P pode ser visto como um caso de uso para sua marca que mostrará a intenção das mensagens enviadas com seu Messaging Service. Alguns exemplos de casos de uso de campanha A2P são:

  • Marketing por mensagens
  • Notificações
  • Mensagens de verificação

Com esta API REST, você pode:

Este recurso faz parte do processo de registro de A2P 10DLC. Para fornecedores de software independentes (ISVs), consulte o guia de registro de API A2P 10DLC de ISV para obter um passo a passo sobre como registrar seus clientes para A2P 10DLC.

Propriedades do recurso de campanha App to Person nos EUA

Resource Properties in REST API format
sid
sid<QE> Not PII

A string exclusiva que identifica um recurso de conformidade A2P dos EUA QE2c6890da8086d771620e9b13fadeba0b.

account_sid
sid<AC> Not PII

O SID da Account (Conta) à qual a Campanha pertence.

brand_registration_sid
sid<BN> Not PII

A string exclusiva para identificar a marca A2P.

messaging_service_sid
sid<MG> Not PII

O SID do Messaging Service ao qual o recurso está associado.

description
string Not PII

A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.

message_samples
string[] Not PII

Message samples, at least 1 and up to 5 sample messages (at least 2 for starter/sole proprietor), >=20 chars, <=1024 chars each.

us_app_to_person_usecase
string Not PII

Caso de uso da campanha A2P. Exemplos: [ 2FA, EMERGENCY, MARKETING, STARTER...]. Os casos de uso da campanha INICIAL só podem ser criados pelas marcas INICIAIS, e só pode haver uma campanha INICIAL criada por marca INICIAL.

has_embedded_links
boolean Not PII

Indica que esta campanha de SMS enviará mensagens que contêm links.

has_embedded_phone
boolean Not PII

Indica que esta campanha de SMS enviará mensagens que contêm números de telefone.

campaign_status
string Not PII

Status da campanha. Exemplos: IN_PROGRESS (EM ANDAMENTO), VERIFIED (VERIFICADA), FAILED (FALHOU).

campaign_id
string Not PII

O ID da Campanha do TCR (The Campaign Registry, o registro da campanha).

is_externally_registered
boolean Not PII

Indica se a campanha foi registrada externamente ou não.

rate_limits
object Not PII

Limite de taxa e/ou classificação definido por cada operadora, ex. AT&T ou T-Mobile.

message_flow
string Not PII

Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum.

opt_in_message
string Not PII

If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear description of how to opt-out. This field is required if end users can text in a keyword to start receiving messages from this campaign. 20 character minimum. 320 character maximum.

opt_out_message
string Not PII

Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include the brand name. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.

help_message
string Not PII

When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.

opt_in_keywords
string[] Not PII

If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum.

opt_out_keywords
string[] Not PII

End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.

help_keywords
string[] Not PII

End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.

date_created
date_time<iso8601> Not PII

A data e a hora em GMT quando o recurso foi criado especificadas no formato ISO 8601

date_updated
date_time<iso8601> Not PII

A data e a hora em GMT quando o recurso foi atualizado pela última vez especificada no formato ISO 8601.

url
url Not PII

O URL absoluto do recurso App to Person dos EUA.

mock
boolean Not PII

Um booleano que especifica se a campanha é uma simulação ou não. As campanhas simuladas serão criadas automaticamente se você usar uma marca simulada. As campanhas simuladas só devem ser usadas para fins de teste.

Criar um caso de uso de campanha A2P nos EUA

post
https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p
Parameters
Parameters in REST API format
messaging_service_sid
Path
post sid<MG> Not PII

O SID do Messaging Service de onde create (criar) os recursos.

brand_registration_sid
Required
post sid<BN> Not PII

SID de registro da marca A2P

description
Required
post string Not PII

A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.

message_flow
Required
post string Not PII

Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum.

message_samples
Required
post string[] Not PII

Message samples, at least 1 and up to 5 sample messages (at least 2 for sole proprietor), >=20 chars, <=1024 chars each.

us_app_to_person_usecase
Required
post string Not PII

Caso de uso da campanha A2P. Exemplos: [ 2FA, EMERGENCY, MARKETING..]

has_embedded_links
Required
post boolean Not PII

Indica que esta campanha de SMS enviará mensagens que contêm links.

has_embedded_phone
Required
post boolean Not PII

Indica que esta campanha de SMS enviará mensagens que contêm números de telefone.

opt_in_message
Optional
post string Not PII

If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear description of how to opt-out. This field is required if end users can text in a keyword to start receiving messages from this campaign. 20 character minimum. 320 character maximum.

opt_out_message
Optional
post string Not PII

Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include the brand name. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.

help_message
Optional
post string Not PII

When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.

opt_in_keywords
Optional
post string[] Not PII

If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum.

opt_out_keywords
Optional
post string[] Not PII

End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.

help_keywords
Optional
post string[] Not PII

End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.

Example 1
        
        
        

        Criar um caso de uso de campanha A2P nos EUA

        Buscar um caso de uso de campanha A2P nos EUA

        get
        https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}

        Exemplo 1: O valor de Sid sempre será o identificador de recurso de conformidade A2P nos EUA: QE2c6890da8086d771620e9b13fadeba0b.

        Parameters
        Parameters in REST API format
        messaging_service_sid
        Path
        get sid<MG> Not PII

        O SID do Messaging Service para fetch (buscar) o recurso.

        sid
        Path
        get sid<QE> Not PII

        O SID do recurso de conformidade A2P dos EUA para fetch (buscar) QE2c6890da8086d771620e9b13fadeba0b.

        Example 1
              
              
              

              Buscar um caso de uso de campanha A2P nos EUA

              Buscar uma lista de possíveis casos de uso de campanha A2P nos EUA

              Para buscar uma lista de possíveis casos de uso de campanha A2P nos EUA para um Messaging Service, forneça o BrandRegistrationSID (BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX) como exibido no Exemplo 2.

              Se você ainda não criou uma marca, consulte um dos seguintes guias de API de ISV A2P nos EUA sobre como fazer isso:

              Para obter mais informações sobre possíveis casos de uso de campanha para Messaging Services, vá para o recurso de caso de uso do Messaging Service de App to Person nos EUA.

              Example 2
                    
                    
                    

                    Buscar uma lista de possíveis casos de uso de campanha A2P nos EUA

                    Ler uma lista de casos de uso de campanha A2P nos EUA

                    get
                    https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p
                    Parameters
                    Parameters in REST API format
                    messaging_service_sid
                    Path
                    get sid<MG> Not PII

                    O SID do Messaging Service para fetch (buscar) o recurso.

                    Example 1
                          
                          
                          

                          Ler uma lista de casos de uso de campanha A2P nos EUA

                          Excluir um caso de uso de campanha A2P nos EUA

                          delete
                          https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}

                          Observação: O valor de Sid sempre será o identificador de recurso de conformidade A2P nos EUA: QE2c6890da8086d771620e9b13fadeba0b.

                          Parameters
                          Parameters in REST API format
                          messaging_service_sid
                          Path
                          delete sid<MG> Not PII

                          O SID do Messaging Service de onde delete (excluir) o recurso.

                          sid
                          Path
                          delete sid<QE> Not PII

                          O SID do recurso de conformidade A2P dos EUA para delete (excluir) QE2c6890da8086d771620e9b13fadeba0b.

                          Example 1
                                
                                
                                

                                Excluir um caso de uso de campanha A2P nos EUA

                                Classifique esta página:

                                Precisa de ajuda?

                                Às vezes, todos nós precisamos; a programação é difícil. Receba ajuda agora da nossa equipe de suporte, ou confie na sabedoria da multidão navegando pelo Stack Overflow Collective da Twilio ou buscando a tag Twilio no Stack Overflow.

                                      
                                      
                                      

                                      Obrigado pelo seu feedback!

                                      Selecione o(s) motivo(s) para seu feedback. As informações adicionais que você fornece nos ajudam a melhorar nossa documentação:

                                      Enviando seu feedback...
                                      🎉 Obrigado pelo seu feedback!
                                      Algo deu errado. Tente novamente.

                                      Obrigado pelo seu feedback!

                                      thanks-feedback-gif