Documentación de la API de gestión de llamadas
Estos puntos finales le permiten recuperar sus Llamadas perdidas, Llamadas entrantes contestadas, y Llamadas salientes sincronizado desde la aplicación móvil SMSMobileAPI a su panel de control + API.
Importante: Si la aplicación móvil se ejecuta en segundo plano, el sistema del teléfono puede tener un retraso (normalmente de hasta 10 minutos) entre sincronizaciones. Siempre puedes abrir la aplicación para sincronizar manualmente si es necesario.
Inicio rápido
URL base
Ejemplos
Autenticación
Los puntos finales de gestión de llamadas se autentican mediante el clave de api parámetro de consulta.
Conceptos comunes
Paginación
Usar límite y compensar para paginar resultados.
Marcas de tiempo
- fecha_de_llamada_ms es una marca de tiempo UNIX en milisegundos.
- fecha_hora_utc_de_llamada se almacena como una cadena de fecha y hora UTC (campo de base de datos).
- Para las llamadas perdidas, la API devuelve un formato fecha cadena (derivada de un valor de milisegundos).
Buscar
- Llamadas perdidas: buscar coincide con el número o nombre.
- Entrante/Saliente: q partidos número de teléfono o nombre_en_caché.
Clasificación (solo entrante/saliente)
La clasificación está controlada por Ordenar por + directorio_de_ordenación (Solo campos permitidos). Las llamadas perdidas se ordenan siempre de más reciente a más reciente.
Errores
| HTTP | Ejemplo de error | Significado |
|---|---|---|
| 400 | {"éxito":falso,"error":"falta_clave_de_api"} | Falta o vacío clave de api. |
| 403 | {"éxito":falso,"error":"clave_de_api_inválida"} | Clave API no encontrada/no reconocida. |
| 403 | {"éxito":falso,"error":"api_expired"} | Su suscripción ha expirado (límite de fecha es anterior a hoy). |
| 500 | {"éxito":falso,"error":"error_del_servidor","detalle":"..."} | Error del servidor (base de datos, SQL, excepción). |
Nota: el punto final de llamadas perdidas también puede devolver mensajes como Falta la clave API o errores de preparación de SQL según la situación.
Llamadas perdidas – Lista
Recuperar llamadas perdidas sincronizadas desde el dispositivo móvil.
Punto final
Parámetros de consulta
| Parámetro | Tipo | Descripción |
|---|---|---|
| clave de api | cadena | Requerido Su clave API vinculada al teléfono móvil. |
| compensar | entero | Opcional Desplazamiento de paginación (predeterminado: 0). |
| límite | entero | Opcional Máximo de filas (predeterminado: 100, máximo: 500). |
| buscar | cadena | Opcional Buscar por número o nombre (LIKE SQL). |
| fecha_de_inicio | AAAA-MM-DD | Opcional Filtro de este día (00:00:00). |
| fecha_fin | AAAA-MM-DD | Opcional Filtrar hasta el día de hoy (23:59:59). |
Llamadas entrantes – Lista
Recuperar llamadas entrantes contestadas sincronizadas desde el dispositivo móvil.
Punto final
Parámetros de consulta
| Parámetro | Tipo | Descripción |
|---|---|---|
| clave de api | cadena | Requerido Su clave API (validada contra suscripción). |
| límite | entero | Opcional Filas por página (predeterminado: 50, máximo: 200). |
| compensar | entero | Opcional Desplazamiento de paginación (predeterminado: 0). |
| Ordenar por | cadena | Opcional Permitido: fecha_de_llamada_ms fecha_hora_utc_de_llamada duración_seg número de teléfono creado_en nombre_en_caché geo_ubicación |
| directorio_de_ordenación | ascendente|descendente | Opcional Por defecto: descripción. |
| fecha_desde_ms | entero (ms) | Opcional Filtrar donde fecha_de_llamada_ms >= fecha_desde_ms. |
| fecha_a_ms | entero (ms) | Opcional Filtrar donde fecha_de_llamada_ms <= fecha_a_ms. |
| q | cadena | Opcional Buscar en número de teléfono o nombre_en_caché (COMO). |
Llamadas salientes – Lista
Recuperar llamadas salientes sincronizadas desde el dispositivo móvil.
Punto final
Parámetros de consulta
Mismos parámetros y comportamiento que las llamadas entrantes.
| Parámetro | Tipo | Descripción |
|---|---|---|
| clave de api | cadena | Requerido Su clave API (validada contra suscripción). |
| límite | entero | Opcional Filas por página (predeterminado: 50, máximo: 200). |
| compensar | entero | Opcional Desplazamiento de paginación (predeterminado: 0). |
| Ordenar por | cadena | Opcional Permitido: fecha_de_llamada_ms fecha_hora_utc_de_llamada duración_seg número de teléfono creado_en nombre_en_caché geo_ubicación |
| directorio_de_ordenación | ascendente|descendente | Opcional Por defecto: descripción. |
| fecha_desde_ms | entero (ms) | Opcional Filtrar donde fecha_de_llamada_ms >= fecha_desde_ms. |
| fecha_a_ms | entero (ms) | Opcional Filtrar donde fecha_de_llamada_ms <= fecha_a_ms. |
| q | cadena | Opcional Buscar en número de teléfono o nombre_en_caché (COMO). |
Campos de llamadas perdidas
| Campo | Tipo | Descripción |
|---|---|---|
| éxito | bool | Estado de la solicitud. |
| compensar | entero | Se devolvió el desplazamiento de paginación. |
| límite | entero | Límite de paginación devuelto. |
| contar | entero | Número de filas devueltas en datos. |
| datos | formación | Lista de llamadas perdidas. |
| datos[].número | cadena | Número de teléfono de la persona que llama. |
| datos[].nombre | cadena | Nombre del contacto en caché (puede estar vacío). |
| datos[].fecha | cadena | Cadena de fecha y hora formateada derivada de una marca de tiempo en milisegundos. |
Campos de entrada/salida
| Campo | Tipo | Descripción |
|---|---|---|
| éxito | bool | Estado de la solicitud. |
| clave de api | cadena | Reproducido por API (su clave). |
| límite | entero | Filas por página devueltas. |
| compensar | entero | Se devolvió el desplazamiento de paginación. |
| Ordenar por | cadena | Campo de ordenación aplicado. |
| directorio_de_ordenación | cadena | Dirección de clasificación aplicada. |
| filtros | objeto | Filtros de eco (fecha_desde_ms, fecha_a_ms, q). |
| contar | entero | Número de filas devueltas en filas. |
| filas | formación | Lista de llamadas. |
| filas[].número_de_teléfono | cadena | Número de teléfono. |
| filas[].nombre_cached | cadena|nulo | Nombre del contacto en caché (puede ser nulo). |
| filas[].call_date_ms | entero | Marca de tiempo de llamada en milisegundos. |
| filas[].call_datetime_utc | cadena | Campo de fecha y hora UTC (base de datos). |
| filas[].duración_seg | entero | Duración en segundos. |
| filas[].geo_ubicación | cadena|nulo | Etiqueta de ubicación geográfica (puede ser nula/vacía). |
| filas[].creadas_en | cadena | Marca de tiempo de inserción del servidor. |
