Recurso de campaña de aplicación a persona de EE. UU.
Este recurso está relacionado con el registro A2P 10DLC de Estados Unidos. Para obtener más información sobre el registro en A2P 10DLC, consulta nuestro artículo de soporte ¿Qué es A2P 10DLC?
El recurso de campaña Aplicación a persona (A2P) de EE. UU. te permite crear un caso de uso de la campaña A2P de EE. UU. para un servicio de mensajería.
Puedes considerar un caso de uso de la campaña A2P como un caso de uso de tu marca que mostrará la intención de los mensajes que envíes con tu servicio de mensajería. Algunos ejemplos de casos de uso de la campaña A2P son los siguientes:
- Mensajes de marketing
- Notificaciones
- Mensajes de verificación
Con esta API REST puedes hacer lo siguiente:
- Crear un caso de uso de campaña A2P para un servicio de mensajería
- Recuperar un caso de uso de campaña A2P para un servicio de mensajería
- Leer una lista de casos de uso de campaña A2P para un servicio de mensajería
- Eliminar un caso de uso de campaña A2P para un servicio de mensajería
Este recurso forma parte del proceso de registro de A2P 10DLC. Para proveedores de software independientes (ISV, por sus siglas en inglés), consulta la guía de registro de la API de ISV A2P 10DLC para obtener un tutorial paso a paso sobre cómo registrar a sus clientes en A2P 10DLC.
Propiedades de recursos de campaña de aplicación a persona de EE. UU.
| Resource Properties in REST API format | |
|---|---|
sid
|
La cadena única que identifica un recurso Compliance de A2P de EE. UU. “QE2c6890da8086d771620e9b13fadeba0b”. |
account_sid
|
El SID de la Account a la que pertenece la campaña. |
brand_registration_sid
|
La cadena única para identificar la marca de A2P. |
messaging_service_sid
|
El SID del [Messaging Service] (https://www.twilio.com/docs/messaging/services/api) al que está asociado el recurso. |
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 de la campaña de A2P. Ejemplos: [2FA, EMERGENCY, MARKETING, STARTER...]. Los casos de uso de la campaña STARTER solo los pueden crear las marcas de STARTER, y solo puede haber una campaña de STARTER creada por cada marca de STARTER. |
has_embedded_links
|
Indica que esta campaña de SMS enviará mensajes que contengan enlaces. |
has_embedded_phone
|
Indica que esta campaña de SMS enviará mensajes que contengan números de teléfono. |
campaign_status
|
Estado de la campaña. Ejemplos: IN_PROGRESS, VERIFIED, FAILED. |
campaign_id
|
El ID de campaña del registro de campaña (TCR). |
is_externally_registered
|
Indica si la campaña se registró externamente o no. |
rate_limits
|
Límite de velocidad o clasificación establecidos por cada operador móvil, p. ej., AT&T o 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
|
La fecha y hora en GMT en que se creó el recurso, especificadas en formato ISO 8601. |
date_updated
|
La fecha y hora en GMT en que se actualizó el recurso por última vez, especificadas en formato ISO 8601. |
url
|
La URL absoluta del recurso App a persona de EE. UU. |
mock
|
Un valor booleano que especifica si la campaña es una simulación o no. Las campañas simuladas se crearán automáticamente si se utiliza una marca simulada. Las campañas simuladas solo se deben utilizar con fines de prueba. |
Crear un caso de uso de la campaña US A2P
https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p
Parameters
| Parameters in REST API format | |
|---|---|
messaging_service_sid
Path
|
El SID del Messaging Service desde el que se crean los recursos. |
brand_registration_sid
Required
|
SID de registro de marca de 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 de la campaña de A2P. Ejemplos: [2FA, EMERGENCY, MARKETING...] |
has_embedded_links
Required
|
Indica que esta campaña de SMS enviará mensajes que contengan enlaces. |
has_embedded_phone
Required
|
Indica que esta campaña de SMS enviará mensajes que contengan números de teléfono. |
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
Recuperar un caso de uso de la campaña US A2P
https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}
Ejemplo 1: El valor Sid siempre será el identificador de recursos de cumplimiento de US A2P: QE2c6890da8086d771620e9b13fadeba0b.
Parameters
| Parameters in REST API format | |
|---|---|
messaging_service_sid
Path
|
El SID del Messaging Service desde el que se obtiene el recurso. |
sid
Path
|
El SID del recurso Compliance de A2P de EE. UU. para obtener “QE2c6890da8086d771620e9b13fadeba0b”. |
Example 1
Recupera una lista de posibles casos de uso de la campaña US A2P
Para obtener una lista de posibles casos de uso de la campaña US A2P en un servicio de mensajería, proporciona el BrandRegistrationSID (BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX) como se muestra en el ejemplo 2.
Si aún no has creado una marca, consulta una de las siguientes guías de API de ISV de US A2P para obtener información sobre cómo hacerlo:
- Paso 3 Crear una marca US A2P en el Tutorial de la API estándar de ISV
- Paso 3 Crear una marca US A2P en el Tutorial API de inicio de ISV
Para obtener más información sobre los posibles casos de uso de la campaña de los servicios de mensajería, dirígete al Recurso de casos de uso del servicio de mensajería de aplicación a persona de EE. UU.
Example 2
Leer una lista de casos de uso de la campaña US A2P
https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p
Parameters
| Parameters in REST API format | |
|---|---|
messaging_service_sid
Path
|
El SID del Messaging Service desde el que se obtiene el recurso. |
Example 1
Eliminar un caso de uso de la campaña US A2P
https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}
Nota: El valor Sid siempre será el identificador de recursos de cumplimiento de US A2P: QE2c6890da8086d771620e9b13fadeba0b.
Parameters
| Parameters in REST API format | |
|---|---|
messaging_service_sid
Path
|
El SID del [Messaging Service] (https://www.twilio.com/docs/messaging/services/api) desde el que se eliminará el recurso. |
sid
Path
|
El SID del recurso Compliance de A2P de EE. UU. para eliminar “QE2c6890da8086d771620e9b13fadeba0b”. |
Example 1
¿Necesitas ayuda?
Todos la necesitamos a veces; la programación es difícil. Obtén ayuda ahora de nuestro equipo de soporte, o recurre a la sabiduría de la multitud visitando Stack Overflow Collective de Twilio o navegando por la etiqueta de Twilio en Stack Overflow.
