Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Recordar que para poder usar la API se necesita.

  1. Autenticarse y obtener un token para la sesión

  2. Usar el token en el Header Authorization

  3. Finalizar sesión

Vea más aquí

...


SMS

Dentro de esta categoría podremos realizar las siguientes acciones:

Envío de SMS

Code Block
languagetext
https://dominio.ucontactcloud.com/Integra/resources/SMS/SendSMS
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros: destination (Número destino para sms)
            message     (Mensaje de texto)
            campaign    (Campaña)
            agent       (Agente que lo enviía)
            source      (Callerid o Puerto)
Result: TEXTO  OK
              ERROR

Envío de SMS version 2

Code Block
languagetext
https://dominio.ucontactcloud.com/Integra/resources/SMS/SendSMSv2
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros: destination (Número destino para sms)
            message     (Mensaje de texto)
            campaign    (Campaña)
            agent       (Agente que lo enviía)
            source      (Callerid o Puerto)
Result: TEXTO(json) {
                      id:"{id}"
                    }

...

Code Block
languagejs
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/porthole/1.0.0/porthole.js"></script>
<script type="text/javascript">

   function SMS () {
       var windowProxy;
       windowProxy = new Porthole.WindowProxy(window.location.protocol + window.location.hostname);
	   windowProxy.post({'action': 'sms', 'campaign' : '<CAMPAIGN>', 'message' : '<MESSAGE>', 'destination' : '<NUMBER>'});
   }

</script>

Recibir SMS

Code Block
https://dominio.ucontactcloud.com/Integra/resources/InboundSMS/ReceiveURLSMS
Método: GET
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros: phone 		(Número origen del sms)
            message     (Mensaje de texto)
Result: TEXTO  OK
              ERROR

Agendar SMS

Info

El scheduler de marcadores de SMS es para poder Agendar SMS y que el marcador las realice en el momento adecuado, para esto existe un WebService de Tipo REST que permite agendar las mismas. y es posible hacerlo desde Forms, Workflows o desde sistemas externos.

Básicamente el proceso es que existe una tabla donde están las llamadas que están agendadas con toda su información pertinente.

sms_scheduler

calldate

campaña

teléfono destino

data

fecha y hora de cuando tiene que ejecutar

prueba1

098344484

Code Block
 El mensaje
Info

El scheduler ubica en el sms_spool con prioridad 1 a los mensajes que tienen que ejecutar en ese minuto, lo cual va a hacer que los marcadores lo tomen lo antes posible para enviar el mensaje.

El nombre de base es Schedule + Fecha, y de esta forma conocer cuales son los sms que se agendaron y cuando se deben enviar para poder comparar con el dateprocessed del sms_repo.

...

Code Block
POST
http://<IP-INTEGRASERVER>/Integra/resources/SMS/ScheduleDialerSMS
 
param: @FormParam("sms") 
 
(json con formato sms_scheduler)
 
{
  "calldate" : "2015-10-11 15:00:00",
  "campaign" : "Ventas->",
  "destination" : "098344484",
  "data" :  "Mensaje"
}

Subir base SMS

Code Block
https://dominio.ucontactcloud.com/Integra/resources/SMS/uploadbase
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros:  filename         (Nombre archivo)
             fileb64          (Contenido del archivo en base64)
             campaign         (Nombre de la campaña)
         
Resultado: 1 (Asincrónico)

...

Note

El marcador debe estar en fecha y habilitado para poder procesar mensajes, de lo contrario una vez vuelva a estar activo son los primeros en salir.

...


Email

Para email podremos cargar las bases de los Marcadores.

Subir base de Email

Code Block
https://dominio.ucontactcloud.com/IntegraChannels/resources/DialersResources/uploadDialerBase
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros: filename        (Nombre archivo)
            fileb64         (Contenido del archivo csv en base64)
			channel		  	'email' (el valor de este parametro siempre será el mismo)
			user			nombre de usuario
			dialer			nombre del discador
			filter         	subject del email
			cant			cantidad de registros
         
Resultado: 1 (Asincrónico)

...

Code Block
languagetext
NombreCampana;ejemplo@gmail.com;Este es un mensaje de ejemplo;;"Var1":"value","Var2":"value";9999

Enviar email

Code Block
https://dominio.ucontactcloud.com/IntegraChannels/resources/Forms/SendMailv2
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros:  body         
             agent        

...

Code Block
languagetext
NombreCampana;ejemplo@gmail.com;Este es un mensaje de ejemplo;;"Var1":"value","Var2":"value";9999

...

Colección de postman con ejemplo de llamadas a Envío de SMS.

View file
nameAPI Omnicanal.postman_collection.json

...