Commencez ici
Votre première demande en quatre étapes
Créez un compte et copiez la clé API depuis le tableau de bord.
Installez l'application mobile et confirmez que l'appareil est en ligne.
Envoyez un SMS de test avec le point de terminaison /sendsms/.
Stockez l'ID du message renvoyé pour corréler les journaux et l'état de livraison.
Application mobile officielle
Le pont sécurisé entre votre téléphone, votre tableau de bord et votre API.
Les opérations SMS et appels passent par l'application officielle SMSMobileAPI installée sur votre téléphone connecté. L'application associe en toute sécurité l'appareil à votre compte, synchronise les événements autorisés et relie le réseau mobile au tableau de bord et à l'API REST.
- Communications signées distribuées via les listes officielles de Google Play et Apple App Store
- Contrôles d'examen, de signature et de distribution des plateformes Google et Apple
- Couplage sécurisé des appareils, transport HTTPS et accès API authentifié
- Uniquement les autorisations requises pour les fonctionnalités mobiles que vous activez
Authentification
Conservez les informations d'identification sur votre serveur
Chaque requête accepte une clé API via le paramètre apikey. Les informations d'identification du client OAuth2 sont également disponibles pour les intégrations de serveur à serveur. N'exposez jamais une clé de production dans le code du navigateur, les référentiels publics ou les messages d'assistance.
POSTE · GET
Envoyer un SMS
https://api.smsmobileapi.com/sendsms/Mette un message en file d'attente sur un téléphone connecté. Le POST est recommandé lorsque le message est long ou contient des caractères spéciaux.
Utilisez-le pour les messages transactionnels, les rappels, les alertes et les SMS générés par l'application.
Paramètres
| Nom | Taper | Exigence | Désignation des marchandises |
|---|---|---|---|
apikey |
chaîne | Requis | Clé API de votre compte. |
recipients |
téléphone | Requis | Numéro de destination au format international. |
message |
chaîne | Requis | Corps du message. Encodez-le en URL lors de l'utilisation de GET. |
port |
1 | 2 | Facultatif | Port SIM sur les appareils Android compatibles ; laissez vide pour la sélection automatique. |
sIdentifiant |
chaîne | Facultatif | SID du téléphone connecté spécifique ; laissez vide pour le premier appareil disponible. |
shorturl |
0 | 1 | Facultatif | Définissez sur 1 pour raccourcir les URL trouvées dans le message. |
sendsms |
0 | 1 | Facultatif | Drapeau du canal SMS. La valeur par défaut est 1 en cas d'omission. |
sendwa |
0 | 1 | Facultatif | Demandez également la livraison WhatsApp lorsque le compte le prend en charge. |
encrypt_message |
Oui | Facultatif | Cryptez le message pour une lecture protégée côté destinataire. |
schedule_timestamp |
Secondes Unix | Facultatif | Heure UTC à partir de laquelle le message peut être envoyé. |
Exemple de demande
curl -X POST "https://api.smsmobileapi.com/sendsms/" \
-d "apikey=YOUR_API_KEY" \
-d "recipients=+1234567890" \
--data-urlencode "message=Your appointment is confirmed for tomorrow."
Exemple de réponse
{
"result": {
"error": 0,
"sent": "1",
"id": "c319d3b35e8f8712cde20dae39ac3c19f86eda25",
"note": "sent by mobile",
"datetime": "2026-03-20T21:07:44Z",
"port": null,
"send_with_whatsapp": "0"
}
}
Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.
Clé de connexion ↑- Une réponse API réussie signifie que le message a été accepté par la plateforme ; conservez l'identifiant renvoyé pour un suivi ultérieur.
- La livraison par le transporteur et le traitement mobile peuvent avoir lieu après la réponse HTTP.
POSTE · GET
Renvoyer un SMS non envoyé
https://api.smsmobileapi.com/resend/Réessaye un message qui est actuellement dans un état d'erreur.
Utilisez ceci après avoir vérifié le journal envoyé et confirmé qu'un message ayant échoué est éligible pour une autre tentative.
Paramètres
| Nom | Taper | Exigence | Désignation des marchandises |
|---|---|---|---|
apikey |
chaîne | Requis | Clé API de votre compte. |
guid |
chaîne | Requis | GUID du message renvoyé par le point de terminaison d'envoi ou de journalisation. |
Exemple de demande
curl "https://api.smsmobileapi.com/resend/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE"
Exemple de réponse
{
"result": {
"error": "0",
"sms": "resent with successfully",
"attempt": 1
}
}
Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.
Clé de connexion ↑- Seuls les messages avec un statut d'erreur peuvent être renvoyés.
OBTENIR
Liste les SMS envoyés depuis l'API
https://api.smsmobileapi.com/log/sent/sms/Renvoie les messages soumis via l'API SMS avec des informations sur la file d'attente, le mobile et les erreurs.
Utiliser pour le suivi de la livraison, les diagnostics de prise en charge et la réconciliation.
Paramètres
| Nom | Taper | Exigence | Désignation des marchandises |
|---|---|---|---|
apikey |
chaîne | Requis | Clé API de votre compte. |
guid_message |
chaîne | Facultatif | Renvoyer un message par son GUID unique. |
before |
horodatage ou référence | Facultatif | Renvoyer les messages avant le curseur ou l'horodatage fourni. |
error_api |
0 | 1 | Facultatif | Définir sur 1 pour renvoyer les erreurs de traitement de l'API. uniquement. |
error_mobile |
0 | 1 | Facultatif | Définissez sur 1 pour renvoyer uniquement les erreurs d'envoi mobile. |
keyword |
chaîne | Facultatif | Recherchez le numéro du destinataire ou le texte du message. |
Exemple de demande
curl "https://api.smsmobileapi.com/log/sent/sms/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"
Exemple de réponse
{
"result": {
"error": "0",
"sms": [{
"sIdentifiantPhone": "508b004b4aadacc4",
"recipients": "+1234567890",
"sms": "Test message",
"guid_message": "MESSAGE_GUID",
"send_from_mobile": 1,
"error_api": "",
"send_from_mobile_erreur": ""
}]
}
}
Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.
Clé de connexion ↑
OBTENIR
Liste les SMS synchronisés depuis un téléphone
https://api.smsmobileapi.com/log/sent/frommobile/Liste les SMS physiquement envoyés par un mobile et synchronisés avec la plateforme.
Utilisez-le lorsque les messages peuvent provenir du téléphone ainsi que via le API.
Paramètres
| Nom | Taper | Exigence | Désignation des marchandises |
|---|---|---|---|
apikey |
chaîne | Requis | Clé API de votre compte. |
date |
AAAA-MM-JJ | Facultatif | Filtrer une date exacte. |
date_from |
AAAA-MM-JJ | Facultatif | Début d'une plage de dates. |
date_to |
AAAA-MM-JJ | Facultatif | Fin d'une plage de dates. |
period |
enum | Facultatif | aujourd'hui, hier, dernières_24 heures, derniers_3 jours ou derniers_7 jours. |
number |
téléphone | Facultatif | Filtrer par destinataire. |
sIdentifiant |
chaîne | Facultatif | Filtrer par SID du mobile connecté. |
message |
chaîne | Facultatif | Filtrer par contenu du message. |
search |
chaîne | Facultatif | Recherche globale sur mobile, numéro, message et horodatage. |
sort_by |
enum | Facultatif | sIdentifiant, numéro, message, mobile_date_ms, mobile_date_formatted ou synchro_time. |
sort_order |
ASC , DESC | Facultatif | Sens du tri. |
limit |
entier | Facultatif | Maximum 200 enregistrements. |
Exemple de demande
curl "https://api.smsmobileapi.com/log/sent/frommobile/?apikey=YOUR_API_KEY&period=last_7days&limit=200"
Exemple de réponse
{
"result": {
"error": "0",
"count": 1,
"history_limit_days": 7,
"sms": [{
"sIdentifiant": "508b004b4aadacc4",
"number": "+15551234567",
"message": "Appointment confirmed.",
"mobile_date_ms": 1774041004692,
"synchro_time": "2026-03-20 21:10:05"
}]
}
}
Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.
Clé de connexion ↑- Nécessite l'application Android 4.1.20 ou plus récente et doit être activée dans l'application.
- Ce point de terminaison renvoie un maximum de sept jours d'historique synchronisé.
OBTENIR
Liste les SMS reçus
https://api.smsmobileapi.com/getsms/Renvoie les SMS entrants synchronisés à partir de téléphones connectés.
Utilisez-le pour créer une boîte de réception, interroger des réponses ou récupérer des messages après une interruption du webhook.
Paramètres
| Nom | Taper | Exigence | Désignation des marchandises |
|---|---|---|---|
apikey |
chaîne | Requis | Clé API de votre compte. |
sIdentifiantPhone |
chaîne | Facultatif | Filtrer par téléphone qui a reçu le message. SMS. |
after_timestamp_unix |
Secondes Unix | Facultatif | Renvoyer les messages reçus après cet horodatage. |
onlyunread |
Oui | Facultatif | Renvoyer uniquement les messages non marqués comme lus dans l'état de l'API. |
Exemple de demande
curl "https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY&onlyunread=yes"
Exemple de réponse
{
"result": {
"error": "",
"sms": [{
"id": 466340,
"sIdentifiantPhone": "508b004b4aadacc4",
"timestamp_unix": 1774041814,
"message": "Please call us back.",
"number": "+15551234567",
"guid": "6BFD7DC7-3492-422D-8D02-4AF4E614F122",
"alias": null
}]
}
}
Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.
Clé de connexion ↑
POSTE · GET
Marquer un SMS reçu comme lu
https://api.smsmobileapi.com/getsms/set-read/Marque un message reçu comme lu dans l'état de l'API SMSMobileAPI.
Utilisez cette option une fois que votre application a traité un message entrant. message.
Paramètres
| Nom | Taper | Exigence | Désignation des marchandises |
|---|---|---|---|
apikey |
chaîne | Requis | Clé API de votre compte. |
guid_message |
chaîne | Requis | GUID du SMS reçu. |
Exemple de demande
curl "https://api.smsmobileapi.com/getsms/set-read/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"
Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.
Clé de connexion ↑- Cela ne modifie pas l'état de lecture dans l'application de messagerie téléphonique.
POSTE · GET
Mettre à jour un alias de SMS reçu
https://api.smsmobileapi.com/getsms/update/Ajoute, modifie ou efface l'alias associé à un SMS reçu.
Utilisez des alias pour joindre un nom de contact ou étiquette d'application à un message.
Paramètres
| Nom | Taper | Exigence | Désignation des marchandises |
|---|---|---|---|
apikey |
chaîne | Requis | Clé API de votre compte. |
guid |
chaîne | Requis | GUID du SMS reçu. |
alias |
chaîne | Requis | Nouvel alias. Envoyez une valeur vide pour l'effacer. |
Exemple de demande
curl "https://api.smsmobileapi.com/getsms/update/?apikey=YOUR_API_KEY&guid=MESSAGE_GUID&alias=John%20Doe"
Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.
Clé de connexion ↑
POSTE · GET
Supprimer les journaux du serveur SMS
https://api.smsmobileapi.com/deletesms/Supprime les enregistrements SMS du journal du serveur SMSMobileAPI.
Utilisez-le pour les workflows de conservation ou la suppression d'un message enregistré spécifique.
Paramètres
| Nom | Taper | Exigence | Désignation des marchandises |
|---|---|---|---|
apikey |
chaîne | Requis | Clé API de votre compte. |
guid_message |
chaîne | Facultatif | Supprimez un message par GUID. |
date_start |
AAAA-MM-JJ | Facultatif | Supprimez les enregistrements à partir de cette date. |
date_end |
AAAA-MM-JJ | Facultatif | Avec date_start, limite la plage de suppression. |
Exemple de demande
curl "https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"
Exemple de réponse
{
"result": {
"error": null,
"count_delete": 1
}
}
Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.
Clé de connexion ↑- Cela supprime uniquement les entrées du journal du serveur. Il ne supprime pas les messages stockés sur l'appareil mobile.
- Traitez cette opération comme destructrice et vérifiez les filtres avant de l'appeler.
OBTENIR
Liste des conversations SMS
https://api.smsmobileapi.com/conversation/sms/list/Regroupe les messages entrants et sortants dans des conversations par numéro de téléphone.
Utilisez-le pour les vues de chat, les widgets de conversation récente et les chronologies d'assistance.
Paramètres
| Nom | Taper | Exigence | Désignation des marchandises |
|---|---|---|---|
apikey |
chaîne | Requis | Clé API de votre compte. |
origineConversation |
reçu | envoyé | Requis | Ensemble de données utilisé pour identifier les conversations de début. |
numero |
téléphone | Facultatif | Renvoyer un numéro de conversation. |
date_from |
date ou dateheure | Facultatif | Début de la plage de messages. |
date_to |
date ou dateheure | Facultatif | Fin du message plage. |
sort |
ASC , DESC | Facultatif | Ordre des conversations ; DESC par défaut. |
limit |
entier | Facultatif | Limite de conversation lorsque le numéro est omis ; par défaut 20. |
resume |
0 | 1 | Facultatif | Définissez sur 1 pour renvoyer uniquement les derniers messages par conversation. |
resume_line_how |
entier | Facultatif | Nombre de messages par conversation lorsque CV = 1. |
Exemple de demande
curl "https://api.smsmobileapi.com/conversation/sms/list/?apikey=YOUR_API_KEY&origineConversation=received&resume=1&resume_line_how=3"
Exemple de réponse
{
"success": true,
"origineConversation": "received",
"conversations": [{
"phone_number": "+15551234567",
"contact_alias": "John Doe",
"messages": [{
"direction": "incoming",
"message_id": "msg_1001",
"timestamp_utc": "2026-03-13T08:45:12Z",
"message": "I need more information.",
"status": "received",
"mobile_sid": "device_sid_1"
}]
}]
}
Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.
Clé de connexion ↑
OBTENIR
Liste des mobiles connectés
https://api.smsmobileapi.com/gateway/mobile/list/Liste les téléphones connectés au compte de passerelle SMS.
Utilisez-le pour sélectionner un expéditeur et afficher le périphérique. statut ou audit d'une flotte de passerelles.
Paramètres
| Nom | Taper | Exigence | Désignation des marchandises |
|---|---|---|---|
apikey |
chaîne | Requis | Clé API de votre compte. |
sid |
chaîne | Facultatif | Renvoyer un SID mobile exact. |
search |
chaîne | Facultatif | Rechercher le SID, la date, la batterie, la version, l'étiquette et les champs associés. |
Exemple de demande
curl "https://api.smsmobileapi.com/gateway/mobile/list/?apikey=YOUR_API_KEY"
Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.
Clé de connexion ↑
POSTE · GET
Mettre à jour un mobile connecté
https://api.smsmobileapi.com/gateway/mobile/update/Met à jour l'étiquette lisible par l'homme ou le numéro de téléphone d'un appareil connecté.
Utilisez-le pour gardez les étiquettes des appareils significatives dans les installations multi-téléphones.
Paramètres
| Nom | Taper | Exigence | Désignation des marchandises |
|---|---|---|---|
apikey |
chaîne | Requis | Clé API de votre compte. |
sid |
chaîne | Requis | Le SID de l'appareil. |
label |
chaîne | Requis | Nouvelle étiquette ; il peut être intentionnellement vide. |
phone_number |
téléphone | Facultatif | Nouvelles métadonnées de numéro de téléphone. |
Exemple de demande
curl "https://api.smsmobileapi.com/gateway/mobile/update/?apikey=YOUR_API_KEY&sid=DEVICE_SID&label=OfficePhone"
Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.
Clé de connexion ↑
POSTE · GET
Supprimer un mobile connecté
https://api.smsmobileapi.com/gateway/mobile/delete/Supprime un mobile connecté et ses lignes d'historique de passerelle.
À utiliser uniquement lorsqu'un téléphone doit être définitivement supprimé du compte.
Paramètres
| Nom | Taper | Exigence | Désignation des marchandises |
|---|---|---|---|
apikey |
chaîne | Requis | Clé API de votre compte. |
sid |
chaîne | Requis | SID de l'appareil à utiliser supprimer. |
Exemple de demande
curl "https://api.smsmobileapi.com/gateway/mobile/delete/?apikey=YOUR_API_KEY&sid=DEVICE_SID"
Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.
Clé de connexion ↑- Cette opération supprime l'historique de l'appareil associé au SID. Confirmez l'appareil avant de l'appeler.
POSTE-BOND
Recevoir des SMS par webhook
Your HTTPS endpointSMSMobileAPI envoie une requête JSON à votre URL configurée chaque fois qu'un SMS est reçu.
Utilisez des webhooks pour le traitement en temps réel au lieu de fréquents. interrogation.
Exemple de récepteur
<?php
$payload = json_decode(file_get_contents('php://input'), true);
if (!is_array($payload) || empty($payload['guid'])) {
http_response_code(400);
exit('Invalid payload');
}
// Queue the event, then acknowledge quickly.
http_response_code(200);
echo 'OK';
Exemple de réponse
{
"date": "2026-03-20",
"hour": "10:15:00",
"time_received": "2026-03-20 10:14:50",
"message": "Hello, this is a test.",
"number": "+123456789",
"guid": "abcde12345"
}
Ce point de terminaison reçoit les événements sur votre propre URL HTTPS. Utilisez l'exemple de récepteur ci-dessus, puis envoyez un SMS à votre téléphone connecté pour le tester.
- Configurez l'URL HTTPS publique dans Tableau de bord → Paramètres Webhook.
- Renvoyez rapidement HTTP 200 et traitez l'événement de manière asynchrone.
- Tentatives de dédoublonnage à l'aide guid.
Dépannage
Erreurs et tentatives sécurisées
Lisez l'état HTTP et le champ d'erreur JSON avant de réessayer. Ne réessayez pas les échecs de validation ou d'authentification sans d'abord corriger la demande.
| HTTP | Code | Que faire |
|---|---|---|
| 400 | missing_parameter | Un paramètre obligatoire est vide ou absent. Vérifiez la table des paramètres du point de terminaison. |
| 403 | invalid_apikey | La clé API est inconnue, expirée ou non autorisée pour la fonctionnalité demandée. |
| 429 | too_many_requests | Les demandes arrivent trop rapidement. Attendez, puis réessayez avec un intervalle exponentiel. |
| 500 | server_error | Le service n'a pas pu terminer la demande. Conservez la réponse et contactez l'assistance si elle persiste. |
Besoin d'aide ?
Apportez le contexte de la requête, pas vos secrets.
Partagez le point de terminaison, l'horodatage, l'état HTTP et la réponse nettoyée. N'incluez jamais de clés API, de jetons ou de contenu de message privé.


