De Comunidad

Pasos a seguir para el envío de mensajes

Estos son los pasos que se deben seguir para poder realizar el envío de mensajes a través de nuestros Servicios Web:

1. Crear un usuario y clave en http://z4.imolko.com
2. Agregar a los Contactos.
3. Obtener los Contactos.
4. Enviar el Mensaje.

Servicio Web: Enviar Mensaje

Especificaciones Generales

WSDL: http://z4.imolko.com/zenkiu-ws-war/contenido-ws.wsdl
Service: ContenidoService
Port: ContenidoSoap11
EndPoint: http://z4.imolko.com/zenkiu-ws-war/
Método a llamar: “enviarMensaje”.

¿Cómo realizar la llamada al método?

Para poder utilizar el método “enviarMensaje” es necesario que agregue los parámetros mostrados a continuación (algunos son obligatorios, otros opcionales para cada caso particular). A continuación se muestra el Request necesario para hacer el envío de cualquier mensaje.

Imagen

Detalle de cada Parámetro

Parámetros Obligatorio

• Mensaje: Parámetro string de entrada. Especifica el contenido del mensaje a enviar (Puede ser un texto simple para el caso de los envíos a través de mensajes de texto (SMS), pero también un HTML para el caso de los envíos a través de correos electrónicos).

• TipoCanal: Parámetro string de entrada. Especifica el tipo de canal por el cual se quiere hacer el envío del mensaje. Por ejemplo, si se quiere hacer un envío que llegue por mensajes de texto, el valor del tipo de canal debe ser ‘sms’ y para el caso en que se quiera hacer un envío que llegue por correo electrónico, debe colocarse ‘correo’. (Es importante destacar que sólo puede hacerse el envío por un (1) tipo de canal a la vez, por lo cual no podrá colocar ‘sms,correo’ o ‘sms-correo’ y cosas por el estilo).

• ContactoId: Parámetro int de entrada. Especifica el ID de cada contacto al que se le quiera enviar el mensaje. (Este parámetro debe colocarse para cada ID al que se quiera enviar, por lo cual, si se va a hacer un envío a 100 personas, el mismo debe aparecer 100 veces y cada una de las veces con un ID de contacto diferente).

Por otro lado, cada uno de estos contactos debe estar agregado previamente en el sistema a través del método “agregarContacto” y luego de ello podrá conocer los IDs de los mismos utilizando el método “ObtenerContactosDeTipoRelacion”, los cuales se explicarán más adelante.

• Usuario: Parámetro string de entrada. Especifica el usuario para la autentificación.

• Clave: Parámetro string de entrada, Especifica el password para la autentificación.

Parámetros Opcionales

