Consultar el registro de llamadas de la centralita
- URL relativa: /cdr
Datos de una llamada
GET /cdr/<call id>
Permisos
Acceso a los registros de la centralita asignada a la Api Key utilizada.
Respuesta
La respuesta es un JSON con los siguientes campos
| Nombre | Descripción | Tipo | Comentarios |
|---|---|---|---|
| callId | id de llamada | String | |
| created | Fecha de la llamada | long | timestamp en milisegundos desde el 1/1/1970 (GMT) |
| duration | Duración total | int | en segundos |
| billsec | Duración descolgado | int | en segundos |
| hangupCause | Causa de cuelgue | String | |
| dst | Destino | String | |
| src | Origen | String | |
| dstStarts | Destino empieza por | String | |
| srcStarts | Origen empieza por | String | |
| srcName | Nombre de origen | String | |
| did | Número externo por el que entró la llamada | String | |
| c2c | Originada en c2c | Boolean | |
| c2cRequestIp | IP que originó el c2c | String | |
| c2cFrom | Origen del c2c | String | |
| c2cTo | Destino del c2c | String | |
| recording | Si hay grabación disponible | Boolean | |
| queueId | ID de la cola | String | Si la llamada ha pasado por una cola |
| queueWaitTime | Tiempo de espera en la cola | int | Si la llamada ha pasado por una cola |
| queueAgent | Agente que ha atendido la llamada | String | Si la llamada ha pasado por una cola |
| queueCause | Causa de colgado en la cola | String | Si la llamada ha pasado por una cola |
| queueReason | Razón de colgado en la cola | String | Si la llamada ha pasado por una cola |
Respuesta de ejemplo
{
"callId":"7bb5b023-c67e-471e-9145-7afa3b13faad",
"created":1401805669000,
"duration":5,
"billsec":0,
"hangupCause":"ORIGINATOR_CANCEL",
"dst":"966261122",
"src":"2023",
"did":null,
"srcName":"2023",
"c2c":false,
"c2cRequestIp":null,
"c2cFrom":null,
"c2cTo":null,
"recording":false,
"queueId": null,
"queueWaitTime": null,
"queueAgent": null,
"queueCause": null,
"queueReason": null
}
Valores posibles de queueCause
| Nombre | Descripción |
|---|---|
| cancel | No ha sido atendido el llamante |
| answered | Se ha atendido al llamante |
Si se ha cancelado la llamada, se rellena el campo "queueReason", que puede tener los siguientes valores:
| Nombre | Descripción |
|---|---|
| NONE | Sin razón específica |
| TIMEOUT | El llamante ha superado el tiempo máximo de espera en cola |
| NO_AGENT_TIMEOUT | El llamante ha superado el tiempo máximo para esperar a un agente |
| BREAK_OUT | El llamante ha abandonado |
Lista de llamadas
POST /cdr
Permisos
Acceso a los registros de la centralita asignada a la Api Key utilizada.
Petición
El servicio espera un petición en formato JSON ("Content-Type: application/json)") a modo de filtro, de no se así, devolverá un 400 (Bad Request).
Parámetros de la petición
| Nombre | Descripción | Tipo | Obligatorio | Comentario |
|---|---|---|---|---|
| from | Desde la fecha | long | no | en milisegundos desde el 1/1/1970 |
| to | Hasta la fecha | long | no | en milisegundos desde el 1/1/1970 |
| src | Número de origen | String | no | |
| dst | Número de destino | String | no | |
| did | Número por el que entró | String | no | |
| queueId | ID interno de la cola | String | no | Para obtener sólo las llamadas de una cola en particular |
| orderingField | Campo por el que ordenar | String | no | Por defecto se ordena por fecha. Valores posibles: [CREATED, SRC, DST, HANGUP_CAUSE, DID_NUMBER, DST_STARTS, SRC_STARTS] |
| ascending | Ordenación ascendente | Boolean | no | Por defecto se ordena de manera descendente |
| start | Número de registro inicial | int | no | |
| stop | Número de registro final | int | no |
Ejemplo de petición
{
"src": "2023",
"start": 0,
"stop": 2
}
Respuesta
El servicio web devolverá un JSON consistente en un array de objectos JSON cdr (como el ejemplo para un cdr en particular) conforme a los filtros especeficados.
- Si no se especifica start y stop, devuelve los últimos 50 resultados
- Si no se especifica orderingField, se devuelve por orden de creación descendente
Respuesta de ejemplo
[
{
"callId":"7bb5b023-c67e-471e-9145-7afa3b13faad",
"created":1401805669000,"duration":5,
"billsec":0,
"hangupCause":"ORIGINATOR_CANCEL",
"dst":"966261122",
"src":"2023",
"did":null,
"srcName":"2023",
"c2c":false,
"c2cRequestIp":null,
"c2cFrom":null,
"c2cTo":null,"recording":false,
"queueId": null,
"queueWaitTime": null,
"queueAgent": null,
"queueCause": null,
"queueReason": null
},
{
"callId":"e07cd6c6-c820-41ca-b548-92fba290bf4c",
"created":1401805600000,
"duration":30,
"billsec":29,
"hangupCause":"NORMAL_CLEARING",
"dst":"2021",
"src":"2023",
"did":null,
"srcName":"2023",
"c2c":false,
"c2cRequestIp":null,
"c2cFrom":null,
"c2cTo":null,
"recording":false,
"queueId": null,
"queueWaitTime": null,
"queueAgent": null,
"queueCause": null,
"queueReason": null
}
]
Número de llamadas
POST /cdrcount
- Este servicio se puede utilizar para la paginación de llamadas.
Permisos
Acceso a los registros de la centralita asignada a la Api Key utilizada.
Petición
El servicio espera una petición en formato JSON ("Content-Type: application/json") a modo de filtro, e no se así, devolverá un 400 (Bad Request).
Parámetros de la petición
| Nombre | Descripción | Tipo | Obligatorio | Comentario |
|---|---|---|---|---|
| from | Desde la fecha | long | no | en milisegundos desde el 1/1/1970 |
| to | Hasta la fecha | long | no | en milisegundos desde el 1/1/1970 |
| src | Número de origen | String | no | Empieza por |
| dst | Número de destino | String | no | Empieza por |
| did | Número por el que entró | String | no | Empieza por |
| orderingField | Campo por el que ordenar | String | no | Por defecto se ordena por fecha |
| ascending | Ordenación ascendente | Boolean | no | Por defecto se ordena de manera descendente |
| start | Número de registro inicial | int | no | |
| stop | Número de registro final | int | no |
Ejemplo de petición
{
"src": "2023"
}
Respuesta
El servicio web devolverá un JSON con la variable "count" y el número de registros para el filtro especificado.
Ejemplo de respuesta para el filtro anterior
{
"count":1420
}