Para comenzar a utilizar la API el primer paso siempre será la autenticación. La misma deberá invocarse únicamente al principio de la aplicación, y se generará un token que permitirá autenticar las futuras llamadas a las distintas funciones.

Este token tiene un tiempo de expiración de 30 minutos; una vez caducado el sistema deberá solicitarle a emBlue uno nuevo para poder continuar operando.

Fuera de la autentificación, todas las funciones para solicitar datos consultan a CheckConnection(). Si el resultado es verdadero la función va a poder ejecutar su rumbo normal, en caso contrario devolverá el error..

+ Initial WSDL: http://api.embluemail.com/Services/Emblue3Service.svc?wsdl
+ Para acceder por REST el endpoint indicado es http://api.embluemail.com/Services/Emblue3Service.svc/json
+ Los parámetros se deben pasar por POST en todas las funciones.
+ Consultas: integraciones@embluemail.com

Authenticate
Se realiza al principio de la aplicación. La misma generará otro token que permitirá autenticar las futuras llamadas a las distintas funciones
INPUT
User

Nombre de usuario

Pass Contraseña del usuario
Token Llave de acceso que emBlue le otorga a un usuario / cliente para poder realizar las consultas a la aplicación.
{

“User”: “embluemail@hotmail.com”,
“Pass”:”124″,
“Token”: ”aaaa-aaaa-aaaa-aaaa”

}

OUTPUT  Token dinámico {“Token”:”aaaa-aaaa-aaaa-aaaa”}

En caso de no existir la relación con el token enviado por la empresa o que no existe.

{“Token”:”” }

;

CheckConnection
Permite validar que el enlace establecido a emBlue continúe correctamente abierto.
INPUT Token (es el token dinámico devuelto por la función Authenticate) {
“Token”: ” aaaa-aaa-aa-aaaaa”
}
OUTPUT Result {“Result”:true}

 

En caso de pasado los 30 minutos:

{“Result”:false}

 

Si no existe la relación o el token, o si fallo {“Result”:false}

.

Problemas de conexión o errores . Net:

En caso de algún inconveniente que evite una respuesta del servicio se devuelve un JSON con las propiedades Code y Message. Esta última, es una cadena dinámica que especifica el error que ocurrió en el proceso, sea una excepción .NET o que la sesión esté caducada.

En caso de pasado los 30 minutos
{“Code”:1,”Message”:”Token incorrecto.”}

En caso de que el usuario no se puede loguear
{“Code”:1,”Message”:”Usuario no logueado.”}

Excepción .NET
{“Code”:1,”Message”:”La cadena de entrada no tiene el formato correcto.”}
{“Code”:1,”Message”:”Intento de dividir por cero.”}

Grupos:

Funciones que permiten realizas Altas, Bajas, Modificaciones y Listados con los grupos de emBlue.

NewGroup
Incorpora un nuevo Grupo de Usuarios.
INPUT
Name

Nombre del nuevo grupo

