Documentation de l'API de gestion des appels
Ces points de terminaison vous permettent de récupérer vos Appels manqués, Appels entrants répondus, et Appels sortants Synchronisé depuis l'application mobile SMSMobileAPI vers votre tableau de bord + API.
Important : si l’application mobile fonctionne en arrière-plan, le système téléphonique peut imposer un délai (jusqu’à environ 10 minutes) entre les synchronisations. Vous pouvez toujours ouvrir l’application pour synchroniser manuellement si nécessaire.
Démarrage rapide
URL de base
Exemples
Authentification
Les points de terminaison de gestion des appels s'authentifient à l'aide de clé API Paramètre de requête.
Concepts communs
Pagination
Utiliser limite et compenser paginer les résultats.
Horodatage
- date_appel_ms est un horodatage UNIX dans millisecondes.
- date_heure_appel_utc est stocké sous forme de chaîne de date et d'heure UTC (champ de base de données).
- Pour les appels manqués, l'API renvoie un formatage date chaîne de caractères (dérivée d'une valeur en millisecondes).
Recherche
- Appels manqués : recherche Correspond à un numéro ou à un nom.
- Entrées/Sorties : q matchs numéro de téléphone ou nom_en_caché.
Tri (entrant/sortant uniquement)
Le tri est contrôlé par Trier par + répertoire_sort (Champs autorisés uniquement). Les appels manqués sont toujours classés du plus récent au plus ancien.
Erreurs
| HTTP | Exemple d'erreur | Signification |
|---|---|---|
| 400 | {"success":false,"error":"missing_apikey"} | Manquant ou vide clé API. |
| 403 | {"success":false,"error":"invalid_apikey"} | Clé API introuvable / non reconnue. |
| 403 | {"success":false,"error":"api_expired"} | Votre abonnement a expiré (dateLimit (c'est avant aujourd'hui). |
| 500 | {"success":false,"error":"server_error","detail":"..."} | Erreur serveur (base de données, SQL, exception). |
Remarque : le point de terminaison des appels manqués peut également renvoyer des messages comme Clé API manquante ou des erreurs de préparation SQL, selon la situation.
Liste des appels manqués
Récupérer les appels manqués synchronisés depuis l'appareil mobile.
Point final
Paramètres de requête
| Paramètre | Taper | Description |
|---|---|---|
| clé API | chaîne | Requis Votre clé API liée au téléphone mobile. |
| compenser | int | Facultatif Décalage de pagination (par défaut : 0). |
| limite | int | Facultatif Nombre maximal de lignes (par défaut : 100, max: 500). |
| recherche | chaîne | Facultatif Recherche par numéro ou par nom (SQL LIKE). |
| date_début | AAAA-MM-JJ | Facultatif Filtrer à partir de ce jour (00:00:00). |
| date_end | AAAA-MM-JJ | Facultatif Filtrer jusqu'à aujourd'hui (23:59:59). |
Liste des appels entrants
Récupérer les appels entrants répondus synchronisés depuis l'appareil mobile.
Point final
Paramètres de requête
| Paramètre | Taper | Description |
|---|---|---|
| clé API | chaîne | Requis Votre clé API (validée par rapport à votre abonnement). |
| limite | int | Facultatif Lignes par page (par défaut : 50, max: 200). |
| compenser | int | Facultatif Décalage de pagination (par défaut : 0). |
| Trier par | chaîne | Facultatif Autorisé: date_appel_ms date_heure_appel_utc durée_sec numéro de téléphone créé_à nom_en_caché géolocalisation |
| répertoire_sort | ascendant|desc | Facultatif Défaut: desc. |
| date_from_ms | entier (ms) | Facultatif Filtrer où date_appel_ms >= date_de_début_ms. |
| date_to_ms | entier (ms) | Facultatif Filtrer où date_appel_ms <= date_à_ms. |
| q | chaîne | Facultatif Rechercher sur numéro de téléphone ou nom_en_caché (COMME). |
Liste des appels sortants
Récupérer les appels sortants synchronisés depuis l'appareil mobile.
Point final
Paramètres de requête
Mêmes paramètres et comportement que pour les appels entrants.
| Paramètre | Taper | Description |
|---|---|---|
| clé API | chaîne | Requis Votre clé API (validée par rapport à votre abonnement). |
| limite | int | Facultatif Lignes par page (par défaut : 50, max: 200). |
| compenser | int | Facultatif Décalage de pagination (par défaut : 0). |
| Trier par | chaîne | Facultatif Autorisé: date_appel_ms date_heure_appel_utc durée_sec numéro de téléphone créé_à nom_en_caché géolocalisation |
| répertoire_sort | ascendant|desc | Facultatif Défaut: desc. |
| date_from_ms | entier (ms) | Facultatif Filtrer où date_appel_ms >= date_de_début_ms. |
| date_to_ms | entier (ms) | Facultatif Filtrer où date_appel_ms <= date_à_ms. |
| q | chaîne | Facultatif Rechercher sur numéro de téléphone ou nom_en_caché (COMME). |
Champs d'appel manqué
| Champ | Taper | Description |
|---|---|---|
| succès | booléen | État de la demande. |
| compenser | int | Décalage de pagination renvoyé. |
| limite | int | Limite de pagination dépassée. |
| compter | int | Nombre de lignes renvoyées dans données. |
| données | tableau | Liste des appels manqués. |
| données[].nombre | chaîne | Numéro de téléphone de l'appelant. |
| données[].nom | chaîne | Nom du contact mis en cache (peut être vide). |
| data[].date | chaîne | Chaîne de date et d'heure formatée, dérivée d'un horodatage en millisecondes. |
Champs entrants/sortants
| Champ | Taper | Description |
|---|---|---|
| succès | booléen | État de la demande. |
| clé API | chaîne | Renvoyé par l'API (votre clé). |
| limite | int | Nombre de lignes par page renvoyées. |
| compenser | int | Décalage de pagination renvoyé. |
| Trier par | chaîne | Champ de tri appliqué. |
| répertoire_sort | chaîne | Direction de tri appliquée. |
| filtres | objet | Filtres écho (date_from_ms, date_to_ms, q). |
| compter | int | Nombre de lignes renvoyées dans rangées. |
| rangées | tableau | Liste des appels. |
| lignes[].numéro_de_téléphone | chaîne | Numéro de téléphone. |
| lignes[].nom_caché | chaîne|null | Nom du contact mis en cache (peut être nul). |
| lignes[].call_date_ms | int | Horodatage de l'appel en millisecondes. |
| lignes[].call_datetime_utc | chaîne | Champ de date et d'heure UTC (base de données). |
| lignes[].duration_sec | int | Durée en secondes. |
| lignes[].geo_location | chaîne|null | Étiquette de géolocalisation (peut être nulle/vide). |
| lignes[].created_at | chaîne | Horodatage d'insertion côté serveur. |
