Communicator

ReferenciaS API

Aproveche todas las ventajas de nuestra plataforma, con los productos relacionados se puede obtener el máximo provecho y así conseguir de mejor manera cumplir con su tarea del día.

Métodos disponibles

Puede emplear varios métodos en conjuntos o inviduales.
Métodos Descripción URL
getDateTime Permite obtener la fecha/hora del servidor. https://commcenter.greyphillips.com/apis/silver/communicator.asmx
getERPData
getGlobalContact
getGlobalContactDS
setContact Permite agregar/editar contactos. https://cloud.greyphillips.com/apis/silver/acl.asmx
setContactCustomFieldValue
setContactException Permite agregar un número de teléfono/correo y especificar si esa persona desea o no recibir notificaciones por ese medio. https://commcenter.greyphillips.com/apis/silver/communicator.asmx
setDocFileAttach
setMessage Permite crear mensajes (SMS/Correos). https://commcenter.greyphillips.com/apis/silver/communicator.asmx
setUploadFileToDB Permite almacenar archivos en la base de datos. https://commcenter.greyphillips.com/apis/silver/communicator.asmx
setUploadFileToPath Permite almacenar archivos dentro del servidor. https://commcenter.greyphillips.com/apis/silver/communicator.asmx

Escenario de envío de mensajes (SMS)

En este primer escenario de envío, que es probablemente el escenario más simple de todos, el ejemplo se centra en hacer un envío sencillo de un SMS a un usuario.

Lo primero que hay que definir es si se desea registro de envíos relacionados al contacto, que puede ser consultado dentro de la plataforma, es decir, todos los envíos que se hagan asociándolos a contactos específicos, pueden ser consultados posteriormente en asociación con la información del contacto, también es posible hacer los envíos sin que tengan ninguna asociación a ningún contacto, esto por supuesto, dependerá del objetivo de los envíos que tenga la organización.

En caso de que se desee hacer envíos sin hacer la asociación con el contacto, por favor pase al siguiente paso de este escenario.

Paso 1:

Agregar o actualizar el contacto, al que se le va a hacer el envío, este paso es previo a hacer el envío propiamente, ya que la plataforma permite llevar registro de los contactos con gran detalle y además todos los envíos quedan asociados a estos contactos siempre que así se establezca por parte del programador.

Para agregar un contacto lo primero que se hace es usar la función setContact.

setContact('Llave','User1','Pass123','1893682','Percival Wallace','email@corporacion.com','50660591516','WA, 123 Well Street',23,9,0,0,'')

Con este ejemplo agregaremos a la base de datos DEMO, la cual tiene la llave de identificación única: 'Llave', usando el usuario 'User1' que tiene una contraseña 'Pass123', al contacto, cuyo Id seria '1893682', su nombre seria 'Percival Wallace' el cual tiene el correo 'email@corporacion.com' y vive en WA, 123 Well Street, cuya fecha de nacimiento es el 23 de septiembre, pero del cual no conocemos el año; además 0 o 1 para indicar si debe quedar inactivo=1 y por último el ID de la categoría, si se desea, la cual se agrega el contacto, de lo contrario vacío.

Se hace esto con todos los contactos que deseemos agregar o actualizar en la base de datos, este paso es totalmente opcional y corresponde al criterio que cada organización tenga.

Una vez que el contacto está en la base de datos, procedemos a agregar por medio de la instrucción de envío el mensaje que deseamos. 

Paso 2:

Procedemos entonces a usar la instrucción setMessage.

setMessage ('Llave','User1','Pass123','SMS','NONE','20150923 140000','50660561516','','En este día tan especial deseamos darle nuestras felicitaciones por su cumpleaños',0,'1893682','','','','AppMercadeo')

Para los propósitos del ejemplo, estamos agregando un mensaje en la base de datos DEMO, la cual tiene la llave de identificación única para tal base de datos, 'Llave', usando el usuario 'User1' con contraseña 'Pass123', indicando que se trata de un mensaje de texto normal, ya que se indicó en strType el valor 'SMS' y en strSubType 'NONE', el mensaje se enviara el 23 de setiembre del 2015 a las 2:00PM, el mensaje se enviara al 506 60591516, con el texto “En este día tan especial deseamos darle nuestras felicitaciones por su cumpleaños”, para el caso de los envíos de SMS el texto que va en el campo strSubject se usa para seguimiento y reportería (puede ser igual al mensaje pero no debe exceder los 255 caracteres a diferencia del mensaje), la prioridad se establece como normal al usar el valor 0 y se va a asociar el mensaje al contacto de la base de datos que tenga el Id. 1893682 (opcional), los siguientes campos en el ejemplo se dejan en blanco, ya que no lleva files adjuntos, no se está asociando a una campana en específico, no se está usando una cuenta SMTP por ser mensajes de texto, el ultimo valor sirve como información de referencia para saber que aplicativo ejecuto esta instrucción, lo que resulta útil para casos donde hay diversas aplicaciones como, por ejemplo, el sistema de cobros, los sistemas de operaciones, transporte y otros.