Diferencia entre revisiones de «API de consumos»
| Línea 3: | Línea 3: | ||
===URL=== | ===URL=== | ||
| − | + | La API de consumos se ofrece como un servicio web, accesible mediante la URL: | |
https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_consumos?principal=xxxxxxxxx&pin=1234 | https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_consumos?principal=xxxxxxxxx&pin=1234 | ||
| Línea 33: | Línea 33: | ||
* hora: hora en que empezó la llamada (HH:MM:SS). | * hora: hora en que empezó la llamada (HH:MM:SS). | ||
* duracion: duración de la llamada (HH:MM:SS). | * duracion: duración de la llamada (HH:MM:SS). | ||
| − | * tipo: | + | * tipo: indica el tipo de llamada. Sus posibles valores son: |
| + | ** numvirtual_desvio: una llamada a un número virtual que ha sido desviada a un teléfono. | ||
| + | ** numvirtual_buzón: una llamada a un número virtual que ha acabado en un buzón de voz. | ||
| + | ** fax_recibido: una llamada a un número de fax. | ||
| + | ** fax_mandado: un envío de fax. | ||
| + | ** centralita_entrante: una llamada a un número de centralita. Dentro de esta llamada pueden producirse múltiples eventos: desvíos, redirecciones a otras extensiones, buzones de voz, menús telefónicos, etc. El tiempo de esta llamada es el total. | ||
| + | ** centralita_desvio: un desvío dentro de una extensión. Siempre va unido a una llamada del tipo centralita_entrante. | ||
| + | ** llamada_web: una llamada efectuada desde el Identificador de Llamadas o desde la página web. Puede ser cualquiera de sus terminaciones (Origen o Destino): esto viene especificado en el acceso. | ||
| + | ** llamada_saliente_voip: una llamada efectuada desde un VoIP | ||
| + | ** llamada_saliente: una llamada efectuada desde cualquier medio no VoIP. | ||
* llamante: número de teléfono del llamante. | * llamante: número de teléfono del llamante. | ||
* nombre_llamante: nombre del llamante según los contactos del cliente (va encerrado entre comillas simples). | * nombre_llamante: nombre del llamante según los contactos del cliente (va encerrado entre comillas simples). | ||
Revisión del 15:17 16 ene 2009
Atención: este es un área en desarrollo.
URL
La API de consumos se ofrece como un servicio web, accesible mediante la URL:
https://scgi.duocom.es/cgi-bin/telefacil2/api_consumos?principal=xxxxxxxxx&pin=1234
Para los clientes de Canarias, la URL es:
https://cgi.duocom.es/cgi-bin/telefacil2/api_consumos?principal=xxxxxxxxx&pin=1234
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 Telefácil".
- 'pin' es el PIN de la cuenta Telefácil
Parámetros opcionales
- 'finicio' indica la fecha de inicio desde la que se quieren consultar los consumos. Debe estar en formato DD-MM-YYYY. Por defecto, toma el valor del día de hoy.
- 'ffinal' indica la fecha final hasta la que se quieren consultar los consumos. Debe estar en formato DD-MM-YYYY. Por defecto, toma el valor del día de hoy.
- 'llamante' permite filtrar llamadas según el llamante.
- 'acceso' permite filtrar llamadas según el acceso usado en la llamada.
- 'llamado' permite filtrar llamadas según el número llamado final.
- 'tipo_filtro': si especifica más de un filtro (llamante, acceso, llamado), puede variar el comportamiento con este parámetro. Sus posibles valores son AND (todos los filtros deben cumplirse) y OR (basta con que un filtro se cumpla). El valor por omisión es OR.
- 'tipo_regla': regula las comparaciones entre los valores de llamado, llamante y acceso y los filtros especificados. Sus valores son: ES, EMPIEZA_POR y CONTIENE. El valor por omisión es CONTIENE.
Resultado
La URL api_consumos devuelve una respuesta text/plain, con una serie de líneas de texto con los siguientes campos:
- fecha: fecha de la llamada (DD/MM/YYYY).
- hora: hora en que empezó la llamada (HH:MM:SS).
- duracion: duración de la llamada (HH:MM:SS).
- tipo: indica el tipo de llamada. Sus posibles valores son:
- numvirtual_desvio: una llamada a un número virtual que ha sido desviada a un teléfono.
- numvirtual_buzón: una llamada a un número virtual que ha acabado en un buzón de voz.
- fax_recibido: una llamada a un número de fax.
- fax_mandado: un envío de fax.
- centralita_entrante: una llamada a un número de centralita. Dentro de esta llamada pueden producirse múltiples eventos: desvíos, redirecciones a otras extensiones, buzones de voz, menús telefónicos, etc. El tiempo de esta llamada es el total.
- centralita_desvio: un desvío dentro de una extensión. Siempre va unido a una llamada del tipo centralita_entrante.
- llamada_web: una llamada efectuada desde el Identificador de Llamadas o desde la página web. Puede ser cualquiera de sus terminaciones (Origen o Destino): esto viene especificado en el acceso.
- llamada_saliente_voip: una llamada efectuada desde un VoIP
- llamada_saliente: una llamada efectuada desde cualquier medio no VoIP.
- llamante: número de teléfono del llamante.
- nombre_llamante: nombre del llamante según los contactos del cliente (va encerrado entre comillas simples).
- acceso: medio utilizado en la llamada.
- llamado: número de teléfono receptor de la llamada.
- nombre_llamado: nombre del receptor de la llamada según los contactos del cliente (va encerrado entre comillas simples).
- pais: nombre del país del número de teléfono receptor.
- cobro: cantidad en euros cobrada por la llamada.
- saldo: saldo de la cuenta Telefácil después de la llamada.
- colgo: indica quién colgó la llamada. Sus posibles valores son Llamante y Receptor.
