/message/create
Envía o programa el envío de una campaña o un email de automatización.
| Parámetros | |
|---|---|
| Nombre | Descripción |
| type string |
Tipo de mensaje, puede ser “campaign” para campañas, o “automation” para crear un mensaje para usar con automatización. |
| name string |
Nombre de campaña o email de automatización. |
| html string |
Código HTML del email (opcional). |
| text string |
Texto opcional para ser enviado (opcional). |
| html_url string |
URL para obtener el cuerpo HTML. Si se define URL, el parámetro “html” será ignorado. (opcional) |
| subject string |
Asunto del email. |
| from_mail string |
Dirección de email del remitente. |
| from_name string |
Nombre del remitente. |
| track_opens string |
Si desea o no hacer seguimiento de aperturas (opcional). |
| track_clicks string |
Si desea o no hacer seguimiento de clicks (opcional). |
| auto_text string |
Si desea o no generar la parte texto en base al HTML. (salvo que se especifique el texto alternativo) (opcional). |
| auto_html string |
Si desea o no generar la parte HTML en base al texto. (Salvo que se especifique el HTML). (opcional) |
| g_analytics string |
Si se desea o no convertir los enlaces para integrarlos con Google Analytics (opcional). |
| clicktale string |
Si se desea o no convertir los enlaces para integrarlos con ClickTale (opcional). |
| reply_to string |
Dirección de email para recibir las respuestas de sus emails (opcional). |
| list_id string |
Destinatarios. Array con 1 o más elementos que contienen los ID de las listas de destinatarios. |
| segmentation_id string |
ID de la segmentación a utilizar para filtrar las listas de destinatarios (opcional). |
| send_at string |
Día y horario de envío. Deje en blanco para enviar inmediatamente. Formato: YYYY-MM-DD HH:MM:SS También puede especificar su zona horaria. Por ejemplo: “2017-03-18 15:45:00 +0500” Limite: 30 días en el futuro |
| 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 | |
|---|---|
| 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.