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
Línea 1: Línea 1:
==Función getcallsbilling==
==Función getcallsbilling==


===parametros_obligatorios===  
===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 8: Línea 8:
   * 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)
   * 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 =  
===POST===  
   <syntaxhighlight lang="http">
   <syntaxhighlight lang="http">
   POST /api/ HTTP/1.1
   POST /api/ HTTP/1.1
Línea 31: Línea 31:
   </syntaxhighlight>
   </syntaxhighlight>


- ejemplo_GET =  
===GET===  
   <syntaxhighlight lang="http">
   <syntaxhighlight lang="http">
   GET /?ukey=token_autenticacion&func=getcallsbilling&model=toc&accountcode=&year=2023&month=2&limit=50&offset=0 HTTP/1.1
   GET /?ukey=token_autenticacion&func=getcallsbilling&model=toc&accountcode=&year=2023&month=2&limit=50&offset=0 HTTP/1.1
Línea 37: Línea 37:
   </syntaxhighlight>
   </syntaxhighlight>


- ejemplo_salida =  
===Ejemplo Salida===  
   <syntaxhighlight lang="json">
   <syntaxhighlight lang="json">
   {
   {

Revisión del 17:48 8 may 2023

Función getcallsbilling

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)
 * limit: Límite de registros (1 a 1000)
 * offset: Desplazamiento para paginación

POST

 <syntaxhighlight lang="http">
 POST /api/ HTTP/1.1
 Host: api.7kas.com
 Content-Type: application/json
 
 {
     "ukey": "token_autenticacion",
     "func": "getcallsbilling",
     "model": "toc",
     "year": 2023,
     "month": 2,
     "accountcode": "",
     "limit": 50,
     "offset": 0
 }
 </syntaxhighlight>

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 =