Saltar a: navegación, buscar

Diferencia entre revisiones de «API de consumos»

Línea 1: Línea 1:
 
'''Atención: este es un área en desarrollo.'''
 
'''Atención: este es un área en desarrollo.'''
 +
 +
===URL===
  
 
Para invocar a la API de consumos, debe acceder a la URL:
 
Para invocar a la API de consumos, debe acceder a la URL:
Línea 9: Línea 11:
 
   https://cgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_consumos?principal=xxxxxxxxx&pin=1234
 
   https://cgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_consumos?principal=xxxxxxxxx&pin=1234
  
Donde
+
===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}}".
 
* '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}}
 
* 'pin' es el PIN de la cuenta {{PRODUCTO}}
  
Ambos son campos obligatorios.
+
===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===

Revisión del 15:06 16 ene 2009

Atención: este es un área en desarrollo.

URL

Para invocar a la API de consumos, debe acceder a 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