Token Token que otorga emBlue
{
“Name”: “GrupoCreadoDesdeAPI”,
“Token”: ” ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Grupo ID

ID del grupo creado

{“GroupId”:1953 }

En caso de que exista un grupo con el mismo nombre u otro inconveniente parecido:

{“GroupId”:0 }

.

RenameGroup
Renombra el Grupo de Usuarios.
INPUT
GroupId

Nombre del grupo que
queremos renombrar

Name Nombre que desea reemplazar
Token Token que otorga emBlue
{
“GroupId”: “1953”,
“Name”: ” GrupoRenombradoDesdeLaAPI “,
“Token”: ” ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result

Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente

{“Result”:true}

En caso de que exista un grupo con el mismo nombre u otro inconveniente parecido:

{“Result”:false}

.

DeleteGroup
Elimina el Grupo de Usuarios.
INPUT
GroupId

ID del grupo que se desea
borrar

Token Token que otorga emBlue
{
“GroupId”: “1953 “,
“Token”: ” ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result

Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente

{“Result”:true}

En caso de no poder eliminar el grupo:

{“Result”:false}

.

SearchGroup
Buscador de Grupos de Usuarios a partir de escribir todo o parte del nombre de los mismos
INPUT
Token

Token que le otorga emBlue

FirstResult

Variable que indica el primer resultado del lote de 100. Por ejemplo: si esta variable es 0 trae del 0 al 100. Si es 23 trae del 23 al 123.

Order Orden del listado, puede asc o desc con respecto al nombre. Por defecto es asc.
Search Cadena de búsqueda. Si es vacio trae todo. La búsqueda soporta wildcards al principio y al final de la cadena, por defecto toma ambos. 100 Registros
{
“Search”: “api”,
“Order”: “asc”,
“FirstResult”: “0”,
“Token”: “ZZZZZ-ZZZZ-ZZZZ-ZZZZZZ”
}
OUTPUT
Groups

Lista de grupos que contienen el string enviado de búsqueda. Por cada grupo las propiedades que devuelve son: ID del grupo, nombre, cantidad de contactos y cantidad de destinatarios (aquellos susceptibles de enviársele un mail a través de emBlue)

[{“GroupId”:712,”Name”:”Grupo 0001″,”NumberAdressees”:0,”NumberContacts”:23},{“GroupId”:1958,”Name”:”GrupoRenombrado”,”NumberAdressees”:0,”NumberContacts”:0},{“GroupId”:711,”Name”:”Otro Grupo”,”NumberAdressees”:0,”NumberContacts”:23}]

Si no encuentra ninguna coincidencia

[]

.

GetNameGroupById
Obtener el nombre del grupo a través del ID del mismo
INPUT
Token

Token que le otorga emBlue

GroupId ID del Grupo
{
“Token”: ” ZZZZZ-ZZZ-ZZ-ZZZZ “,
“GroupId”: “387”
}
OUTPUT
GroupData
Informacion del grupo compuesta por nombre y ID del mismo si es que existe.
“GroupId”:387,”Name”:”Verificados”}

En caso de no existir: {“GroupId”:0,”Name”: “0”}

Campos personalizados:

Funciones que obtiene los campos personalizados de la empresa.

ListCustomFields
Listado de Campos Personalizados que responden a determinado contacto.
INPUT
Token

Token que le otorga emBlue.

{
“Token”: ” ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Campos
Personalizados

Lista de campos personalizados, que contiene las siguientes propiedades: id y nombre.

[{“id”:”790″,”nombre”:”email”,”numero”:”0″},{“id”:”790″,”nombre”:”nombre”,”numero”:”1″},
{“id”:”791″,”nombre”:”apellido”,”numero”:”2″},
{“id”:”792″,”nombre”:”id_contacto”,”numero”:”3″},
{“id”:”793″,”nombre”:”sexo”,”numero”:”4″},
{“id”:”794″,”nombre”:”telefono_1″,”numero”:”5″},
{“id”:”795″,”nombre”:”telefono_2″,”numero”:”6″},
{“id”:”796″,”nombre”:”web_url”,”numero”:”7″},
{“id”:”797″,”nombre”:”linkedin”,”numero”:”8″},
{“id”:”798″,”nombre”:”facebook”,”numero”:”9″},
{“id”:”799″,”nombre”:”twitter”,”numero”:”10″},
{“id”:”800″,”nombre”:”direccion”,”numero”:”11″},
{“id”:”801″,”nombre”:”ciudad”,”numero”:”12″},
{“id”:”802″,”nombre”:”pais”,”numero”:”13″},
{“id”:”803″,”nombre”:”cumpleanios”,”numero”:”14″},
{“id”:”804″,”nombre”:”empresa”,”numero”:”15″},
{“id”:”805″,”nombre”:”cargo”,”numero”:”16″},
{“id”:”806″,”nombre”:”email_secundario”,”numero”:”17″},
{“id”:”807″,”nombre”:”id_trigger”,”numero”:”18″}]

.

GetInfoCustomField
Brinda información sobre un Campo Personalizado (como la cantidad de contactos que lo tienen completo, el nombre y el tipo de campo).
INPUT
Name

Nombre del nuevo
grupo

CustomFieldID ID del campo personalizado
{
“CustomFieldId”: “790”,
“Token”: ” ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Campos
personalizados

Lista de campos personalizados, que contiene las siguientes propiedades: id, nombre, tipo de campo, tipo de dato, tipo de opción, valores, si es fijo de emBlue y cantidad de contactos

{“id”:”790″,”nombre”:”nombre”,”tipoCampo”:”1″,”tipoDato”:”3″,”tipoOpcion”:”1″,”valores”:null,”esFijoEmblue”:true,” cantidadContactos”:0}

 

En caso de no existir el campo personalizado.

{“id”:”0″,”nombre”:null,”tipoCampo”:null,”tipoDato”:null,”tipoOpcion”:null,”valores”:null,”esFijoEmblue”:false,”cantidadContactos”:0}

.

Descripción de las propiedades de los campos personalizados:

Propiedades de Campos Personalizados
id Entero que especifica la identidad del campo numérico.
Nombre Nombre del campo personalizado
Tipo de campo Normal = 1, Extendido = 2
TipoDato Fecha = 1, Numérico = 2, Alfanumérico = 3, Email = 4, Sexo = 5, País = 6
TipoOpcion Ninguno = 1, Radio = 2, Combo = 3
Valores Los valores posibles separados por punto y coma. Por ejemplo en un campo de sexo serian M;F
EsFijoemBlue Si es fijo de emBlue o no. Los fijos son: nombre, apellido, id_contacto, sexo, telefono_1, telefono_2, web_url, linkedin, facebook, twitter, dirección, ciudad, país, cumpleanios, empresa y cargo.
CantidadContactos Cantidad de contactos que tienen editados el campo personalizado.

.

Contactos:

Funciones que permiten realizar Altas, Bajas, Modificaciones y Listados de los contactos en emBlue.

SearchContact
Buscador de contactos a partir de escribir toda la dirección de correo electrónico o parte de ella.
INPUT
Token

Token que le otorga emBlue

FirstResult

Variable que indica el primer resultado del lote de 100. Por ejemplo: si esta variable es 0 trae del 0 al 100. Si es 23 trae del 23 al 123.

Order Orden del listado, puede asc o desc con respecto al nombre. Por defecto es asc.
Search Cadena de búsqueda. Si es vacio trae todo. La búsqueda soporta wildcards al principio y al final de la cadena, por defecto toma ambos. 100 Registros
GroupId Especifica el grupo desde donde obtener un listado de contactos 0 (cero) o nulo omite el filtro y busca independientemente de los grupos.
 

 

{

“Search”: “embluemail”,
“Order”: “desc”,
“GroupId”: “0”,
“Token”: “zzzzzzzz-zzzzzzz-zzzzzz”
}

OUTPUT
Contactos

Lista de emails que contienen el cadena enviada en la búsqueda. Por cada contacto las propiedades que devuelve del email son: EmailId y Email.

Search=embluemail&Order=desc&GroupId=0

[{“Email”:”embluemail@hotmail.com”,”EmailId”:48},{“Email”:”embluemail@gmail.com”,”EmailId”:27}]

Search=&Order=asc&GroupId=351

[{“Email”:”csuarez@pragmore.com”,”EmailId”:4},{“Email”:”cynthia.l@emBluemail.com”,”EmailId”:5},{“Email”:”damian.c@emBluemail.com”,”EmailId”:6},{“Email”:”daniel@emBluemail.com”,”EmailId”:7},{“Email”:”daniel@pragmore.com”,”EmailId”:8},{“Email”:”eduardo.s@emBluemail.com”,”EmailId”:9},{“Email”:”esteban.f@emBluemail.com”,”EmailId”:10},{“Email”:”fernando@soluciones3f.com.ar”,”EmailId”:1},{“Email”:”florencia.a@emBluemail.com”,”EmailId”:11},{“Email”:”fniwes@gmail.com”,”EmailId”:2},]

Search=*gmail.com&Order=asc&GroupId=351

[{“Email”:”fniwes@gmail.com”,”EmailId”:2}]

Si no encuentra ninguna coincidencia

[]

.

CheckContact
Especifica el estado en el que se encuentra el contacto de emBlue.
INPUT
Token

Token que le otorga emBlue

EmailId ID del email.
{
“EmailId”: “22”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
MainStatus

String del estado en el que se encuentra el contacto en emBlue

Rank Entero del 0 al 5 del ranking del contacto.
Status Especifica todos los estados de emBlue. Los están activos tienen un 1, caso contrario 0. Los mismos son: cuarentena, denunciante, desuscripto, inseguro, suscripto, suspendido y verificado.
{“MainStatus”:”destinatario”,”Rank”:”0″,”Status”:{“Cuarentena”:0,”Denunciante”:0,”Desuscripto”:0,”Inseguro”:0,”Suscripto”:0,”Suspendido”:0,”Verificado”:0}}

Si es denunciante

{“MainStatus”:”no destinatario”,”Rank”:”0″, “Status”:{“Cuarentena”:0,”Denunciante”:1,”Desuscripto”:0,”Inseguro”:0,”Suscripto”:0,”Suspendido”:0,”Verificado”:0}}

Si no existe el email

{“MainStatus”:”inexistente”,”Rank”:null,”Status”:{“Cuarentena”:0,”Denunciante”:0,”Desuscripto”:0,”Inseguro”:0,”Suscripto”:0,”Suspendido”:0,”Verificado”:0}}

 .

EditCustomFieldsOneContact
Permite editar los Campos Personalizados de un contacto.
INPUT
Token

Token que le otorga
emBlue

EmailId ID del Email
EditedFields String que representa a los valores de campos personalizados que se desean cambiar, los datos para que funcionen deben estar separados por ||| y adentro por nombre :|: valor :|: 1
(Se agregar el número 1 para campo del tipo normal y 2 para campos personalizados extendidos)
{
“EmailId”: “1”,
“EditedFields”: “apellido:|:Berselini:|:1|||nombre:|:embluemail :|:1|||sexo:|:M:|:1”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result

Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente

{“Result”:true}

En caso de no poder modificar los campos:

{“Result”:false}

Caso de Uso: Cómo editar Campos Personalizados

..

RelatedContactGroups
Agrega o desagrega contactos a un conjunto de Grupos de Usuarios.
INPUT
Token

Token que le otorga
emBlue

EmailId ID del Email
SelectGroups String de un conjunto de grupos al que se desea agregar un contacto. Ejemplo: 1;2;3
 DeselectGroups  String de un conjunto de grupos de los que se desea quitar un contacto. Ejemplo: 1;2;3
{
“EmailId”: “22”,
“DeselectGroups”: “1953”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result

Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente

EmailId=22&

DeselectGroups=1959

{“Result”:true}

EmailId=22&SelectGroups=1959;351;712;711;768; DeselectGroups=1959

{“Result”:true} (el grupo 1959 queda deselecto)

En caso de no poder hacer las modificaciones.

{“Result”:false}

.

NewContact
Agrega un nuevo contacto y detalla el estado en el que se encuentra en emBlue (si es nuevo o preexistente).
INPUT
Token

Token que le otorga emBlue

Email Email que se desea agregar
SelectGroups String de un conjunto de grupos al que se desea agregar un contacto. Ejemplo: 1;2;3
EditCustomFields Campo personalizado que se desea editar
{
“Email”: “embluemail@hotmail.com”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Descripción

Pueden ser:

nuevo
nuevo corregido
preexistente
preexistente corregido
preexistente corregido reactivado
preexistente reactivado

EditedCustomFields
Booleano que especifica si se edito o no a los campos personalizados
Aregated Groups
Booleano que especifica si se asigno o no a los grupos
EmailID ID del Email
Status Descripción del estado de la inserción del contacto, donde devuelve si fue creado o si existe (si fue reactivado, si esta en inseguro, si la sintaxis fue modificado más la corrección)
mail=embluemail@hotmail.com

{“Description”:”nuevo”,”EmailId”:685085,”Status”:{“Inseguro”:false,”Modificado”:null,”Nuevo”:true,”Reactivado”:false,”SintaxisCorregida”:false “AggregatedGroups “:false , “EditedCustomField”:false}} Email=embluemail@hotmial.com

{“Description”:”nuevo corregido”,”EmailId”:685086,”Status”:{“Inseguro”:false,”Modificado”:”embluemail@hotmail.com”,”Nuevo”:true,”Reactivado”:false,”SintaxisCorregida”:true}}


Email=embluemail@hotmail.com

{“Description”:”preexistente”,”EmailId”:685086,”Status”:{“Inseguro”:false,”Modificado”:null,”Nuevo”:false,”Reactivado”:false,”SintaxisCorregida”:false}}


Email=embluemail@hotmail.com

{“Description”:”preexistente corregido”,”EmailId”:685086,”Status”:{“Inseguro”:false,”Modificado”:”embluemail@hotmail.com”,”Nuevo”:false,”Reactivado”:false,”SintaxisCorregida”:true}}


Email=embluemail@hotmial.com

{“Description”:”preexistente corregido reactivado”,”EmailId”:685086,”Status”:{“Inseguro”:false,”Modificado”:”embluemail@hotmail.com”,”Nuevo”:false,”Reactivado”:true,”SintaxisCorregida”:true},” AggregatedGroups :”true”, }


Email=embluemail@hotmail.com

{“Description”:”preexistente reactivado”,”EmailId”:685086,”Status”:{“Inseguro”:false,”Modificado”:null,”Nuevo”:false,”Reactivado”:true,”SintaxisCorregida”:false}}


Email=embluemail@hotmail.com

{“Description”:null,”EmailId”:0,”Status”:{“Inseguro”:false,”Modificado”:null,”Nuevo”:false,”Reactivado”:false,”SintaxisCorregida”:false}}

.

NewContactExpress
Agrega un nuevo contacto de una forma más ágil y dinámica
INPUT
Token

Token que le otorga emBlue

Email Email que se desea agregar
SelectGroups String de un conjunto de grupos al que se desea agregar un contacto. Ejemplo: 1;2;3
EditCustomFields Campo personalizado que se desea editar
{
“Email”: “embluemail@hotmail.com”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Email
La descripción del email
EmailId ID del Email
mail=embluemail@hotmail.com

{“Email”:”embluemail@hotmail.com”,”EmailId”:6885}

 

 

.

NewContactAll
Agrega un nuevo contacto y detalla el estado en el que se encuentra en emBlue (si es nuevo o preexistente).
INPUT
Token

Token que le otorga
emBlue

Emails Emails que se desea agregar
SelectGroups String de un conjunto de grupos al que se desea agregar un contacto. Ejemplo: 1;2;3
{
“Emails”: “joseperez@gmail.com”,
“Emails”: “mariana@hotmail.com”,
“Email”: “julian.perez@gmail.com”,
“SelectGroups”: “123;234”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}Otra forma valida de realizar el llamado desde .NET…
{
“Emails”: [
“joseperez@gmail.com”,
“mariana.c@gmail.com”,
“julian.perez@gmail.com”
],
“SelectGroups”: “123;234”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}Ejemplo 1:
{
“Emails”: ” joseperez@gmail.com, mariana.c@gmail.com,julian.perez@embluemail.com”,
“SelectGroups”: “123;234”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}

Ejemplo 2:
{
“Emails”: “embluemail@embluemail.com;mariana.c@embluemail.com;prueba@embluemail.com”,
“SelectGroups”: “123;234”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}

OUTPUT
AggregatedGroups
Booleano que especifica si se asigno o no a los grupos
TotalContacts
Cantidad del array del emails que envían. Cuanta con un límite de 100, en caso de superarlo devuelve una excepción.
Contacts
ID de todos los emails agregados.
{“TotalContacts”:3,” AggregatedGroups :”true”,”Contacts”:[1,2,3]}

.

GetGroupsForEmailId
Localiza a qué Grupos de Usuario pertenece determinada dirección de correo electrónico.
INPUT
Token

Token que le otorga emBlue

EmailId ID del Email
{
“EmailId”: “34”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Resut

Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente

[{“GroupId”:1793,”Name”:”GrupoRenombrado”},{“GroupId”:712,”Name”:”Grupo 0001″},{“GroupId”:711,”Name”:”Otros más”}]  Si no encuentra ninguna coincidencia[]

. .

GetEmailsByGroup
Obtener los ID de contacto de cada grupo
INPUT
Token

Token que le otorga emBlue

GroupId ID del Grupo
{
“GroupId”: “34”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
EmailsID

Lista de los contactos que pertenecen al grupo

[62538,62539,62540,62541,62542,62543,62544,62545,62546,62547]

Si no encuentra ninguna coincidencia []

.

GetCustomFieldsByEmail
Localiza aquellos Campos Personalizados completos de una determinada dirección de correo electrónico.
INPUT
EmailId

ID del email

Token Token que otorga emBlue
{
“EmailId”: “34”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Campos

Personalizados

Campos personalizados por ID del mail

[{“id”:”790″,”nombre”:”nombre”,”valor”:”rodrigo”,”tipoCampo”:”1″,”tipoDato”:”3″,”tipoOpcion”:”1″,”valores”:null,”esFijoEmblue”:true,”numero”:”1″,”cantidadContactos”:0},{“id”:”791″,”nombre”:”apellido”,”valor”:”berselini”,”tipoCampo”:”1″,”tipoDato”:”3″,”tipoOpcion”:”1″,”valores”:null,”esFijoEmblue”:true,”numero”:”2″,”cantidadContactos”:0},{“id”:”792″,”nombre”:”id_contacto”,”valor”:”234″,”tipoCampo”:”1″,”tipoDato”:”3″,”tipoOpcion”:”1″,”valores”:null,”esFijoEmblue”:true,”numero”:”3″,”cantidadContactos”:0},{“id”:”793″,”nombre”:”sexo”,”valor”:”M”,”tipoCampo”:”1″,”tipoDato”:”5″,”tipoOpcion”:”2″,”valores”:”M|Masculino;F|Femenino”,”esFijoEmblue”:true,”numero”:”4″,”cantidadContactos”:0},{“id”:”794″,”nombre”:”telefono_1″,”valor”:”444444555″,”tipoCampo”:”1″,”tipoDato”:”3″,”tipoOpcion”:”1″,”valores”:null,”esFijoEmblue”:true,”numero”:”5″,”cantidadContactos”:0},{“id”:”795″,”nombre”:”telefono_2″,”valor”:””,”tipoCampo”:”1″,”tipoDato”:”3″,”tipoOpcion”:”1″,”valores”:null,”esFijoEmblue”:true,”numero”:”6″,”cantidadContactos”:0}

.

Remitentes:

GetSenders
Permite obtener los Senders configurados en la cuenta.
INPUT
Token

Token que le otorga emBlue

OnlyDefault Booleano que especifica si quiero traer los datos del Sender por Default o de todos los Senders.
{
“OnlyDefault”: “true”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Devuelve el/los Senders con todos sus datos.
{“SenderDTO:{“cardCP”:”CP”,”cardCiudad”:”Ciudad”,”cardDireccion”:”Direccion”,”cardEmpresa”:”Empresa”,”cardPais”:”Pais”,”cardProvincia”:”Provincia”,”emailFrom”:emailFromDTO,”emailReply”:emailReplayDTO,”id”:”121″,”nombreFrom”:”emBlue Test”,”predeterminado”:”true”}”}

.

GetSenderName
Buscador de Names From registrados en emBlue.
INPUT
Token

Token que le otorga emBlue

FirstResult

Variable que indica el primer resultado del lote de 100. Por ejemplo: si esta variable es 0 trae del 0 al 100. Si es 23 trae del 23 al 123.

Order Orden del listado, puede asc o desc con respecto al nombre. Por defecto es asc.
Search Cadena de búsqueda. Si es vacio trae todo. La búsqueda soporta wildcards al principio y al final de la cadena, por defecto toma ambos. 100 Registros.
{
“Search”: null,
“Order”: “asc”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
NamesFrom

Lista de names from que contienen el string enviado de búsqueda. Por cada una devuelve: nombre, id y si es o no predeterminado.

{[{“Name”:”asd”,”NameFromId”:134,”Predetermined”:false},{“Name”:”emBlue API”,”NameFromId”:105,”Predetermined”:true}]

Si no encuentra ninguna coincidencia
[]

.

GetSenderEmail
Buscador de Emails From registrados en emBlue.
INPUT
Token

Token que le otorga emBlue

Order Orden del listado, puede asc o desc con respecto al nombre. Por defecto es asc.
Search Cadena de búsqueda. Si es vacio trae todo. La búsqueda soporta wildcards al principio y al final de la cadena, por defecto toma ambos. 100 Registros.
{
“Search”: null,
“Order”: “asc”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
EmailsFrom

Lista de emails from que contienen el string enviado de búsqueda. Por cada una devuelve: nombre, id, si es o no predeterminado y si fue verificado el mismo..

[{“Checked”:false,”Email”:”asd@fds.com”,”EmailFromId”:186,”Predetermined”:false},
{“Checked”:false,”Email”:”fernando@hotmail.com”,
“EmailFromId”:21,”Predetermined”:false},
{“Checked”:false,”Email”:”pablo.perez@embluemail.com”,
“EmailFromId”:39,”Predetermined”:false},{“Checked”:true,”Email”:”carlossuarez@gmail.com”,”EmailFromId”:20,”Predetermined”:true}]Si no encuentra ninguna coincidencia
[]

.

CheckSenderEmail
Chequea el estado del Email From.
INPUT
Token

Token que le otorga
emBlue

IdSenderEmail ID del email
{
“IdSenderEmail”: “100234”,
“Token”: “zzzzzzz-zzzzzzz-zzzzz-zzzzzz”
}
OUTPUT
IdSenderEmail

Devuelve el mismo ID si está correcto, en caso contrario el ID del predeterminado. En caso de que no tenga ninguno valido devuelve 0.

100235
Si no encuentra ninguna coincidenciaId del predeterminado, ejemplo: 100234

 

CheckSenderName
Chequea el estado del Name From.
INPUT
Token

Token que le otorga
emBlue

IdSenderName ID del Name
{
“IdSenderName”: “100234”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
IdSenderName

Devuelve el mismo ID si está correcto, en caso contrario el ID del predeterminado. En caso de que no tenga ninguno valido devuelve 0.

100235

Si no encuentra ninguna coincidencia Id del predeterminado, ejemplo: 100234

Campañas:

Funciones que permiten realizar ABML de las campañas en emBlue.

NewCampaign
Crear nueva campaña. 
INPUT
Token

Token que le otorga emBlue

Name ID del Nombre de la campaña
{
“Name”: “CampaniaDesdeAPI”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Campaing ID

ID de la campaña

{“CampaignId”:472}

En caso de no poder crear la campaña.

{“CampaignId”:0}

 

.

RenameCampaign
Renombrar campaña creada. 
INPUT
Token

Token que le otorga
emBlue

Name Nombre de la campaña a renombrar
CampaignId ID de la campaña.
{
“CampaignId”: “467”,
“Name”: “CampaniaEditada”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente
{“Result”:true}

En caso de no poder modificar el nombre.

{“Result”:false}

.

DeleteCampaign
Eliminar la campaña
INPUT
Token

Token que le otorga
emBlue

CampaignId ID de la campaña.
{
“CampaignId”: “467”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente
{“Result”:true}

En caso de no poder eliminar la campaña.

{“Result”:false}

.

.

SearchCampaign
Buscador de Campañas existentes.
INPUT
Token

Token que le otorga
emBlue

Order Orden del listado, puede asc o desc con respecto al nombre. Por defecto es asc.
Search Cadena de búsqueda. Si es vacio trae todo. La búsqueda soporta wildcards al principio y al final de la cadena, por defecto toma ambos. 100 Registros
DateFrom Fecha desde expresada en YYYYMMDDHHmmSS
DateTo Fecha hasta expresada en YYYYMMDDHHmmSS
{
“Search”: “mariana.c”,
“Order”: “desc”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Campaign
Lista de campañas que contienen el string enviado de búsqueda. Por cada una devuelve: ID de campaña, nombre, fecha, estado, cantidad contactos, etc.
[{“id”:”467″,”nombre”:”CampañaDesdeAPI”,”fechaCreacion”:null,”estado”:null,
“cantidadContactos”:null,”progreso”:null,”reporte”:false,”Actionos”:null,”aperturas”:null,”clicks”:null,”destinatarios”:null}]Ejemplo con fechas. Si no encuentra ninguna coincidencia[]

.

Acciones:

NewAction
Crear nueva acción.
INPUT
Token

Token que le otorga
emBlue

CampaignId ID de la Campaña
Name Nombre de la acción
TypeAction Entero que especifica el tipo de acción que se desea crear. Si es 1 es envió simple. En caso de null o 0 tira excepción.
{
“CampaignId”: “473”,
“Name”: “AccionDesdeLaApi”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
ActionId
ID de acción.
{“ActionId”:472}

En caso de error.
{“ActionId”:0}

.

DuplicateAction
Duplicar acción creada. 
INPUT
Token

Token que le otorga
emBlue

CampaignId ID de la Campaña
ActionId ID de la Acción
Name Nombre de la acción nueva
{
“CampaignId”: “473”,
“ActionId”: “2068”,
“Name”: “AccionDuplicada”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
ActionId
ID de la acción creada
{“ActionId”:472}

En caso de no poder duplicar la acción .

{“ActionId”:0}

.

RenameAction
Renombrar acción. 
INPUT
Token

Token que le otorga emBlue

ActionId ID de la acción
Name Nombre de la acción por el cual se desea renombrar
{
“ActionId”: “2068”,
“Name”: “NuevoNombre”,
“Token”: “ZZZZZZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente
{“Result”:true}

En caso de no poder modificar el nombre.

{“Result”:false}

.

DeleteAction
Borrar acción creada.  
INPUT
Token

Token que le otorga emBlue

ActionId ID de la acción
{
“ActionId”: “2068”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente
{“Result”:true}

En caso de no poder eliminar la acción.

{“Result”:false}

..

SearchAction
Buscador de acciones existentes.
INPUT
Token

Token que le otorga
emBlue

FirstResult

Variable que indica el primer resultado del lote de 100. Por ejemplo: si esta variable es 0 trae del 0 al 100. Si es 23 trae del 23 al 123.

Order Orden del listado, puede asc o desc con respecto al nombre. Por defecto es asc.
Search Cadena de búsqueda. Si es vacio trae todo. La búsqueda soporta wildcards al principio y al final de la cadena, por defecto toma ambos. 100 Registros
DateFrom Fecha desde expresada en YYYYMMDDHHmmSS
DateTo Fecha hasta expresada en YYYYMMDDHHmmSS
CampaignId ID de la campaña a la que corresponde la acción
{
“Search”: “mariana.c”,
“Order”: “desc”,
“CampaignId”: “0”,
“DateFrom”: “20150915083425”,
“DateTo”: “20150917083425”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Action
Lista de acciones que contienen el string enviado de búsqueda. Por cada una devuelve: ID de acción, nombre, fecha, estado, nombre de la campaña, etc.
[{“id”:”467″,”nombre”:”AccionEjemplo”,”nombreCampania”:”CampEjemplo”,”campaniaId”:1234,”fecha”:”2015-09-22T17:45:00″,”estado”:”Finalizado”,”tipo”:”Envio simple”}] Ejemplo con fechas
Si no encuentra ninguna coincidencia[]

.

Funciones para Envío Simple:

SetRecipients
Permite agregar Grupos de Usuarios como destinatarios de una Acción.
INPUT
Token

Token que le otorga emBlue

ActionId ID de la acción
GroupsId Grupos que se desean agregar como destinatarios. Si desea agregar varios deben ser separados por punto y coma.
{
“ActionId”: “2068”,
“GroupsId”: “1793”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente
{“Result”:true} MODIFICAR {“Result”:false}

 

 

SetSender
Incorporar el Sender a la acción de envío
INPUT
Token

Token que le otorga
emBlue

ActionId ID de la acción
SenderId ID del Sender
Subject Asunto del mensaje
{
“ActionId”: “2075”,
“SenderId”: “20”,
“Subject”: “Prueba”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente
{“Result”:true}

En caso de fallar.

{“Result”:false}

.

SetMessage
Incorporar una pieza HTML vía dirección URL
INPUT
Token

Token que le otorga
emBlue

ActionId ID de la acción
Code Codificacion: 65000=UTF-7, 65001=UTF-8, 12000=UTF-32, 28591=ISO-8859-1, 1251=Windows 1251, 1252=Windows 1252, 10000 =Macintosh.
Url URL del HTML
{
“ActionId”: “2075”,
“Code”: “rn65001”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”,
“Url”: “http://storage.embluemail.com/equipo/mkt360/html/0805_telefenews.html”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente
{“Result”:true}

En caso de fallar.

{“Result”:false}

.

SetDate
Programar la fecha y hora de envío de una Acción.
INPUT
Token

Token que le otorga emBlue

ActionId ID de la acción
Date Fecha expresada en el formato YYYYMMDDHHMMSS en que se desea que salga la acción. Si la cadena está vacía (sin los 14 caracteres) es para enviar inmediatamente.

Aclaración: se debe programar el envío con un mínimo de dos horas de anticipación.

{
“ActionId”: “2067”,
“Date”: “1417737600000”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente
{“Result”:true}

En caso de no poder eliminar la campaña.

{“Result”:false}

.

SetOptions
Permite configurar distintas opciones del mensaje.
INPUT
Token

Token que le
otorga emBlue

ActionId ID de la acción
Todas las opciones

disponibles

Boolean de todas los check que se pueden setear en las opciones de la cabecera del HTML. En caso de no existir los deja como true.  Las opciones que se pueden configurar son las siguientes: SocialHeader={true/false}; SocialFooter={true/false}; OnlineHeader={true/false}; OnlineFooter={true/false}; LegalesFooter={true/false}; SuscribirHeader={true/false}; SuscribirFooter={true/false}; PrimeraLinea={cadena de texto}; DatosFooter={true/false}
{
“ActionId”: “2067”,
“SocialFooter”: “false”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente
{“Result”:true}

En caso de fallar.

{“Result”:false}

.

 

SetSplitTest
Permite configurar el Split Test del mensaje.
INPUT
Token

Token que le otorga emBlue

ActionId ID de la acción
SampleB Muestra B del Split Test con el formato “SenderId|Asunto”
SampleC Muestra C del Split Test con el formato “SenderId|Asunto”
Size Tamaño de la muestra (de 5 a 30%). Por defecto: 30%
{
“ActionId”: “2067”,
“SampleB”: “4591|Asunto_de_prueba”,
“Size”: “25”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente
{“Result”:true}

En caso de fallar.

{“Result”:false}

.

PauseAction
Pausar la Acción que está en proceso de envío.
INPUT
Token

Token que le otorga emBlue

ActionId ID de la acción
{
“ActionId”: “2068”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente. Funciona para las acciones de envió simple.
{“Result”:true}

En caso de no poder pausar acción.

{“Result”:false}

.

ConfirmAction
Confirma la Acción para su envío.
INPUT
Token

Token que le otorga emBlue

Acción ID ID de la acción
{
“ActionId”: “2068”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente. Funciona para las acciones de envió simple.
{“Result”:true}

En caso de no poder confirmar la acción.

{“Result”:false}

.

CloseAction
Cierra el proceso de envío de una Acción.
INPUT
Token

Token que le otorga emBlue

ActionId ID de la acción
{
“ActionId”: “2068”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente. Funciona para las acciones de envió simple.
{“Result”:true}

En caso de no poder cerrar la acción.

{“Result”:false}

.
Funciones para Triggers:

CheckTrigger
Permite chequear el estado del Trigger ya enviado. 
INPUT
Token

Token que le otorga emBlue

ActionID ID de la acción
{
“ActionId “: “1000”,
“EmailId”: “417047”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Resultado
Devuelve un true o false
{“Result”:true}

 

En caso de pasado los 30 minutos:

{“Result”:false}

 

Si no existe la relación o el token, o si fallo {“Result”:false}

Para crear el Trigger debés hacerlo desde la UI y configurar la “actividad” por API/Integrador. Una vez creado la plataforma nos dará un ID que es el que luego usaremos para configurarlo a través de la API.

Ver: Caso de uso: Cómo configurar Triggers desde API/ Integrador 

ExecuteTrigger
Ejecutar Trigger.
INPUT
Token

Token que le otorga
emBlue

EmailsIds
Array de ID de emails. Con límite de 100 emails.
ActionId ID de la acción.
{
“Token”: “ZZZZZ-ZZZ-ZZZZZZ”,
“ActionId”: “4822”,
“EmailsIds”: “[1]”
}
OUTPUT
AgregatesTriggers
Cantidad de nuevos Triggers que se agregaron
TotalTriggers
Cantidad total de Triggers enviados
GroupId
ID del Grupo al que pertenecen
[{“AggregatesTriggers”:1; “TotalTriggers”:1; “GroupID”:54}]

“AggregatesTriggers” es la cantidad que se enviaron correctamente, sobre el total “TotalTriggers” que se quisieron ejecutar.

Si no encuentra ninguna coincidencia: []

 

ExecuteTriggerExpress
Ejecutar Trigger, sin necesidad de agregar previamente al Contacto destinatario.
INPUT
Token

Token que le otorga
emBlue

Email
Email destinatario del Trigger
ActionId ID de la acción.
{
“Token”: “ZZZZZ-ZZZ-ZZZZZZ”,
“ActionId”: “4822”,
“Email”: “embluemail@hotmail.com”
}
OUTPUT
AgregatesTriggers
Cantidad de nuevos Triggers que se agregaron
TotalTriggers
Cantidad total de Triggers enviados
GroupId
ID del Grupo al que pertenecen
[{“AggregatesTriggers”:1; “TotalTriggers”:1; “GroupId”:54}]

“AggregatesTriggers” es la cantidad que se enviaron correctamente, sobre el total “TotalTriggers” que se quisieron ejecutar.

Si no encuentra ninguna coincidencia: []

 

ActivateTrigger
INPUT
Token

Token que le otorga emBlue

ActionId ID de la acción
{
“ActionId”: “2068”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente. Funciona para las acciones de envió simple.
{“Result”:true}

En caso de no poder ejecutar la instrucción.

{“Result”:false}

;

DesactivateTrigger
INPUT
Token

Token que le otorga emBlue

ActionId ID de la acción
{
“ActionId”: “2068”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente. Funciona para las acciones de envió simple.
{“Result”:true}

En caso de no poder ejecutar la instrucción.

{“Result”:false}

..

Funciones para SendMail:

SendMail
Tipo de acción 1 a 1 que sólo puede ejecutarse desde la API. 
INPUT
Emails Array de ID de emails. Con límite de 100 emails.
ActionId  ID  de la acción
Message (HTML)  Cadena que especifica el HTML
Token  Token que otorga emBlue
Subject  Cadena que especifica el subjet
{
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”,
“ActionId”: “4822”,
“Emails”: “[1]”,
“Message”: “Mensaje SendMail de prueba”,
“Subject”: “Recordatorio”
}
OUTPUT
TimeStamp
Es la fecha en la que fue ejecutado el SendMail. Este parámetro servirá para buscar el SendMail en la función SearchSendMailByTimestamp()
GroupId
ID del Grupo al que pertenecen
TotalSendEmail
Cantidad total de SendMail enviados
AggregatesSendEmail
Cantidad de nuevos envíos SendMail que se agregaron
[{AggregatesSendMail”:1; “TotalSendMail”:1,  “Timestamp” : “2015-10-27 13:39:30.2232323”, “GroupId” : 2145}]

“AggregatesSendEmail” es la cantidad que se enviaron correctamente, sobre el total “TotalSendEmail” que se quisieron ejecutar.

Si no encuentra ninguna coincidencia: []

.
El SendMail es un tipo de acción para mandar mails 1 a 1 desde emBlue. Se puede enviar con un HTML y un asunto único para un sólo destinatario. Este tipo de acción puede ejecutarse únicamente desde la API, pero la creación del mismo y su remitente deben hacerse desde la Interfaz de emBlue. A diferencia del Trigger, el HTML del mensaje no es perdurable en el tiempo.
.

SendMailExpress
Ejecutar SendMail, sin necesidad de agregar previamente al Contacto destinatario.
INPUT
Email Email destinatario del SendMail
ActionId  ID  de la acción
Message (HTML)  Cadena que especifica el HTML
Token  Token que otorga emBlue
Subject  Cadena que especifica el subjet
{
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”,
“ActionId”: “4822”,
“Email”: “embluemail@hotmail.com”,
“Message”: “Mensaje SendMail de prueba”,
“Subject”: “Recordatorio”
}
OUTPUT
TimeStamp
Es la fecha en la que fue ejecutado el SendMail. Este parámetro servirá para buscar el SendMail en la función SearchSendMailByTimestamp()
GroupId
ID del Grupo al que pertenecen
TotalSendEmail
Cantidad total de SendMail enviados
AggregatesSendEmail
Cantidad de nuevos envíos SendMail que se agregaron
[{AggregatesSendMail”:1; “TotalSendMail”:1,  “Timestamp” : “2015-10-27 13:39:30.2232323”, “GroupId” : 2145}]

“AggregatesSendEmail” es la cantidad que se enviaron correctamente, sobre el total “TotalSendEmail” que se quisieron ejecutar.

Si no encuentra ninguna coincidencia: []

.

SearchSendMailByTimestamp
Buscar envíos SendMail por tiempo. 
INPUT
Token Token que otorga emblue
Timestamp Fecha que devuelve SendEmail() como identificación de lotes de envios
{
“Timestamp”: “2015-09-08 17:39:30.2232323”,
“Token”: “zzzzzz-zzzzzz-zzzzzz”
}
OUTPUT
ReporteSendEmail

Listado de mails que se enviaron en esa fecha determinada.

[{“Date”:”2015-09-08 17:39:30.2232323″,”Email”:”mimail@embluemail.com”,”Status″:”Finalizados”},{“Date”:”2015-09-08 17:39:30.2232323″, ”Email”:”mimail@gmail.com”, ”Status”: “Finalizados”}

Si no encuentra ninguna coincidencia

[]

.

SearchSendMail
INPUT
Token Token que otorga emBlue
ActionIds  Array de ID de acciones
FirstResult Variable que indica el primer resultado del lote de 100. Por ejemplo: si esta variable es 0 trae del 0 al 100. Si es 23 trae del 23 al 123.
Search Cadena de búsqueda de CONTACTOS. Si es vacio trae todo. La búsqueda soporta wildcards al principio y al final de la cadena, por defecto toma ambos. 100 Registros paginados por el FirstResult.
Order Orden del listado, puede asc o desc con respecto al nombre. Por defecto es asc.
DateFrom Fecha desde expresada en YYYYMMDDHHmmSS
DateTo Fecha desde expresada en YYYYMMDDHHmmSS
{
“ActionIds”: “473”,
“FisrtResult”: “0”,
“Search”: null,
“Order”: “asc”,
“DateFrom”: “20150915083425”,
“DateTo”: “20150917083425”,
“Token”: “zzzzzz-zzzzzz-zzzz-zzzzzz”
}
OUTPUT
Array
Lista de correos SendMail que contienen el string enviado de búsqueda. Por cada una devuelve: fecha de envío, destinatario y estado.
 

[{“Date”:2015-09-08 17:39:30.2232323,”Email”:mimail@embluemail.com,”Status″:Finalizados},{“Date”:2015-09-08 17:39:30.2232323, ”Email”:mimail@gmail.com, ”Status”: Finalizados}

Si no encuentra ninguna coincidencia

[]

(*) Para que tome correctamente el mensaje en HTML la etiquetas del mismo deben estar bien cerradas.

.

CheckSendMail
Chequea si la configuración de los parámetros del SendMail es correcta. 
INPUT
Token Token que ortorga emBlue
Message  HTML del mensaje
ActionId  ID de la acción
Subject  Cadena que especifica el subject
{
“ActionId”: “473”,
“Search”: null,
“Order”: “asc”,
“Token”: “zzzzzz-zzzzzz-zzzzzz-zzzzz”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente
{“Result”:true}

En caso de no poder modificar los campos:

{“Result”:false}

.

Funciones para SMS:

(*) Ver información complementaria sobre SMS aquí

SendSMS
Envío de Mensaje de texto a partir del campo personalizado numérico. Sólo puede ejecutarse desde la API. 
INPUT
Emails Array de ID de emails. Con límite de 100 emails.
ActionId  ID  de la acción
Message  Texto del SMS
Token  Token que otorga emBlue
{
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”,
“ActionId”: “4822”,
“Emails”: “[1]”,
“Message”: “Hola, cómo estás”
}
OUTPUT
TimeStamp
Es la fecha en la que fue ejecutado el SendSMS. Este parámetro servirá para buscar el SMS en la función SeachSMSByTimeStamp()
AggregatesSendSMS  Cantidad de nuevos SMS que se agregaron
TotalSendSMS  Cantidad total de SMS enviados
GroupID ID del Grupo al que pertenecen
[{AggregatesSMS”:1; “TotalSendSMS”:10,  “Timestamp” : “2015-10-27 13:39:30.2232323”, “GroupId”: 2145}]

Si no encuentra ninguna coincidencia

[]

.
Para hacer envíos SMS se debe configurar la acción y el campo personalizado donde estén los números de los contactos desde la Interfaz. Luego el mensaje se ejecuta desde la API de emBlue.
.

SearchSMSByTimestamp
Buscar envíos SMS que se realizaron en determinado tiempo. 
INPUT
Token Token que otorga emblue
Timestamp Fecha que devuelve SMS() como identificación de lotes de envios
{
“Timestamp”: “2015-09-08 17:39:30.2232323”,
“Token”: “zzzzzz-zzzzzz-zzzzzz”
}
OUTPUT
ReporteSMS

Listado de mails que se enviaron en esa fecha determinada.

[{“Date”:”2015-09-08 17:39:30.2232323″,”Email”:”mimail@embluemail.com”,”Status″:”Finalizados”},{“Date”:”2015-09-08 17:39:30.2232323″, ”Email”:”mimail@gmail.com”, ”Status”: “Finalizados”}

Si no encuentra ninguna coincidencia

[]

.

SearchSMS
INPUT
Token Token que otorga emBlue
ActionIds  Array de ID de acciones
FirstResult Variable que indica el primer resultado del lote de 100. Por ejemplo: si esta variable es 0 trae del 0 al 100. Si es 23 trae del 23 al 123.
Search Cadena de búsqueda. Si es vacio trae todo. La búsqueda soporta wildcards al principio y al final de la cadena, por defecto toma ambos. 100 Registros paginados por el FirstResult.
Order Orden del listado, puede asc o desc con respecto al nombre. Por defecto es asc.
DateFrom Fecha desde expresada en YYYYMMDDHHmmSS
DateTo Fecha desde expresada en YYYYMMDDHHmmSS
Sent Lista de contactos de envios efectivos. Si el parametro es true trae los contactos y si es false devuelve vacío.
Failed Lista de contactos de envios fallidos. Si el parametro es true trae los contactos y si es false devuelve vacío.
{
“ActionIds”: “473”,
“FisrtResult”: “0”,
“Search”: null,
“Order”: “asc”,
“DateFrom”: “20150915083425”,
“DateTo”: “20150917083425”,
“Token”: “zzzzzz-zzzzzz-zzzz-zzzzzz”,
“Sent”: “true”,
“Failed”: “true”
}
OUTPUT
Array
Lista de correos SMS que contienen el string enviado de búsqueda. Por cada una devuelve: fecha de envío, destinatario y estado.
 

[{“Date”:2015-09-08 17:39:30.2232323,”Email”:mimail@embluemail.com,”Status″:Finalizados},{“Date”:2015-09-08 17:39:30.2232323, ”Email”:mimail@gmail.com, ”Status”: Finalizados}

Si no encuentra ninguna coincidencia

[]

.

CheckSMS
Chequea si la configuración de los parámetros del SMS es correcta. 
INPUT
Token Token que ortorga emBlue
Message  Texto del mensaje
ActionId  ID de la acción
{
“ActionId”: “473”,
“Search”: null,
“Order”: “asc”,
“Token”: “zzzzzz-zzzzzz-zzzzzz-zzzzz”
}
OUTPUT
Result
Boolean, devuelve true si fue correcta la operación o false si hubo algún inconveniente
{“Result”:true}

En caso de no poder modificar los campos:

{“Result”:false}

.
Parámetros a tener en cuenta:

– Para que se concrete el envío de SMS los números de Argentina deben ingresarse a la base de contactos sin el 0 (cero) y sin el 15 (quince). Es decir, deben ser 10 dígitos en total. Por ejemplo: 116536-XXXX

– El mensaje de texto debe tener como máximo 160 caracteres. De lo contrario no será enviado.

– El envío de SMS masivo tiene una franja horaria habilitada para realizar los envíos y es desde las 8:00 hasta las 22:00.
.

Reportes:

GetSummary Obtener resumen por acción.
INPUT
Token
Token dinámico
ActionId ID de la acción
{
“ActionId”: “2075”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Status
Depende de que tipo de envio (simple, trigger o sendemail, sms) es el resultado. Por ejemplo si es envíp simple devolverá
todas las propiedades que definen el estado del Action: si están en OK los datos necesarios para el envio (fecha, destinatarios, mensaje, tiene_mensae), refuerzo, tags, social, mobile, tipo, estado, snapshot, fecha_envio, versión_online, twitter, facebook, suscripción ,desuscripcion , antispam
Ejemplo de envío simple:
{“fecha”:true,”destinatarios”:true,”mensaje”:true,”tiene_mensaje”:true,”refuerzo”:false,”tags”:””,”social”:null,”mobile”:false,”tipo”:”Envio simple”,”estado”:”Borrador confirmable”,”snapshot”:”6c2826d7d23af9bdf7eb984ed63bd7a4.jpg”,”fecha_envio”:”2014-12-19T18:00:00″,”ActionoId”:2086,”versionOnline”:true,”twitter”:true,”facebook”:true,”suscripcion”:true,”desuscripcion”:true,”antispam”:true}

…gg

SearchActivityByAction Arroja el reporte de actividad por cada acción
INPUT
Token

Token que le otorga emBlue

ActionId ID de la acción
ActivityId Summary = 1,Open = 2,Clicks = 3,Viral = 4, Suscribe = 5,Unsuscribe  = 6,Bounces = 7,Social = 8
{
“ActionId”: “2946”,
“ActivityId”: “1”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Devuelve el detalle de la actividad solicitada por acción. Puede ser un resumen, Clicks, Aperturas y Virales, entre otros. En este caso la respuesta es de “Summary”.
{“CantidadEnviados”:”115″,”CantidadAperturas”:”25″,”CantidadClicks”:”1″,”CantidadViral”:”0″,”CantidadDesuscriptos”:”1″,
“CantidadDepurados”:”0″,”CantidadSuscriptos”:”0″,”CantidadRebotados”:”0″,”CantidadEfectivos”:”115″,”CantidadSociales”:”0″,
“Porcentaje_OR”:null,”Porcentaje_CTR”:null,”Porcentaje_CTOR”:null,”Porcentaje_Viral”:null,”PorcentajeEmpresa_OR”:null,
“PorcentajeEmpresa_CTR”:null,”PorcentajeEmpresa_CTOR”:null,”PorcentajeEmpresa_Viral”:null}

..

SearchContactsByActivity
INPUT
Token Token que otorga emBlue
ActionId  ID de la acción
FirstResult Variable que indica el primer resultado del lote de 100. Por ejemplo: si esta variable es 0 trae del 0 al 100. Si es 23 trae del 23 al 123.
Search Cadena de búsqueda. Si es vacio trae todo. La búsqueda soporta wildcards al principio y al final de la cadena, por defecto toma ambos. 100 Registros paginados por el FirstResult.
Order Orden del listado, puede asc o desc con respecto al nombre. Por defecto es asc.
ActivityId  ID de la actividad por la que se desea obtener los contactos.

OriginalsSent = 1,EffectivesSent = 2,TotalOpen = 3,UniqueOpen = 4,RecurrentOpen = 5,TotalClicks = 6,UniqueClicks = 7,RecurrentClicks = 8,Viral = 9,Suscribe = 10,Unsuscribe = 11,Bounces = 12,TotalSocial = 13,SocialFacebook = 14,SocialTwitter = 15 ,

{
“ActionId”: “473”,
“FirstResulta”: “0”,
“Search”: null,
“Order”: “asc”,
“ActivityID”: “10”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Array de mails
Lista de correos que realizaron la actividad solicitada con el ActivityID. En este caso solicitamos los desuscriptos.
 [{“Email”:mimail@embluemail.com,”EmailID″:34},{“Email”:mail@embluemail.com, ”EmaiIDl”:56}]

Si no encuentra ninguna coincidencia

[]

 

GetActivityByEmail
Tomar actividad de reporte por cada contacto.
INPUT
Token

Token que le otorga emBlue

EmailId ID del email
{
“EmailId”: “2944”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
Array, devuelve un array con todos los tipos de Actividad, y la cantidad que tiene el contacto de cada uno de ellos.
[{“actividad”:”Apertura”, “dato”;”2″, “fecha”:”8/17/2016 10:30:42 PM”}, {“actividad”:”Click”, “dato”;”0″, “fecha”:””}, {“actividad”:”Viral”, “dato”;”0″, “fecha”:””}, {“actividad”:”Envio”, “dato”;”124″, “fecha”:”10/4/2016 6:37:44 PM”}, {“actividad”:”Desuscripto”, “dato”;”0″, “fecha”:””}, {“actividad”:”Rebote”, “dato”;”0″, “fecha”:””}, {“actividad”:”Suscripcion”, “dato”;”0″, “fecha”:””}, {“actividad”:”Denuncia”, “dato”;”0″, “fecha”:””}, {“actividad”:”SMS Fallidos”, “dato”;”0″, “fecha”:””}, {“actividad”:”Click”, “dato”;”0″, “fecha”:””}]

ShareReports
Permite obtener acceso a los reportes de las acciones mediante una URL externa a la plataforma.
INPUT
Token

Token que le otorga emBlue

ActionIds Array de ID’s de las acciones
{
“ActionId”: “2075”,
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
URL
Devuelve la URL del reporte.
{“URL”:”http://app.embluemail.com/?rs=960a2861-1320-4a87-ba9e-fe1bb7f6fecd”}

.

GetAutomaticReportsFiles
Obtener reportes automáticos
INPUT
Token

Token que le otorga emBlue

{
“Token”: “ZZZZZ-ZZZ-ZZ-ZZZZ”
}
OUTPUT
Result
fecha de Creacion, id de Empresa, id de ReporteAutomatico, si tiene Registros, url, nombre, tamaño
[{“fechaCreacion”:”2015-07-07″,”id”:13,”idEmpresa”:0,”idReporteAutomatico”:14,”nombre”:”Actividad_Rebotes_Diarios_20150707_124456.zip”,”tamanio”:”316 B”,”tieneRegistros”:false,”url”:”http://192.168.0.237:7082/GeneradorArchivos/62/Actividad_Rebotes_Diarios_20150707_124456.zip”},{“fechaCreacion”:”2015-07-07″,”id”:4,”idEmpresa”:0,”idReporteAutomatico”:5,”nombre”:”Actividad_Enviados_Diarios_20150707_124447.zip”,”tamanio”:”311 B”,”tieneRegistros”:false,”url”:”http://192.168.0.237:7082/GeneradorArchivos/62/Actividad_Enviados_Diarios_20150707_124447.zip”},{“fechaCreacion”:”2015-07-07″,”id”:7,”idEmpresa”:0,”idReporteAutomatico”:8,”nombre”:”Actividad_Aperturas_Diaria_20150707_124454.zip”,”tamanio”:”318 B”,”tieneRegistros”:false,”url”:”http://192.168.0.237:7082/GeneradorArchivos/62/Actividad_Aperturas_Diaria_20150707_124454.zip”}]

.
Notas relacionadas

<API> Pasos para empezar a usar la API de emBlue 
<API> Caso de Uso (API): Cómo crear campañas y acciones

.