• IdContenido: Parámetro int de entrada. Especifica el id del mensaje que se quiere enviar. (Válido únicamente para enviar mensajes que ya estaban previamente guardados en el sistema, por ejemplo al querer enviar un “Borrador” o “Reenviar” un mensaje.
• Asunto: Parámetro string de entrada. Especifica el título o asunto que se le quiere dar al mensaje. (Válido únicamente para el envío a través de correo electrónico).

¿Cómo será la respuesta?

La función retorna un valor del tipo string, donde cualquier valor distinto de 0 (cero) indica que hubo un error en la operación. Las posibles respuestas son:

• 0, si realizó el envío completo y de forma exitosa.
• 1, si el usuario colocado para la autenticación no tiene permisos para enviar un mensaje.
• 2, si ocurrió un error en el cobro del mensaje, o bien, no posee saldo para hacerlo.
• 3, si al menos 1 mensaje dio error de conexión con las operadoras (en el caso de envíos de sms) o servidores (en el caso de envíos de correo) y no pudo entregarse a su destino.
• 4, si el mensaje no está bien formado para personalizarlo o tiene datos incorrectos.
• 5, si aún no posee contactos agregados a quienes hacer el envío.
• -1, Error interno de la aplicación. Intente realizar el envío nuevamente y en caso de que el error persista comuníquese con nosotros para hacer una revisión.

A continuación se muestra el Response obtenido después de hacer un envío de cualquier mensaje.

Imagen

Ejemplos

Este ejemplo muestra una llamada simple al método, vista desde SoapUI, para hacer el envío de un SMS a 2 contactos, cuyos IDs son: 450 y 386. El mensaje a enviar es “Hola, esto es un sms de prueba”.

Imagen

Este ejemplo muestra una llamada simple al método, vista desde SoapUI, para hacer el envío de un Correo Electrónico a 2 contactos, cuyos IDs son: 450 y 386. El mensaje a enviar es “Hola, esto es un correo de prueba” y tendrá como asunto del mensaje: “Correo de Prueba”.

Imagen

Servicio Web: Agregar Contacto

Especificaciones Generales:

WSDL: http://z4.imolko.com/aurora-ws-war/aurora.wsdl
Service: AuroraService
Port: AuroraSoap11
EndPoint: http://z4.imolko.com/aurora-ws-war/
Método a llamar: “agregarContacto”.

¿Cómo realizar la llamada al método?

A continuación se muestra el Request necesario para agregar a un contacto al sistema.

Imagen

Detalle de cada Parámetro

Parámetros Obligatorios:

• IdContactoEmisor: Parámetro int de entrada. Especifica el ID de la persona que quiere agregar al contacto, es decir, la persona que querrá comunicarse posteriormente con el contacto a agregar.
• IdTipoRelacion: Parámetro int de entrada. Especifica el ID del tipo de relación que quiere establecer con el contacto a agregar. Las opciones posibles son:

• 1, representa la relación “No definida”
• 2, representa la relación “Amigos”
• 3, representa la relación “Familia”
• 4, representa la relación “Clientes”
• 5, representa la relación “Proveedores”

Este parámetro sólo será utilizado para organizar a tus contactos y que posteriormente puedas visualizarlos dependiendo de la relación que tengas con ellos.

• Usuario: Parámetro string de entrada. Especifica el usuario para la autentificación.
• Clave: Parámetro string de entrada, Especifica el password para la autentificación.

Parámetros Semi-Obligatorios:

• BuzonCorreo: Parámetro string de entrada. Especifica el valor del correo electrónico que le colocarás al contacto a agregar. Puede tener una longitud de entre 9 y 50 caracteres. Por ejemplo: info@imoko.com.
• BuzonSMS: Parámetro string de entrada. Especifica el valor del número celular por el cual se le harán los envíos de SMS. Debe seguir siempre el formato: +58412xxxxxxx, donde ‘58’ representa el código del país y ‘412’ el código de la operadora. Por ejemplo: +584129992299 begin_of_the_skype_highlighting +584129992299 end_of_the_skype_highlighting begin_of_the_skype_highlighting +584129992299 end_of_the_skype_highlighting begin_of_the_skype_highlighting +584129992299 end_of_the_skype_highlighting begin_of_the_skype_highlighting +584129992299 end_of_the_skype_highlighting begin_of_the_skype_highlighting +584129992299 end_of_the_skype_highlighting begin_of_the_skype_highlighting +584129992299 end_of_the_skype_highlighting begin_of_the_skype_highlighting +584129992299 end_of_the_skype_highlighting, representa un número de la operadora Digitel en Venezuela.

Estos parámetros podría decirse que son semi-obligatorios, ya que no están colocados como obligatorios en la definición del Web Service. Sin embargo, para poder realizar los envíos, será necesario que hayas agregado a los contactos con alguno de estos datos, dependiendo del tipo de envío que quieras realizar. En el caso de hacer envíos de SMS será necesario que hayas agregado el buzonSMS de cada uno de los contactos a quien le vayas a hacer este tipo de envíos y en el caso de hacer los envíos por Correo Electrónico, será necesario que hayas agregado el buzonCorreo de quienes les vayas a enviar.

Parámetros Opcionales:

• PrimerNombre: Parámetro string de entrada. Especifica el primer nombre del contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres. Por ejemplo: Adriana.
• PrimerApellido: Parámetro string de entrada. Especifica el primer apellido del contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres. Por ejemplo: Hurtado.
• SegundoNombre: Parámetro string de entrada. Especifica el segundo nombre del contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres. Por ejemplo: Josefina.
• SegundoApellido: Parámetro string de entrada. Especifica el segundo apellido del contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres. Por ejemplo: Rojas.
• Sexo: Parámetro string de entrada. Especifica el sexo del contacto a agregar. Puede tener una longitud máxima de 1 caracter. Por ejemplo: ‘F’ si es Femenino y ‘M’ si es Masculino.
• Pais: Parámetro string de entrada. Especifica el pais del contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres. Por ejemplo: Venezuela.
• Estado: Parámetro string de entrada. Especifica el estado del contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres. Por ejemplo: Dto. Capital.
• Ciudad: Parámetro string de entrada. Especifica la ciudad del contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres. Por ejemplo: Caracas.
• TelfHab: Parámetro string de entrada. Especifica el teléfono de habitación del contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres y es indiferente el formato que se le coloque. Por ejemplo: ‘582125574477’ o ‘5574477’.
• Apodo: Parámetro string de entrada. Especifica el apodo, sobrenombre o nickname por el cual es conocido el contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres. Por ejemplo: Pepe.
• Empresa: Parámetro string de entrada. Especifica la empresa en la cual trabaja el contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres. Por ejemplo: Imolko.
• Cargo: Parámetro string de entrada. Especifica el cargo en el cual trabaja el contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres. Por ejemplo: Gerente.
• TelfOficina: Parámetro string de entrada. Especifica el teléfono de la oficina del contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres y es indiferente el formato que se le coloque. Por ejemplo: ‘582125574477’ o ‘5574477’.
• FechaNacimiento: Parámetro string de entrada. Especifica la fecha de nacimiento del contacto a agregar. Debe cumplir con el formato dd/MM/yyyy. Por ejemplo: 28/01/1980.
• CedulaIdentidad: Parámetro string de entrada. Especifica el documento de identidad del contacto a agregar. Puede tener una longitud de entre 1 y 50 caracteres y cualquier formato. Por ejemplo: v5345432.
• Dato1, Dato2, Dato3, Dato4, Dato5 y Dato6: Parámetros string de entrada. Son campos adicionales para agregar cualquier información extra que necesites sobre el contacto a agregar. Pueden tener una longitud de entre 1 y 50 caracteres c/u.

¿Cómo será la respuesta?

La función retorna un valor del tipo string, donde cualquier valor distinto de 0 (cero) indica que hubo un error en la operación. Las posibles respuestas son:

• 0, si se agregó al contacto de forma exitosa.
• 1, si el correo que está ingresando ya se encuentra registrado en nuestro sistema.
• 2, si el celular que está ingresando ya se encuentra registrado en nuestro sistema.
• 3, si faltan campos obligatorios.
• 4, si el formato del buzón de correo no es válido.
• 5, si el formato del buzón de sms no es válido.
• 6, si el usuario colocado para la autenticación no tiene permisos para agregar un contacto.
• 7, si el tipo de relación que intenta establecer no existe.
• -1, Error interno de la aplicación. Intente realizar la operación nuevamente y en caso de que el error persista comuníquese con nosotros para hacer una revisión.

A continuación se muestra el Response obtenido después de agregar a un contacto.

Imagen2

Ejemplos

Este ejemplo muestra una llamada al método, vista desde SoapUI, para agregar como contacto a ‘Laura Perez’, a quien se podrá contactar únicamente por mensajes de texto. Asumiendo que el ID de quien la agrega es ‘280’ y que se quiere agregar con una relación “No definida”, cuyo ID es ‘1’.

Imagen

Este ejemplo muestra una llamada al método, vista desde SoapUI, para agregar como contacto a ‘Laura Perez’, a quien se podrá contactar únicamente por correo electrónico. Asumiendo que el ID de quien la agrega es ‘280’ y que se quiere agregar con una relación “No definida”, cuyo ID es ‘1’.

Imagen

Este ejemplo muestra una llamada al método, vista desde SoapUI, para agregar como contacto a ‘Laura Perez’, a quien se podrá contactar tanto por mensajes de texto, como por correo electrónico. Asumiendo que el ID de quien la agrega es ‘280’ y que se quiere agregar con una relación “No definida”, cuyo ID es ‘1’.

Imagen

Servicio Web: Obtener Contactos

Especificaciones Generales:

WSDL: http://z4.imolko.com/aurora-ws-war/aurora.wsdl
Service: AuroraService
Port: AuroraSoap11
EndPoint: http://z4.imolko.com/aurora-ws-war/
Método a llamar: “obtenerContactosDeTipoRelacion”.

¿Cómo realizar la llamada al método?

A continuación se muestra el Request necesario para obtener los contactos que has agregado al sistema, por cada tipo de relación.

Imagen

Detalle de cada Parámetro: (En este caso, todos los parámetros son obligatorios)

• IdContactoEmisor: Parámetro int de entrada. Especifica el ID de la persona que agregó a los contactos que se quieren obtener.
• IdTipoRelacion: Parámetro int de entrada. Especifica el ID del tipo de relación con el que se agregó a los contactos. Las opciones posibles son:

• 1, representa la relación “No definida”
• 2, representa la relación “Amigos”
• 3, representa la relación “Familia”
• 4, representa la relación “Clientes”
• 5, representa la relación “Proveedores”

¿Cómo será la respuesta?

Esta función retorna una Lista del tipo List<Contacto>, que tendrá N nodos llamados ‘Contacto’ (uno para cada contacto que se haya agregado en el Tipo de Relación especificado). Adicionalmente, en cada nodo ‘Contacto’ podrás encontrar la información detallada a continuación:

• 1.idContacto: Representa el ID del contacto, único dato necesario para el envío de mensajes.
• 2.empresaId
• 3.statusContacto
• 4.usernameContacto
• 5.idContactoEmisor: Representa el ID de la persona que agregó a este contacto.
• 6.idTipoRelacion: Representa el ID de la relación con que agregaron a este contacto.
• 7.statusRelacion
• 8.buzonCorreo
• 9.buzonSMS
• 10.primerNombre
• 11.segundoNombre
• 12.primerApellido
• 13.segundoApellido
• 14.sexo
• 15.país
• 16.estado
• 17.ciudad
• 18.telfHab
• 19.apodo
• 20.empresa
• 21.cargo
• 22.telfOficina
• 23.fechaNacimiento
• 24.cedulaIdentidad
• 25.dato1
• 26.dato2

27.dato3

• 28.dato4
• 29.dato5
• 30.dato6
• 31.nombreTipoRelacion
• 32.alias

Ejemplos de Request

Este ejemplo muestra una llamada al método, vista desde SoapUI, para obtener a todos los contactos forman parte de un Tipo de Relación determinada. Para este caso, el ID de quien los agregó era ‘280’ y fueron agregados con un Tipo de Relación llamada “No definida”, cuyo ID es ‘1’.

Imagen

Ejemplos de Response

A continuación se muestra un ejemplo sobre la estructura que tendría la respuesta de este método. Para este caso, se obtuvieron 3 nodos ‘Contacto’ y cada uno tendría la información que se detalla en el próximo ejemplo, adicional al ‘idContacto’. (El Response fue editado por razones de espacio).

Imagen

A continuación se muestra la estructura en detalle que contendría cada uno de los nodos ‘Contacto’ colocados en el ejemplo anterior. Para este caso, el ID de quien agregó a los contactos era ‘280’ y fueron agregados con un Tipo de Relación cuyo ID es ‘1’. Los datos mostrados en este ejemplo pertenecen a un (1) sólo nodo de los tres (3) que se encontraban en el ejemplo anterior.

Imagen

Por último, se muestra el ejemplo de cómo sería la respuesta cuando el usuario aún no tiene contactos agregados en el Tipo de Relación solicitado. (Response con Lista vacía)

Imagen

Descarga el procedimiento en PDF

• Descargar procedimiento