Cree o importe una lista de contactos, diseñe un email o utilice alguna de las plantillas existentes y envíelo, así de simple. Tendrá un diagnóstico completo y detallado de todos los resultados.
Desde Colombia contáctenos con un click aquí
Documentación de API de arrobaMail (versión 2)
Introducción
La API (Interfaz de Programación de Aplicaciones) de arrobaMail te permitirá interactuar con la plataforma desde tu sitio web o aplicación externa que desee. Esta ofrece un conjunto de funciones y procedimientos que abstraen la lógica interna de arrobaMail para la facilidad de integración con aplicaciones más complejas o personalizadas.
Sin lugar a dudas esta API junto a la gestión de eventos Web poseen una solución extraordinaria aprovechando todo el poderío del eMail Marketing de arrobaMail.
Disponiendo de una cuenta como cliente de arrobaMail.com en el apartado "API e Integración" del set de Herramientas de la plataforma encontrará las credenciales de acceso al servicio tal lo muestra la siguiente imagen.
RESTful API
Esta es una API RESTfull. Todas las llamadas a la API deben ser hechas con HTTP POST y HTTP GET. En respuesta a las llamadas, la API devolverá su respuesta en formato JSON.
URL de la API
Todas las llamadas a la API se harán a la misma URL correspondiente a su cuenta. Puede consultar esta URL en “Información de cuenta” solapa “API”.
Aclaraciones previas
Dado que la URL de la API dependerá de la que corresponda a su cuenta, para todos los ejemplos en esta documentación utilizaremos el dominio “{SERVERURL}”. Te en cuenta que esta URL no existe, si no que es solo a modo ejemplo.
Estructura de esta documentación
Todas las llamadas a la API deben ser hechas con HTTP POST y HTTP GET.
En respuesta a las llamadas, la API devolverá su respuesta en formato JSON.
Cada acción esta resaltada. En cada apartado de acción, podrá encontrar una descripción o consideraciones a tener en cuenta, seguido de una tabla de parámetros de entrada, luego una tabla con información sobre los valores de retorno.
Más abajo una tabla con los posible errores y finalmente la información necesaria para entender más el uso de la acción. Algunos parámetros podrían necesitar de una ayuda adicional, en ese caso la encontrara al final del apartado.
Llamada a las funciones
Las funciones se determinan en la URL. Por ejemplo para crear una campaña llamaremos a la URL http://envios.arrobamail.com/api/2.0/message/create o al server que le corresponda a su cuenta, el formato seria:
http://{SERVERURL}/api/2.0/message/create
Si quisiéramos obtener las estadísticas del envío de una campaña llamaríamos a la URL
http://{SERVERURL}/api/2.0/message/stats
La URL de consulta es del tipo
http://{SERVERURL}/api/2.0/MODULO/ACCION
Autenticación
Todas las funciones de la API requieren uno o varios parámetros de identificación de su cuenta. Algunas funciones podrán requerir de su nombre de usuario y contraseña, que serán los mismo que utiliza para el acceso a la plataforma. Otras funciones requerirán una clave llamada “user_key” la cual puede encontrar en la sección “Herramientas -> API e integración”.
Parámetros |
|
login_username |
Nombre de usuario de acceso a la cuenta. |
login_password |
Contraseña de la cuenta |
listid |
Es el identificador de la lista. (Esta variable solo es requerida en el modulo de suscripción). ** |
user_key |
Cadena alfanumérica que identifica una cuenta de usuario. (Esta variable solo es requerida en el módulo de emails transaccionales). |
(**) Puede encontrar el identificador de cada lista en la sección “Herramientas -> API e integración” o en la configuración de la lista.
Manejo de errores
Siempre que se produzca un error, la API devolverá un “status” igual a “error”, un código de error y una descripción del mismo.
Por ejemplo:
{ |
Valores de respuesta |
|
status |
“error” |
error |
Código de error, numérico o alfanumérico. |
message |
Descripción de error |
Errores de API
Esta es una lista de los errores comunes en la API para cualquier modulo.
Codigos de error |
|
001001A |
No se ha proporcionado una user_key o la misma es inválida. |
001002A |
La cuenta de usuario se encuentra suspendida. |
001003E |
El módulo no existe. Verifique la URL de consulta. |
001004E |
La acción no existe. Verifique la URL de consulta. |
(**) Puede encontrar el identificador de cada lista en la sección “Herramientas -> API e integración” o en la configuración de la lista.
Módulos y operaciones
list |
Manipulación de listas
|
||||||||||||
message |
Manipulación de mensajes y campañas
|
||||||||||||
subscriber |
Manipulación de suscriptores
|
||||||||||||
txnemail |
Manipulación de emails transaccionales
|
||||||||||||
automation |
Manipulación automatizaciones
|
||||||||||||
form |
Manipulación formularios de suscripción
|
/list
Este modulo esta disponible para cualquier tipo de cuenta de usuario, regular o reseller.
Administra listas de suscriptores
Todos los parámetros deben ser pasados con POST.
La respuesta será en formato JSON.
/list/create
Parámetros |
||
Nombre |
Descripción |
Formato |
name |
Nombre de la lista |
Entre 3 y 60 caracteres alfanuméricos incluidos []-_*!@#.,/+ |
from_name |
Nombre del remitente |
3 a 60 caracteres alfanuméricos |
from_mail |
Email del remitente |
Formato válido de dirección de email |
Valores de retorno |
|
status |
“success” |
list_id |
Cadena alfanumérica con el ID de la lista creada |
Códigos de error
Errores |
|
U02301P |
La cuenta ya no permite la creación de más listas. Puede que haya alcanzado el limite máximo de listas permitidas o que el administrador no le permita crear listas. |
U02303D |
El nombre del remitente no ha sido ingresado |
U02303D |
La dirección de email remitente, from_mail no es válida |
/list/get
Parámetros |
||
Nombre |
Descripción |
Formato |
list_id |
ID de list |
String alfanumérico |
Valores de retorno |
||||||||||||||||||||||||
status |
“success” |
|||||||||||||||||||||||
list_data |
|
|||||||||||||||||||||||
Códigos de error
Errores |
|
U02401D |
No se encontró la lista con el list_id indicado |
Detalle de suscriptores
Desuscriptos: son aquellos suscriptores que han solicitado la desuscripción.
No confirmados: son aquellos suscriptores que se han suscripto vía formulario pero aun no validaron su dirección de email.
Bloqueados: son aquellos suscriptores que han denunciado un email como spam o bien el sistema detecto que la dirección de email es inexistente.
Fallidos: son aquellos suscriptores que han rechazado envíos 3 o más veces.
Invalidados: son los suscriptores fallidos más los bloqueados.
/list/delete
Parámetros |
||
Nombre |
Descripción |
Formato |
list_id |
ID de list |
String alfanumérico |
Valores de retorno |
|
status |
“success” |
Códigos de error
Errores |
|
U02401D |
No se encontró la lista con el list_id indicado |
/message
/message/create
Envía o programa el envío de una campaña o un email de automatización.
Parámetros |
|
Variable |
Descripción |
type |
Tipo de mensaje, puede ser “campaign” para campañas, o “automation” para crear un mensaje para usar con automatización. |
name |
Nombre de campaña o email de automatización. |
html |
Código HTML del email (opcional) |
text |
Texto opcional para ser enviado (opcional) |
html_url |
URL para obtener el cuerpo HTML. Si se define URL, el parámetro “html” será ignorado. (opcional) |
subject |
Asunto del email |
from_mail |
Dirección de email del remitente |
from_name |
Nombre del remitente |
track_opens |
Si desea o no hacer seguimiento de aperturas (opcional) |
track_clicks |
Si desea o no hacer seguimiento de clicks (opcional) |
auto_text |
Si desea o no generar la parte texto en base al HTML. (salvo que se especifique el texto alternativo) (opcional) |
auto_html |
Si desea o no generar la parte HTML en base al texto. (Salvo que se especifique el HTML). (opcional) |
g_analytics |
Si se desea o no convertir los enlaces para integrarlos con Google Analytics (opcional) |
clicktale |
Si se desea o no convertir los enlaces para integrarlos con ClickTale (opcional) |
reply_to |
Dirección de email para recibir las respuestas de sus emails (opcional) |
list_id |
Destinatarios. Array con 1 o más elementos que contienen los ID de las listas de destinatarios. |
segmentation_id |
ID de la segmentación a utilizar para filtrar las listas de destinatarios (opcional) |
send_at |
Día y horario de envío. Deje en blanco para enviar inmediatamente. |
Valores de retorno |
|
status |
“success” |
message_id |
ID numérico del mensaje creado |
date_start |
Fecha en que iniciará el envío en caso de ser una campaña. |
recipients |
Número de destinatarios en caso de ser una campaña. |
Códigos de error
Errores |
|
M05032D |
Debe especificar un tipo de mensaje, “campaign” o “automation” |
M05003D |
‘html_url’ es invalida o no se ha podido acceder a la misma |
M05026D |
No se puede obtener la información de la URL en ‘html_url’ |
M05004D |
‘from_mail’ no es una dirección de email válida |
M05031D |
‘segmentation_id’ no es válido o no ha sido encontrado. |
M05025D |
‘from_mail‘ no esta en su lista de remitente o no ha sido validado |
M05005D |
Debe proveer un nombre de remitente ‘from_name’ |
M05020D |
La línea de asunto debe contener entre 3 y 150 caracteres |
M05021D |
El nombre de campaña o nombre de mensaje de automatización “name”, debe contener entre 3 y 150 caracteres |
M05019D |
‘reply_to’ no es una dirección de email válida |
M05023D |
Debe proveer al menos una lista de destinatarios |
M05024D |
Una o más listas de destinatarios, no es válida |
M05010D |
El formato de fecha ‘sent_at’ no es válido |
M05011D |
‘send_at’ es en el pasado |
M05012D |
No puede programar un envío a más de 30 días en el futuro. |
M05028E |
No se ha podido crear el mensaje. |
M05030D |
No hay subscriptores que coincidan con los parámetros de selección. O bien las listas no contienen suscriptores activos o bien se aplico una segmentación en donde se filtran todos los suscriptores. |
M05029E |
No se ha podido crear el mensaje. |
Cuerpo del mensaje
El mensaje debe contener al menos uno de los 3 parámetros “html”, “text” o “html_url”. En caso de ingresar una URL valida, el parámetro “html” es reemplazado por el contenido de la URL ingresada.
Remitente
La dirección de email de remitente debe estar creada y validada en la plataforma para poder utilizarse en la creación de mensajes.
Listas de destinatarios
Para la creación de un mensaje de campaña, es necesario que indique al menos una lista de destinatarios. Las listas de destinatarios se definen como un array en el parámetro “list_id” donde cada elemento del array es un ID de lista. Los ID de lista se obtiene en la configuración de la lista o bien puede ver todos los IDs juntos en la sección “Herramientas -> API e integración”.
Fecha y hora de envío
Es posible programar en envío de la campaña para cualquier fecha y hora en el futuro. Para ellos puede definir la fecha y hora con el parámetro “send_at” usando alguno de estos formatos de fecha:
“YYYY-MM-DD HH:MM:SS +/-0000” o “YYYY-MM-DD HH:MM:SS”.
Para evitar la diferencia de horario por zona horaria, defina el huso horario según UTC, por ejemplo “2017-03-18 15:45:00 +0500”.
Si el parámetro “send_at” no es definido, el mensaje será programado para ser enviado 5 minutos después de su creación. En caso de que necesite hacer alguna modificación o haya cometido un error en la creación, dispone de este tiempo para hacer los arreglos necesarios.
/message/changeStatus
Esta acción puede detener un envío en curso, puede reanudar un envío detenido o iniciar inmediatamente el envío de una campaña programada a futuro. Solo aplica a campañas.
Parámetros |
|
Variable |
Descripción |
message_id |
ID numérico del mensaje. Puede ser mensaje de campaña.. |
status |
Nuevo estado del mensaje, al cual se quiere pasar. Puede ser “stop”, para detener un envío en curso, “restart” para reanudar un envío detenido o “send_now” para enviar inmediatamente un envío programado. |
Valores de retorno |
|
status |
“success” |
Códigos de error
Errores |
|
M05200D |
Estado no válido |
M05201D |
‘message_id’ inválido o no encontrado |
M05203D |
El mensaje no se esta enviando, no puede ser detenido. |
M05204D |
El mensaje no esta detenido, no se puede reanudar. |
M05205D |
El mensaje no esta programado, no se puede cambiar el estado para iniciarlo ahora. |
/message/list
Obtiene una lista de mensajes de campaña o de automatización
Parámetros |
|
Variable |
Descripción |
message_id |
ID numérico del mensaje. Puede ser mensaje de campaña o de automatización. |
type |
El sistema almacena los últimos datos de las estadísticas en memoria cache. Utilice este parámetro en TRUE para volver a calcular las estadísticas. Esto podría demorar un tiempo más en devolver el resultado. |
show |
Número de resultados a devolver. El número debe ser entre 1 y 50. Si se indica número mayor a 50 devolverá error. Por defecto serán 30 resultados. (opcional) |
start_at |
Número del índice del primer resultado. Este es un parámetro de paginación. (opcional) |
Valores de retorno |
|||||||||||||||||||||||||||||||||||||
total_results |
Número total de mensajes |
||||||||||||||||||||||||||||||||||||
returned_results |
Número total de mensajes devueltos en esta consulta |
||||||||||||||||||||||||||||||||||||
messages |
Array con la información de los mensajes devueltos en esta consulta
|
||||||||||||||||||||||||||||||||||||
Paginación de resultados
Esta función devolverá un número máximo de 50 resultados por consulta. En caso de necesitar obtener los mensajes siguientes al número 50, se debe utilizar el parámetro “start_at” donde se indica el número de primer resultado. Por ejemplo, de querer obtener los resultados de 51 al 100, se deben definir los parámetros “show”=50 y “start_at”=50
Códigos de error
Errores |
|
M05101D |
Mensaje no encontrado |
/message/stats
Envía o programa el envío de una campaña o un email de automatización.
Parámetros |
|
Variable |
Descripción |
message_id |
ID numérico del mensaje. Puede ser mensaje de campaña o de automatización. |
nocache |
El sistema almacena los últimos datos de las estadísticas en memoria cache. Utilice este parámetro en TRUE para volver a calcular las estadísticas. Esto podría demorar un tiempo más en devolver el resultado. |
Valores de retorno |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status |
Devuelve el estado actual del mensaje. “completed”, “scheduled”, “stopped”, “saved”, “sending”, “restarting” |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name |
Nombre del mensaje o campaña |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subject |
Asunto del mensaje o campaña |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recipients |
Número de destinatarios total. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from_name |
Nombre del remitente |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from_mail |
Email del remitente |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
track_opens |
Opción para seguimiento de aperturas. 1 define activado. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
track_clicks |
Opción para seguimiento de clicks. 1 define activado. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
g_analytics |
Opción para integración con Google Analytics. 1 define activado. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clicktale |
Opción para integración con ClickTale. 1 define activado. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
date_created |
Fecha de creación del mensaje en formato UNIX |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
date_start |
Fecha de inicio del envío del mensaje en formato UNIX. Solo para campañas. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
date_completed |
Fecha de envío completado en formato UNIX, solo para campañas. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lists |
Array de listas de destinatarios
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
stats |
Estadísticas del mensaje
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Códigos de error
Errores |
|
M05101D |
Mensaje no encontrado |
Estados del mensaje de campaña
“completed” El mensaje ha sido enviado a toda la lista de suscriptores.
“scheduled” el mensaje esta programado para ser enviado en la fecha determinada por el usuario.
“stopped” el mensaje se ha detenido y no continua enviándose. Permite reanudar el envío.
“sending” el mensaje esta actualmente enviándose a la lista de suscriptores. La estadística de envía indicara la cantidad y porcentaje de enviados.
“restarting” el mensaje ha sido reiniciado y esta en espera de continuar su envío.
“starting” el mensaje esta iniciando su envío.
Estadística de rechazados
En la variable stats.bounced se detallan los emails rechazados.
“type” define el tipo de rechazo, siendo “hard” y “soft” las categorías padre, donde “hard” son rechazados permanentes” y “soft” son rechazados temporales, como podría ser rechazado por casilla llena.
Los tipos “invalid” y “spam” son subcategorías de “hard” y “soft” respectivamente. “invalid” se refiere a los rechazados cuando la casilla de email no existe y “spam” se refiere a cuando el rechazo es a causa de que el email fue interpretado como SPAM. El sistema trata a los rechazados “spam” como temporales.
/txnemail
Este modulo esta disponible para cualquier tipo de cuenta de usuario, regular o reseller.
Envia emails transaccionales y obtiene sus estadísticas
Todos los parámetros deben ser pasados con POST.
La respuesta será en formato JSON.
/txnemail/send
Vea la documentación de SMTP para saber como hacer envíos transaccionales utilizando el protocolo SMTP.
Podrá enviar un email indicando sus parámetros o bien utilizar un email previamente creado o una campaña previamente creada. Para enviar un email con sus propios parámetros, utilice el parámetro “message”. Para enviar un email previamente creado, indique su identificador con el parámetro “templateID”. Para enviar un email de una campaña, indique su identificador con el parámetro “campaignID”.
En caso de que utilice una email previamente creado o una campaña, se obtendrán sus parámetros para crear un nuevo email a enviar.
El parámetro “message_id” le permite agrupar todos los emails del mismo tipo o grupo y así obtener una estadística conjunta de todos los emails enviados del mismo grupo.
Parámetros |
|||||||||||||||||||||||||||||||
Variable |
Descripción |
||||||||||||||||||||||||||||||
message |
Crea un nuevo mensaje con los siguientes parámetros
|
||||||||||||||||||||||||||||||
campaign_id |
Identificador de la campaña. (Opcional) |
||||||||||||||||||||||||||||||
to |
Destinatarios. Array con 1 o más elementos.
|
||||||||||||||||||||||||||||||
message_id |
Identificador del mensaje a enviar. Cadena de texto alfanumérica de 1 a 60 caracteres, incluidos los catacteres “.-_” y espacio |
||||||||||||||||||||||||||||||
headers |
Cabeceras adicionales de email. (Opcional)
|
||||||||||||||||||||||||||||||
send_at |
Día y horario de envío. Deje en blanco para enviar inmediatamente. |
||||||||||||||||||||||||||||||
custom_fields |
Definición de campos personalizados en el mensaje. (Opcional)
|
||||||||||||||||||||||||||||||
message_id y grupo de mensajes
Cada mensaje que envíe, tendrá un identificador (ID) único. Puede reutilizar este ID para agrupar todos los mensajes que envíe del mismo tipo o grupo y así tener una estadística unificada de todos los envíos.
Este ID es a elección y puede ser cualquier palabra alfanumérica sin espacios ni caracteres especiales.
Campos personalizados
Cuando envía una campaña previamente guardada en el sistema, puede utilizar campos personalizados para luego reemplazarlos por el valor correspondiente.
Los campos personalizados tiene el formato {{{$nombre_campo}}}
Por ejemplo, si necesita personalizar el nombre del destinatario, podría hacerlo de la siguiente manera:
En el cuerpo del mensaje se encuentra el texto {{{$nombre}}}
En el parámetro “custom_fields” define:
{“custom_fields”: [ {“field”: “nombre”, “value”: “John Smith”} ]}
De la misma manera que puede tener campos personalizados en el mensaje, también puede personalizar el email por casa destinatario.
Utilice la variable to[][custom_fields]
Ejemplo:
{ "to":[ |
Si necesita usar el nombre o dirección de email del destinatario en campos personalizados deberá usar las etiquetas {{{$to_name}}} y {{{$to_email}}} para nombre e email respectivamente.
Ejemplo de parámetros JSON
El siguiente ejemplo, contiene los parámetros para el envío de un email transaccional.
{ |
Ejemplo de consulta utilizando la librería net/http de php
(La librería net/http esta disponible en packagist.org para instalación via composer https://packagist.org/packages/net/http).
<?php |
/automation
/automation/create
Esta acción permite crear tareas automatizadas
Parámetros |
||
Nombre |
Descripción |
Formato |
name |
Nombre de para esta automatización |
3 a 60 caracteres alfanuméricos incluidos .,:-_@#!*+%&º |
trigger_event |
Evento que dispara la automatización |
subscribe | unsubscribe | open | click | event | aniversary |
valid_from |
Fecha de inicio de validez |
Fecha en formato unix_time |
valid_to |
Fecha de fin de validez |
Fecha en formato unix_time |
message_id |
ID del email o campaña |
Puede ser un string “any” para incluir cualquier mensaje, o un array de mensajes con el o los ID de cada uno. |
list_id |
IDs de las listas |
Puede ser un string “any” para incluir todas las listas, o un array de listas con el o los ID de cada lista. |
custom_field |
Campo a usar para el evento disparados “aniversary” |
Cadena de texto con el nombre del campo según se muestra en la sección de campos personalizados: Por ejemplo “{{{$pf_xdate_aniversario}}}” |
event_name |
Nombre del evento externo |
Cadena de texto alfanumérica incluidos .-_ |
event_value |
Valor del evento externo |
|
Valores de retorno |
|
status |
“success” |
automation_id |
ID alfanumérico de la automatización creada |
Códigos de error
Errores |
|
U10418D |
El nombre de la automatización no es válido |
U10430D |
La fecha valid_to no puede ser en el pasado |
U10430D |
La fecha valid_from no es válida. |
U10401D |
El evento disparados trigger_event no es válido. |
U10416D |
No se han definido acciones. Debe definir al menos una acción. |
U10402D |
Debe proveer al menos un ID de lista list_id para este evento disparador |
U10404D |
Una o más listas en list_id no son válidos |
U10403D |
list_id debe ser un array de ID’s o una string “any” |
U10405D |
Este evento disparador requiere definir list_id |
U10406D |
Este evento disparador requiere definir custom_field |
U10408D |
El custom_field no se encontró o no tiene un formato válido. |
U10407D |
El custom_field no se encontró |
U10409D |
Uno o más elementos de message_id no son válidos. |
U10410D |
Uno o más elementos de message_id no son válidos. |
U10411D |
message_id debe ser “any” o un array con los Id de mensaje |
U10412D |
message_id debe ser “any” o un array con los Id de mensaje |
U10412N |
No se encontró el enlace definido en link_id o no pertenece a este mensaje |
U10402D |
Este evento disparador requiere de list_id |
U10404D |
Uno o más elementos de list_id no son válidos |
U10403D |
list_id debe ser “any” o un array con los ID de lista |
U10414D |
event_name no es válidos. |
U10415D |
event_value no es válido |
U10426D |
Una o más acciones no son válidas |
U10421D |
message_id en uno de los elementos de acciones no es válido |
U10425D |
send_after id en uno de los elementos de acciones no es válido |
U10422D |
list_id en uno de los elementos de acciones no es válido |
U10423D |
‘url’ en uno de los elementos de acciones no es una url válida. |
U10424D |
‘segmentation_id’ en uno de los elementos de acciones no es válido o no fue encontrado |
Ayuda de parámetros
Toda acción de automatización se ejecuta al ocurrir un evento, que es el evento disparador.
El evento disparador se define con el parámetro “trigger_event” y los posibles valores son:
subscribe | unsubscribe | open | click | event | aniversary
/form
/form/create
Crea un formulario de suscripción
Parámetros |
||
Nombre |
Descripción |
Formato |
list_id |
ID de list a |
String alfanumérico |
include_name |
Si desea o no incluir el campo “nombre” en el formulario |
|
response_url |
URL para redirigir una vez procesada la solicitud |
Formato válidos de URL |
Valores de retorno |
|
status |
“success” |
form_html |
HTML del formulario codificado en BASE64 |
form_id |
ID del formulario creado |
styler_url |
URL del modulo para aplicar estilos al formulario |
Códigos de error
Errores |
|
F03301D |
No se encontró la lista con el list_id indicado |
F03302D |
La URL en ‘response_url” no es válida. |
Styler
Si lo desea puede utilizar nuestro modulo de estilos para aplicar estilos visuales al formulario. Ingrese a la URL devuelta en ‘styler_url” para cargar el formulario y podes aplicarle estilos.
Los estilos serán aplicados “inline” por lo que el formulario no requerirá de ningún archivo de estilos externo.
Puede copiar y pegar el código HTML resultante o bien obtenerlo vía javascript del elemento <textarea id=” form_html”>
Redireccionamiento
Por defecto, cuando una persona se suscriba vía formulario, será redirigida a una página genérica donde se informará el estado de su suscripción, por ejemplo si la suscripción se realizo o hay algún problema con los datos ingresados en el formulario.
De la misma manera, cuando la persona valide su dirección, también será dirigido a esta página genérica.
Si lo desea, puede indicar una URL en ‘response_url’ para que el sistema redirija a esa URL, y de esa manera las personas queden siempre en su sitio.
En esta URL le enviaremos datos adicionales de la operación, como ser la dirección de email y el código de respuesta. Estos datos son llamados Variables de retorno, y se adjuntara en la URL de la siguiente manera:
Si por ejemplo, su URL es "http://www.ejemplo.com/formResponse.php", el sistema direccionara a las personas a una URL de este tipo:
"Addr" será la dirección de email del suscriptor y "Resp" será el código de respuesta.
A continuación puede ver una tabla con los distintos códigos de respuesta y su significado:
1: No es posible procesar su solicitud.
2: Nombre requerido no ingresado.
3: La dirección de email ingresada no es correcta.
6: La dirección de email ingresada ya se encuentra en la lista.
8: La dirección de email a suscribir ya se encuentra en la lista esperando confirmación.
11: La dirección de email a suscribir fue desuscripta en el pasado.
21: Un email le ha sido enviado a su casilla %1 para confirmar la suscripción a la lista
23: La dirección %1 ha sido suscripta a la lista
25: Uno o mas datos requeridos no fueron ingresados
Más Información
- Introduccion a arrobaMail
- Descargar Tutorial
- Descargar Manual Básico
- Descargar Manual Avanzado
- Manual API para Integración
- ¿Cómo hacer un buen envío?
- ¿Cómo crear listas?
- ¿Cómo agregar un remitente?
- ¿Cómo hacer un mensaje?
- ¿Cómo enviar un mensaje?
- ¿Cómo evitar el falso SPAM?
- ¿Cómo ver las estadísticas?
- 10 Tips para lograr Éxito
- Recomendaciones útiles
