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:
- Criar um caso de uso de campanha A2P para um Messaging Service
- Buscar um caso de uso de campanha A2P para um Messaging Service
- Ler uma lista de casos de uso de campanha A2P para um Messaging Service
- Excluir um caso de uso de campanha de A2P para um Messaging Service
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
|
A string exclusiva que identifica um recurso de conformidade A2P dos EUA |
account_sid
|
O SID da Account (Conta) à qual a Campanha pertence. |
brand_registration_sid
|
A string exclusiva para identificar a marca A2P. |
messaging_service_sid
|
O SID do Messaging Service ao qual o recurso está associado. |
description
|
A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters. |
message_samples
|
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
|
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
|
Indica que esta campanha de SMS enviará mensagens que contêm links. |
has_embedded_phone
|
Indica que esta campanha de SMS enviará mensagens que contêm números de telefone. |
campaign_status
|
Status da campanha. Exemplos: IN_PROGRESS (EM ANDAMENTO), VERIFIED (VERIFICADA), FAILED (FALHOU). |
campaign_id
|
O ID da Campanha do TCR (The Campaign Registry, o registro da campanha). |
is_externally_registered
|
Indica se a campanha foi registrada externamente ou não. |
rate_limits
|
Limite de taxa e/ou classificação definido por cada operadora, ex. AT&T ou T-Mobile. |
message_flow
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
A data e a hora em GMT quando o recurso foi criado especificadas no formato ISO 8601 |
date_updated
|
A data e a hora em GMT quando o recurso foi atualizado pela última vez especificada no formato ISO 8601. |
url
|
O URL absoluto do recurso App to Person dos EUA. |
mock
|
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
https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p
Parameters
| Parameters in REST API format | |
|---|---|
messaging_service_sid
Path
|
O SID do Messaging Service de onde create (criar) os recursos. |
brand_registration_sid
Required
|
SID de registro da marca A2P |
description
Required
|
A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters. |
message_flow
Required
|
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
|
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
|
Caso de uso da campanha A2P. Exemplos: [ 2FA, EMERGENCY, MARKETING..] |
has_embedded_links
Required
|
Indica que esta campanha de SMS enviará mensagens que contêm links. |
has_embedded_phone
Required
|
Indica que esta campanha de SMS enviará mensagens que contêm números de telefone. |
opt_in_message
Optional
|
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
|
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
|
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
|
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
|
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
|
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
Buscar um caso de uso de campanha A2P nos EUA
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
|
O SID do Messaging Service para fetch (buscar) o recurso. |
sid
Path
|
O SID do recurso de conformidade A2P dos EUA para fetch (buscar) |
Example 1
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:
- Etapa 3 Criar uma marca A2P nos EUA no passo a passo da API padrão de ISV
- Etapa 3 Criar uma marca A2P nos EUA no passo a passo da API inicial de ISV
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
Ler uma lista de casos de uso de campanha A2P nos EUA
https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p
Parameters
| Parameters in REST API format | |
|---|---|
messaging_service_sid
Path
|
O SID do Messaging Service para fetch (buscar) o recurso. |
Example 1
Excluir um caso de uso de campanha A2P nos EUA
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
|
O SID do Messaging Service de onde delete (excluir) o recurso. |
sid
Path
|
O SID do recurso de conformidade A2P dos EUA para delete (excluir) |
Example 1
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.
