info@fleetmailer.com

Documentación sobre API

MANUAL PARA INTEGRADORES

/message/list

Obtiene una lista de mensajes de campaña o de automatización.

Parámetros
Nombre Descripción
message_id
integer		 ID numérico del mensaje. Puede ser mensaje de campaña o de automatización.
type
string		 Tipos: automation, campaign, split_sender, split_sender_all
show
integer		 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
integer		 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.

id ID numérico del mensaje.
name Nombre del mensaje o campaña.
subject Asunto del mensaje.
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. Solo aplica a campañas.
date_completed Fecha de envío completado en formato UNIX, solo para campañas. Solo aplica a campañas.
lists Array de listas de destinatarios. Solo aplica a campañas.

name Nombre de la lista.
list_id ID de la lista.
status Devuelve el estado actual del mensaje. “completed”, “scheduled”, “stopped”, “saved”, “sending”, “restarting”. Solo aplica a campañas.
stats Array con las estadísticas del mensaje. Se obtiene la misma estructura de array de datos que en la acción “/message/stats”.

 

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
M05101D Mensaje no encontrado.