Diferencia entre revisiones de «API CDR Salientes»

De Wiki 7Kas
Ir a la navegación Ir a la búsqueda
Sin resumen de edición
 
(No se muestran 38 ediciones intermedias del mismo usuario)
Línea 1: Línea 1:
| nombre = getcallsbilling
==Función getcallsbilling==


| parametros_obligatorios =  
Con ésta función podemos recuperar hasta 7 años de antigüedad en las llamadas salientes realizadas por nuestros clientes. Existen dos modelos de salida:
 
* VOC: Es el detalle de la llamada
* TOC: Es el resumen totalizado de costes, número de llamadas, duración en segundos y por tipo de llamada
 
===Parametros Obligatorios===  
   * ukey: Token de autenticación
   * ukey: Token de autenticación
   * func: Función a llamar (en este caso, "getcallsbilling")
   * func: Función a llamar (en este caso, "getcallsbilling")
Línea 7: Línea 12:
   * year: Año (p.ej. 2023)
   * year: Año (p.ej. 2023)
   * month: Mes (p.ej. 2)
   * month: Mes (p.ej. 2)
| parametros_opcionales =  
 
===Parametros Opcionales===  
   * accountcode: Código de cuenta (opcional, si no se indica muestra todos los clientes)
   * accountcode: Código de cuenta (opcional, si no se indica muestra todos los clientes)
  * day: Día del mes y opcionalmente,
        hour: También se puede indicar la hora del día.
   * limit: Límite de registros (1 a 1000)
   * limit: Límite de registros (1 a 1000)
   * offset: Desplazamiento para paginación
   * offset: Desplazamiento para paginación
| ejemplo_POST =  
 
  <syntaxhighlight lang="http">
===Ejemplo GET===  
  POST /api/ HTTP/1.1
https://apiserver:port/?ukey=token_autenticacion&func=getcallsbilling&model=voc&accountcode=&year=2023&month=2&limit=50&offset=0
  Host: api.7kas.com
 
  Content-Type: application/json
===Salida===
 
 
  {
Modelo VOC
      "ukey": "token_autenticacion",
{ "RecordCount" : 1, "fields" : ["callstart", "accountcode", "dst", "prefix", "dtype", "cid_num", "cid_name", "dial_cid_num", "cli_billing", "context", "billsec", "tariff", "rate_pickup", "rate_rate", "rate_total", "credit", "r_tariff", "r_pickup", "r_rate", "r_total", "r_credit", "flags", "fromuri", "fromtag", "totag", "sipmsg", "beneficio"], "1" : ["01/04/2023 23:46:20", "1700", "91xxxxxxx", "9", "FIJO", "62xxxxxxx", "", "62xxxxxxx", "91xxxxxxx", "endpoints", "115", "RVgeneral5", "", "0,007", "0,0134", "4474,69", "2016-generalcli", "", "0,0149", "0,0286", "1064,79", "1", "sip:62xxxxxxx@xxx.xxx.xxx.xxx:5060", "as350caaae", "41S4NBU46ypQr", "BYE", "0,0079"] }
      "func": "getcallsbilling",
 
      "model": "toc",
Modelo TOC
      "year": 2023,
{ "RecordCount" : 1, "fields" : ["accountcode", "dtype", "calls", "billsec", "root_pickup", "root_rate", "root_total", "accountcode_pickup", "accountcode_rate", "accountcode_total"], "1" : ["1700", "MÓVIL", "1", "7", "", "0,0058", "0,0057", "", "0,0021", "0,002"] }
      "month": 2,
 
      "accountcode": "",
===Notas===
      "limit": 50,
      "offset": 0
  }
  </syntaxhighlight>
| ejemplo_GET =
  <syntaxhighlight lang="http">
  GET /?ukey=token_autenticacion&func=getcallsbilling&model=toc&accountcode=&year=2023&month=2&limit=50&offset=0 HTTP/1.1
  Host: api.7kas.com
  </syntaxhighlight>
| ejemplo_salida =
  <syntaxhighlight lang="json">
  {
      "resultado": "ejemplo_resultado",
      "otros_datos": "otros_valores"
  }
  </syntaxhighlight>
| notas =  
  * Nota 1: Información adicional
  * Nota 2: Información adicional

Revisión actual - 23:49 13 may 2023

Función getcallsbilling

Con ésta función podemos recuperar hasta 7 años de antigüedad en las llamadas salientes realizadas por nuestros clientes. Existen dos modelos de salida: 

* VOC: Es el detalle de la llamada
* TOC: Es el resumen totalizado de costes, número de llamadas, duración en segundos y por tipo de llamada

Parametros Obligatorios

 * ukey: Token de autenticación
 * func: Función a llamar (en este caso, "getcallsbilling")
 * model: Modelo ("toc" o "voc")
 * year: Año (p.ej. 2023)
 * month: Mes (p.ej. 2)

Parametros Opcionales

 * accountcode: Código de cuenta (opcional, si no se indica muestra todos los clientes)
 * day: Día del mes y opcionalmente,
        hour: También se puede indicar la hora del día.
 * limit: Límite de registros (1 a 1000)
 * offset: Desplazamiento para paginación

Ejemplo GET

https://apiserver:port/?ukey=token_autenticacion&func=getcallsbilling&model=voc&accountcode=&year=2023&month=2&limit=50&offset=0

Salida

Modelo VOC 

{ "RecordCount" : 1, "fields" : ["callstart", "accountcode", "dst", "prefix", "dtype", "cid_num", "cid_name", "dial_cid_num", "cli_billing", "context", "billsec", "tariff", "rate_pickup", "rate_rate", "rate_total", "credit", "r_tariff", "r_pickup", "r_rate", "r_total", "r_credit", "flags", "fromuri", "fromtag", "totag", "sipmsg", "beneficio"], "1" : ["01/04/2023 23:46:20", "1700", "91xxxxxxx", "9", "FIJO", "62xxxxxxx", "", "62xxxxxxx", "91xxxxxxx", "endpoints", "115", "RVgeneral5", "", "0,007", "0,0134", "4474,69", "2016-generalcli", "", "0,0149", "0,0286", "1064,79", "1", "sip:62xxxxxxx@xxx.xxx.xxx.xxx:5060", "as350caaae", "41S4NBU46ypQr", "BYE", "0,0079"] }

Modelo TOC 

{ "RecordCount" : 1, "fields" : ["accountcode", "dtype", "calls", "billsec", "root_pickup", "root_rate", "root_total", "accountcode_pickup", "accountcode_rate", "accountcode_total"], "1" : ["1700", "MÓVIL", "1", "7", "", "0,0058", "0,0057", "", "0,0021", "0,002"] }

Notas

Obtenido de «https://wiki.7kas.com/index.php?title=API_CDR_Salientes&oldid=95»