Consultel - Documentación
Listas Negras
- ¿Que és una Lista Negra?
- Tipos de Lista Negra
- Añadir contactos a una Lista Negra.
- Importar contactos a una Lista Negra
- Exportar contactos de una Lista Negra
- Callback URL
¿Que és una Lista Negra?
Una Lista Negra es un listado de contactos, en el que los contactos que formen parte, no recibirán más comunicaciones desde nuestra plataforma. Existe una Lista Negra por cada uno de los servicios que ofrecemos:
- Lista Negra SMS
- Lista Negra Email
Puedes consultar que contactos están en cada una de las Listas Negras desde el Listado de Agendas de tu cuenta.
A diferencia de versiones anteriores de nuestra plataforma, un contacto que esté en una Lista Negra, no será eliminado de las demás agendas, ya que quizás, el contacto si quiere recibir comunicaciones desde otro canal.
Tipos de Lista Negra
Por cada uno de los servicios que dispone nuestra plataforma, dispones de una Lista Negra especifica para evitar comunicaciones no deseadas.
Lista Negra SMS
Añade contactos a la Lista Negra SMS para evitar que a un contacto se le envíe ningún SMS desde cualquiera de las aplicaciones de nuestra plataforma, tanto desde el portal como desde la API.
Lista Negra Email
Añade contactos a la Lista Negra de Email para evitar que un contacto pueda recibir emails desde cualquiera de las aplicaciones de nuestra plataforma, tanto desde el portal como desde la API.
Añadir contactos a una Lista Negra.
Se puede añadir contactos a las diferentes Listas Negras de diferentes formas.
Importar contactos a una Lista Negra
Puedes importar contactos masivamente a la Lista Negra que elijas si tienes una lista de contactos que quieres que no reciban más comunicaciones por el canal escogido. La importación se realiza a través de un archivo .txt, .csv o .xlsx
Para importar contactos masivamente a una de las Listas Negras, dirígete al Listado de Agendas de tu cuenta, escoge la Lista Negra en la cual quieres importar contactos, pulsa en el botón 'Opciones' y luego 'Importar contactos'. Si necesitas ayuda en como importar un archivo, puedes consultar la ayuda de Importar contactos
Exportar contactos de una Lista Negra
Puedes exportar contactos de la Lista Negra que elijas a un archivo .csv o .xlsx.
Para exportar contactos de una de las Listas Negras, dirígete al Listado de Agendas de tu cuenta, escoge la Lista Negra que quieres exportar, pulsa en el botón 'Opciones' y luego 'Exportar contactos'.
Callback URL
Puedes recibir, en la URL que nos indiques, una petición POST cada vez que se añada o elimine un contacto de cualquiera de las Listas Negras de la plataforma. De esta manera, podrás mantener actualizada tu base de datos.
Para habilitar esta opción, dirígite a la sección Bajas dentro de las Preferencias de tu cuenta.
La petición que te enviaremos será en formato JSON con los siguientes valores:
- channel [string]
- Indica el canal donde se produjo la baja
- Valores posibles:
- "sms"
- "voice"
- "mail"
- type [string]
- Indica el tipo de evento producido
- Valores posibles:
- "add_to_blacklist"
- "remove_from_blacklist"
- from [string]
- Indica desde donde se produjo el evento
- Valores posibles:
- "manual_action": Se generó editando manualmente el contacto.
- "import": Se generó desde una importación.
- "unsubscribe_form": Se generó desde el Formulario de Baja
- "premium": Se generó desde una aplicación PREMIUM
- "form": Se generó desde la opción de formularios gestionar agendas según respuestas
- "voice_response_code": Se generó desde la aplicación campañas de VOZ a través de un código de respuesta
- date [string]
- Indica la fecha en formato GMT que se produjo el evento.
- application_id [integer | NULL]
- Indica el ID de aplicación de nuestra plataforma que generó el evento.
- app_configuration_id [integer | NULL]
- Indica el ID de configuración de nuestra plataforma que generó el evento.
- contact_id [integer | NULL]
- Indica el ID del contacto de nuestra plataforma al que hace referencia el evento.
- contact_number [string | NULL]
- Indica el teléfono del contacto de nuestra plataforma al que hace referencia el evento.
- contact_email [string | NULL]
- Indica el email del contacto de nuestra plataforma al que hace referencia el evento.
- comment [string | NULL]
- Es el comentario que escribió el contacto desde el Formulario de Baja.
{
"channel" : "sms",
"type" : "add_to_blacklist",
"from" : "unsubscribe_form",
"date" : "2019-10-10 10:11:12",
"application_id" : 1,
"app_configuration_id" : 342,
"contact_id" : 2323,
"contact_number" : "34600100200",
"contact_email" : "contact1@myapp.com",
"comment" : null
}