Documentation de l'API de notification
Ces points d'accès vous permettent de envoyer des notifications mobiles internes et consulter l'historique des notifications Grâce à l'API SMSMobile, des notifications peuvent être envoyées à un appareil mobile spécifique, puis suivies via le point de terminaison de liste.
Le notification/list Le point de terminaison renvoie l'heure d'envoi et l'heure de distribution de la notification. GMT, y compris les chaînes de date et d'heure complètes et Horodatages Unix.
Démarrage rapide
URL de base
Exemples
Authentification
Les points de terminaison de notification s'authentifient à l'aide de clé API paramètre.
Concepts communs
Cible mobile
Les notifications sont envoyées à un appareil mobile spécifique via SidLe point de terminaison de liste peut filtrer la même cible en utilisant sidentifiant ou Sid.
État distribué
- distribué=1 signifie que la notification a été diffusée.
- distribué=0 signifie non distribué.
- statut_distribué retours distribué ou non distribué.
Dates et fuseaux horaires
- envoyé_* Les champs représentent la date et l'heure d'envoi de la notification. GMT.
- distribué_* Les champs représentent la date/heure de distribution en GMT.
- *_à_unix Les champs sont des horodatages Unix.
Comportement du point de terminaison de la liste
- Le point de terminaison de liste renvoie toujours un maximum de 200 rangées.
- Les résultats sont classés du plus récent au plus ancien en fonction de la date et de l'heure d'envoi.
- Les filtres de date utilisent dateAjout en interne et sont exposés comme date_de_début / date_à.
Erreurs
| HTTP | Exemple d'erreur | Signification |
|---|---|---|
| 400 | {"success":false,"message":"Paramètre requis manquant : apikey."} | Manquant ou vide clé API. |
| 400 | {"success":false,"message":"Paramètres requis manquants : la clé API et le SID sont obligatoires."} | Manquant Sid sur notification/envoi. |
| 400 | {"success":false,"message":"Paramètre obligatoire manquant : message."} | Manquant message sur notification/envoi. |
| 400 | {"success":false,"message":"Format de date invalide. Format attendu : AAAA-MM-JJ."} | Invalide date_de_début format sur notification/list. |
| 400 | {"success":false,"message":"Valeur distribuée invalide. Valeurs autorisées : 0 ou 1."} | Invalide distribué valeur du filtre. |
| 500 | {"success":false,"message":"Échec de la connexion à la base de données."} | Problème de connexion à la base de données. |
| 500 | {"success":false,"message":"Échec de la requête : ..."} | Erreur SQL / d'exécution. |
Notification – Envoyer
Créer une nouvelle notification pour un appareil mobile cible.
Point final
Paramètres de requête / corps
| Paramètre | Taper | Description |
|---|---|---|
| clé API | chaîne | Requis Votre clé API. |
| Sid | chaîne | Requis Identifiant mobile cible. |
| titre | chaîne | Facultatif Titre de la notification. Par défaut : Notification. |
| message | chaîne | Requis Contenu du message de notification. |
| taper | chaîne | Facultatif Type de notification. Par défaut : notification. |
Exemple de réponse positive
{ "success": true, "message": "Notification créée.", "id": 22087, "apikey": "YOUR_API_KEY", "sid": "508b004b4aadacc4" }
Notification – Liste
Récupérez les dernières notifications pour une clé API, avec filtrage optionnel.
Point final
Paramètres de requête
| Paramètre | Taper | Description |
|---|---|---|
| clé API | chaîne | Requis Votre clé API. |
| sidentifiant | chaîne | Facultatif Filtrer les notifications par mobile cible. |
| Sid | chaîne | Facultatif Alias de sidentifiant. |
| distribué | 0 | 1 | Facultatif 1 = distribué uniquement, 0 = non distribué uniquement. |
| date_de_début | AAAA-MM-JJ | Facultatif Filtrer la date d'envoi à partir d'aujourd'hui. |
| date_à | AAAA-MM-JJ | Facultatif Date d'envoi du filtre jusqu'à aujourd'hui. |
Exemple de réponse positive
{ "success": true, "message": "Notifications récupérées avec succès.", "filters": { "sidentifiant": "508b004b4aadacc4", "distribued": "1", "date_from": "", "date_to": "", "limit": 200 }, "count": 1, "data": [ { "sidentifiant": "508b004b4aadacc4", "title": "Notification", "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" } ] }
Champs de réponse d'envoi
| Champ | Taper | Description |
|---|---|---|
| succès | booléen | État de la demande. |
| message | chaîne | Message de résultat lisible par l'humain. |
| identifiant | int | ID de notification créé dans la base de données. |
| clé API | chaîne | Clé API renvoyée. |
| Sid | chaîne | Identifiant mobile cible utilisé lors de la création. |
Liste des champs de réponse
| Champ | Taper | Description |
|---|---|---|
| succès | booléen | État de la demande. |
| message | chaîne | Message de résultat lisible par l'humain. |
| filtres | objet | Filtres utilisés par la requête. |
| compter | int | Nombre de notifications retournées. |
| données | tableau | Liste des notifications. |
| data[].sidentifiant | chaîne | Identifiant mobile cible. |
| données[].titre | chaîne | Titre de la notification. |
| données[].message | chaîne | Message de notification. |
| données[].distribuées | chaîne | Drapeau distribué brut. |
| data[].distribued_status | chaîne | distribué ou non distribué. |
| data[].distributed_date_gmt | chaîne | Date de distribution en GMT. |
| data[].distributed_time_gmt | chaîne | Heure de distribution en GMT. |
| données[].distribuées_à_gmt | chaîne | Date et heure de distribution complètes en GMT. |
| données[].distribuées_sous_unix | entier|null | Distribution de la date et de l'heure au format timestamp Unix. |
| data[].distributed_timezone | chaîne | Toujours GMT. |
| data[].sent_date_gmt | chaîne | Envoyer la date en GMT. |
| data[].sent_time_gmt | chaîne | Envoyez l'heure en GMT. |
| data[].sent_at_gmt | chaîne | Date et heure d'envoi complètes en GMT. |
| data[].sent_at_unix | entier|null | Envoyer la date et l'heure au format timestamp Unix. |
| data[].sent_timezone | chaîne | Toujours GMT. |
