Documentación de la API de notificaciones
Estos puntos finales te permiten enviar notificaciones móviles internas y recuperar historial de notificaciones Desde SMSMobileAPI. Se pueden enviar notificaciones a un dispositivo móvil específico y luego realizar un seguimiento a través del punto final de la lista.
El notificación/lista El punto final devuelve el tiempo de envío de la notificación y el tiempo de distribución en GMT, incluyendo cadenas de fecha y hora completas y marcas de tiempo Unix.
Inicio rápido
URL base
Ejemplos
Autenticación
Los puntos finales de notificación se autentican mediante el clave de api parámetro.
Conceptos comunes
Target móvil
Las notificaciones se envían a un dispositivo móvil específico mediante lado. El punto final de la lista puede filtrar el mismo objetivo usando identificador o lado.
Estado distribuido
- distribuido=1 significa que la notificación fue distribuida.
- distribuido=0 significa no distribuido.
- estado_distribuido devoluciones repartido o no_distribuido.
Fechas y zonas horarias
- enviado_* Los campos representan la fecha y hora de envío de la notificación en GMT.
- repartido_* Los campos representan la fecha/hora de distribución en GMT.
- *_en_unix Los campos son marcas de tiempo Unix.
Comportamiento del punto final de la lista
- El punto final de la lista siempre devuelve un máximo de 200 filas.
- Los resultados se ordenan del más reciente al más antiguo según la fecha y hora de envío.
- Los filtros de fecha utilizan fechaAñadir internamente y están expuestos como fecha_desde / fecha_a.
Errores
| HTTP | Ejemplo de error | Significado |
|---|---|---|
| 400 | {"éxito":falso,"mensaje":"Falta el parámetro obligatorio: apikey."} | Falta o vacío clave de api. |
| 400 | {"éxito":falso,"mensaje":"Faltan parámetros obligatorios: apikey y sid son obligatorios."} | Desaparecido lado en notificación/enviar. |
| 400 | {"éxito":falso,"mensaje":"Falta el parámetro obligatorio: mensaje."} | Desaparecido mensaje en notificación/enviar. |
| 400 | {"éxito":falso,"mensaje":"Formato de fecha_desde no válido. Se esperaba AAAA-MM-DD."} | Inválido fecha_desde formato en notificación/lista. |
| 400 | {"éxito":falso,"mensaje":"Valor distribuido no válido. Valores permitidos: 0 o 1."} | Inválido distribuido valor del filtro. |
| 500 | {"éxito":falso,"mensaje":"Error de conexión a la base de datos."} | Problema de conexión con la base de datos. |
| 500 | {"éxito":falso,"mensaje":"La consulta falló: ..."} | Error de SQL/ejecución. |
Notificación – Enviar
Crea una nueva notificación para un dispositivo móvil de destino.
Punto final
Parámetros de consulta/cuerpo
| Parámetro | Tipo | Descripción |
|---|---|---|
| clave de api | cadena | Requerido Su clave API. |
| lado | cadena | Requerido Identificador móvil objetivo. |
| título | cadena | Opcional Título de la notificación. Predeterminado: Notificación. |
| mensaje | cadena | Requerido Contenido del mensaje de notificación. |
| tipo | cadena | Opcional Tipo de notificación. Predeterminado: notificación. |
Ejemplo de respuesta exitosa
{ "success": true, "message": "Notificación creada.", "id": 22087, "apikey": "TU_CLAVE_API", "sid": "508b004b4aadacc4" }
Notificación – Lista
Obtén las últimas notificaciones para una clave API, con filtrado opcional.
Punto final
Parámetros de consulta
| Parámetro | Tipo | Descripción |
|---|---|---|
| clave de api | cadena | Requerido Su clave API. |
| identificador | cadena | Opcional Filtra las notificaciones por móvil de destino. |
| lado | cadena | Opcional Alias de identificador. |
| distribuido | 0 | 1 | Opcional 1 = distribuido únicamente, 0 = no distribuido únicamente. |
| fecha_desde | AAAA-MM-DD | Opcional Filtrar la fecha de envío a partir de hoy. |
| fecha_a | AAAA-MM-DD | Opcional Filtrar la fecha de envío hasta el día de hoy. |
Ejemplo de respuesta exitosa
{ "success": true, "message": "Notificaciones recuperadas correctamente.", "filters": { "sidentifiant": "508b004b4aadacc4", "distribued": "1", "date_from": "", "date_to": "", "limit": 200 }, "count": 1, "data": [ { "sidentifiant": "508b004b4aadacc4", "title": "Notificación", "message": "vers miano", "distribued": "1", "distribued_status": "distributed", "distributed_date_gmt": "2026-03-18", "distributed_time_gmt": "10:18:30", "distributed_at_gmt": "2026-03-18 10:18:30", "distributed_at_unix": 1773829110, "distributed_timezone": "GMT", "sent_date_gmt": "2026-03-18", "sent_time_gmt": "10:15:03", "sent_at_gmt": "2026-03-18 10:15:03", "sent_at_unix": 1773828903, "sent_timezone": "GMT" } ] }
Enviar campos de respuesta
| Campo | Tipo | Descripción |
|---|---|---|
| éxito | bool | Estado de la solicitud. |
| mensaje | cadena | Mensaje de resultado legible para humanos. |
| identificación | entero | Se creó el ID de notificación en la base de datos. |
| clave de api | cadena | Clave API repetida. |
| lado | cadena | Identificador móvil de destino utilizado durante la creación. |
Campos de respuesta de lista
| Campo | Tipo | Descripción |
|---|---|---|
| éxito | bool | Estado de la solicitud. |
| mensaje | cadena | Mensaje de resultado legible para humanos. |
| filtros | objeto | Filtros utilizados por la solicitud. |
| contar | entero | Número de notificaciones devueltas. |
| datos | formación | Lista de notificaciones. |
| datos[].identificador | cadena | Identificador móvil de destino. |
| datos[].título | cadena | Título de la notificación. |
| datos[].mensaje | cadena | Mensaje de notificación. |
| datos[].distribuidos | cadena | Bandera distribuida sin procesar. |
| datos[].estado_distribuido | cadena | repartido o no_distribuido. |
| datos[].distributed_date_gmt | cadena | Fecha de distribución en GMT. |
| datos[].distributed_time_gmt | cadena | Hora de distribución en GMT. |
| datos[].distribuidos_a_gmt | cadena | Fecha y hora de distribución completas en GMT. |
| datos[].distribuidos_en_unix | entero|nulo | Fecha y hora de distribución como marca de tiempo Unix. |
| datos[].zona_de_tiempo_distribuida | cadena | Siempre GMT. |
| datos[].fecha_envío_gmt | cadena | Enviar fecha en GMT. |
| datos[].sent_time_gmt | cadena | Enviar la hora en GMT. |
| datos[].sent_at_gmt | cadena | Fecha y hora de envío completas en GMT. |
| datos[].sent_at_unix | entero|nulo | Enviar fecha y hora como marca de tiempo Unix. |
| datos[].zona_de_tiempo_enviado | cadena | Siempre GMT. |
