Ver código fuente

===URL===

La API de desvíos se ofrece como un servicio web, accesible mediante la URL:

 https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_desvios?principal=xxxxxxxxx&pin=1234&nv=xxxxxxxxx

Para los clientes de Canarias, la URL es:

 https://cgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_desvios?principal=xxxxxxxxx&pin=1234&nv=xxxxxxxxx

===Parámetros obligatorios===

* 'principal' es el número de teléfono del cliente (con el que se dio de alta), también llamado "usuario de la cuenta {{PRODUCTO}}".
* 'pin' es el PIN de la cuenta {{PRODUCTO}}.
* Además, hace falta especificar:
** o bien 'nv' como el número virtual al que se quieren modificar los desvíos.
** o bien 'ext' como la extensión a la que se quieren modificar los desvíos.

===Leer los desvíos actuales===

Ante cualquier petición, ya sea de lectura o de modificación de desvíos, el sistema ofrecerá los desvíos actuales del número virtual o extensión especificada. Por ejemplo, si queremos leer los desvíos del número virtual 902955955 de la cuenta 911922933, la petición sería:

 https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_desvios?principal=911922933&pin=0000&nv=902955955

En el caso de querer los desvíos de la extensión 2345, tendríamos que crear la siguiente petición:

 https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_desvios?principal=911922933&pin=0000&ext=2345

El sistema ofrecerá una respuesta en texto plano de la siguiente forma:

 OK
 [por defecto] => #1: desvio1 (esp1) #2: desvio2 (esp2) #3: desvio3 (esp3) #4: desvio4 (esp4) #5: desvio5 (esp5)
 HH:MM-HH:MM lmxvsdf => #1: desvio1 (esp1) #2: desvio2 (esp2) #3: desvio3 (esp3) #4: desvio4 (esp4) #5: desvio5 (esp5)
 HH:MM-HH:MM lmxvsdf => #1: desvio1 (esp1) #2: desvio2 (esp2) #3: desvio3 (esp3) #4: desvio4 (esp4) #5: desvio5 (esp5)
 ...

Primero se lista el resultado de la operación ('OK' si todo fue bien). Después se lista el desvío por defecto, con cada uno de los desvíos configurados (desvio1..desvio5). Entre paréntesis se pone el tiempo de espera de cada desvío. No tienen por qué aparecer los 5 desvíos: si sólo hay dos desvíos, aparecerán en la línea desvio1 y desvio2. En el caso de que no hubiera desvíos, la línea aparecería como:

 [por defecto] => 

Por último, se listan los desvíos por horario (si los hubiere), indicando primero el horario y los días del mismo (l: lunes, m: martes, x: miércoles, j: jueves, v: viernes, s: sábados, d: domingos, f: festivos).

Por ejemplo:

 HTTP/1.x 200 OK
 Date: Fri, 16 Jan 2009 14:24:32 GMT
 Server: Apache
 Keep-Alive: timeout=15, max=100
 Connection: Keep-Alive
 Transfer-Encoding: chunked
 Content-Type: text/plain
 
 OK
 [por defecto] => #1: 911922933@{{DOMINIO}} (0) #2: 655644633 (25) 
 12:00-13:00 lmxjvsdf => #1: 911922933@{{DOMINIO}} (0) #2: 933844755 (34)

===Cambiar los desvíos===

Para cambiar un desvío, además de los parámetros obligatorios (principal, pin y nv/ext), debe especificar los siguientes parámetros:

* 'accion': que debe tomar el valor 'cambiar'.
* 'desvio1', 'desvio2', 'desvio3', 'desvio4', 'desvio5': los números de teléfono donde se recibirán las llamadas. Puede especificarlos todos, o sólo algunos, o ninguno.
* 'espera1', 'espera2', 'espera3', 'espera4', 'espera5': los segundos por los que se espera para realizar cada desvío. Por omisión, 0 segundos.

Opcionalmente:

* 'horario': en la forma HHMMHHMM, siendo los primeros cuatro dígitos la hora y minutos de inicio, los últimos cuatro dígitos la hora y minutos de finalización. Por ejemplo, un horario 00:00-23:59 sería de la forma 00002359.
* 'dias': un conjunto de caracteres (l: lunes, m: martes, x: miércoles, j: jueves, v: viernes, s: sábados, d: domingos, f: festivos) que especifican qué dias se ejecuta el horario. Por ejemplo, los días laborables se pondrían de la forma lmxjv. Fines de semana y festivos: sdf.

'horario' y 'dias' deben ser especificados conjuntamente.

Por ejemplo, si queremos modificar los desvíos del desvío por defecto del número virtual 902955955, haríamos:

 https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_desvios?principal=911922933&pin=0000&nv=902955955&accion=cambiar&desvio1=911922933@{{DOMINIO}}&espera1=0&desvio2=612345678&espera2=10

Otro ejemplo: modificamos un desvío por horario (días laborables de 12:00 a 13:00) de la extensión 1:

 https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_desvios?principal=911922933&pin=0000&ext=1&accion=cambiar&horario=12001300&dias=lmxjv&desvio1=911922933@{{DOMINIO}}&espera1=0&desvio2=612345678&espera2=10&desvio3=911922933&espera3=15

NOTA: para modificar los días o el horario de un desvío por horario tiene que primero borrar el horario anterior (ver siguiente sección) y después crear el horario nuevo (con los mismos desvíos que tenía el anterior).

===Borrar los desvíos===

Para borrar un desvío (por horario), debe especificar el campo acción como 'borrar'. Por ejemplo:

 https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_desvios?principal=911922933&pin=0000&ext=1&accion=borrar&horario=12001300&dias=lmxjv






----

----

'''Indice'''

[[Portada]]  >>  [[Desarrolladores]]  >>  API de desvíos.