Módulo content

1.Crear cuerpo de la campaña (HTML/Texto plano)

Servicio:

/content/edit

Recupera, crea o edita el cuerpo del e-mail de una campaña. Si el llamado al servicio es por GET, recupera la información del registro indicado por el parámetro CampaignID. Si es por POST Crea o actualiza los datos del registro indicado por el parámetro CampaignID

Parámetros:

ParámetroCampaignID
RequeridoSI
TipoNúmero Entero >0
ExplicaciónIdentificador de la campaña a recuperar
EjemploCampaignID=10
ParámetroURL
RequeridoNO
TipoURL
ExplicaciónDirección desde donde se obtendrá el contenido de la campaña. La URL debe estar encodeada como parámetro. (PHP: rawurlencode). Si este parámetro está presente, el contenido de la campaña será remoto y se ignorarán los parámetros HTML y PlainText
EjemploURL=http://misitio.com/modelo.html
ParámetroHTML
RequeridoNO
TipoCadena de Caracteres
ExplicaciónCuerpo del email en HTML
EjemploPlainText=mi contenido
ParámetroPlainText
RequeridoNO
TipoCadena de Caracteres
ExplicaciónCuerpo del email en texto plano. Utilizado por los clientes que no soporten HTML
EjemploPlainText=mi contenido
ParámetroRemoteUnsubscribeBlock
RequeridoNO
TipoNúmero Entero
ExplicaciónSi el parámetro URL está presente (campaña con contenido remoto) y se quiere personalizar el enlace para desuscribirse, se debe completar este parámetro con la etiqueta %UnSubscribe% que se reemplazará por el enlace de desuscripción
EjemploRemoteUnsubscribeBlock=Para desuscribirse de nuestra lista haga Click Aquí

Nota:

En el contenido del email debe estar presente un link de desuscripción a la lista de contactos.

Puede ser proporcionado de dos maneras:

a) Si el contenido ha sido proporcionado a través del parámetro URL (contenido remoto) debe indicarse en el parámetro RemoteUnsubscribeBlock el link de desuscripción.

b) Si el contenido ha sido proporcionado a través del parámetro HTML, éste debe contener el link de desuscripción conjuntamente con el contenido del email. Link de desuscipción: ‹span›Para desuscribirse de nuestra lista haga‹/span› ‹a href="%UnSubscribe%" target="_blank"›Click Aquí‹/a›

El link de desuscripción es obligatorio, en caso de no estar presente, la API devolverá el error errorMsg_unSubscribeTagMissing

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada es incorrecto, falta o es requerido. Tiene asociada una estructura del tipo "Parámetro inválido"=>"error"
errorMsg_unSubscribeTagMissing
En el cuerpo del contenido del email no se ha encontrado el link de desuscripción.
errorMsg_contentNotSaved
No se puede guardar el contenido de la campaña
errorMsg_campaignNotFound
No se puede encontrar la campaña

Estructura de Salida

content.CampaignID
ID de la campaña
content.URL
URL del contenido remoto
content.PlainText
Texto del cuerpo del e-mail de la campaña para clientes de correo que no soportan HTML
content.HTML
Cuerpo del HTML del email de la campaña
content.IsEmpty
1 si el cuerpo de la campaña esta vacío. (Sin URL, HTML ni PlainText)

** Solo se documentan los campos mas relevantes.

2.Listar plantillas

Servicio:

/template/gallery

Recupera el listado de plantilla

Parámetros:

ParámetroretrieveList
RequeridoNO
TipoCadena de caracteres
ExplicaciónDiseños de emails de tus campañas
EjemploretrieveList=defaulTemplates
Parámetrooffset
RequeridoNO
TipoNúmero Entero
ExplicaciónCantidad de registros a partir de los cuales empezar a recuperar el listado.
Ejemplooffset=10
Parámetrolimit
RequeridoNO
TipoNúmero Entero
ExplicaciónCantidad de registros a recuperar el listado.
Ejemplolimit=10
ParámetrofilterListByCategory
RequeridoNO
TipoArreglo de enteros
ExplicaciónGrupo de filtros de búsqueda por categoría general
EjemplofilterListByCategory[]=2
ParámetrofilterListByCategory2
RequeridoNO
TipoArreglo de enteros
ExplicaciónGrupo de filtros de búsqueda por colores
EjemplofilterListByCategory2[]=8

Nota:Cada uno de los filtros por categoría produce una búsqueda de tipo (OR); la combinación de los dos filtros produce una búsqueda de tipo (OR) AND (OR).Ej. SELECT ... WHERE ( 'filterListByCategory'=5 OR 'filterListByCategory'=7 ) AND ('filterListByCategory2'=16)

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requerido

Estructura de Salida

myTemplatesList.template[0].templateId
ID del registro (plantilla)
myTemplatesList.template[0].templateTitle
Título de la plantilla ( si el listado corresponde a los contenidos de campañas, es el título de la campaña )
myTemplatesList.template[0].templateThumbnail
Información sobre la captura en miniatura del diseño de la plantilla. La ruta (path) es relativa al dominio https://app.envialosimple.com . Si el listado corresponde a las plantillas predeterminadas debe agregar en entre el dominio y el path indicado, el prefijo mailing_templates del directorio de plantillas. Ej. https://app.envialosimple.com/mailing_templates/119/content-t.jpg
myTemplatesList.template[0].templateThumbnailZoom
Ruta relativa a la captura grande,si existe, del diseño de la plantilla. (las indicaciones relativas a la ruta son idénticas a las de la miniatura)

** Solo se documentan los campos mas relevantes.

3.Listar categorías de plantillas

Servicio:

/campaign/templatecategories

Recupera el listado de categorías que se utilizan para agrupar las plantillas

list.category[]Listado de categorías generales.

list.color[]Listado de categorías por color.

Estructura de Salida:

list.category[]
Listado de categorías generales
list.color[]
Listado de categorías por color
list.category[0].CategoryID
ID de la categoría
list.category[0].NameToken
Nombre de la categoría
list.category[0].HasIcon
Los nodos de tipo list.color poseen aquí una cadena de caracteres para utilizar como selectores CSS para identificar el color