Documentation de l'api

Documentation | SmsGateway24.com

v.1.0

1. Obtenir un jeton:

Description : Lors de l'exécution réussie de cette requête, vous recevrez un jeton. Par la suite, vous pouvez utiliser ce jeton pour accéder au serveur et faire des requêtes supplémentaires.
Point de terminaison : https://smsgateway24.com/getdata/gettoken
Méthode :: GET
Paramètres de la requête:
Variable Type de texte Libellé
email string [Obligatoire] Your login in the system. Usually email
pass string [Obligatoire] Your password in the system

Réponse au format JSON ::
Variable Type de texte Libellé
token string Votre jeton est acquis par la méthode de récupération des jetons:
error int 0 | 1 - indique s'il y a une erreur dans le traitement de la requête
message string Message d'erreur, vide si tout est dans l'ordre.
Lien vers l'exemple de code Curl
Lien vers la gueule d'exemple de code
Exemple de réponse:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f41119fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

2. Envoyer un SMS en utilisant TOKEN:

Description : Génère des messages SMS sur le serveur à envoyer collectivement en un seul lot. Permet la création de plusieurs messages SMS simultanément à travers une seule requête.
Point de terminaison : https://smsgateway24.com/getdata/addsms
Méthode :: GET, POST ( Utilisez %2B au lieu du signe plus "+" dans la requête GET )
Paramètres de la requête:
Variable Type de texte Libellé
token string [Obligatoire] Votre jeton est acquis par la méthode de récupération de jetons.
sendto string [Obligatoire]Numéro de téléphone de l'abonné. Tous les caractères sont autorisés. Par exemple: +4915752982212, +4917642111111, +1 17642031984. Alternativement, plusieurs nombres peuvent être spécifiés par des virgules
body string [Obligatoire] Corps du message
device_id string [Obligatoire] ID de l'appareil
timetosend string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[optionnel] Heure indiquée pour l'envoi d'un message. Par exemple, 2024-07-22 14:44:53
sim int, default = 0 [optionnel] SIM slot # 0 or 1
customerid int [optionnel] Numéro d'identification de votre client. Champ facultatif.
urgent int [optionnel] SMS marqué comme urgent. Ce champ est facultatif. Le SMS sera envoyé avec priorité, et peut être bénéfique lors de l'envoi de mots de passe uniques (OTP).

Réponse au format JSON ::
Variable Type de texte Libellé
token string Votre jeton est acquis par la méthode de récupération des jetons:
error int 0 | 1 - indique s'il y a une erreur dans le traitement de la requête
message string Message d'erreur, vide si tout est dans l'ordre.
Lien vers l'exemple de code Curl
Lien vers la gueule d'exemple de code
Exemple de réponse:
{ "error": 0, "sms_id": 62807347, "message": "Sms has been saved successfully"}

2.1 Envoyer un SMS simple en utilisant l'identifiant et le mot de passe:

Description : Génère des messages SMS sur le serveur à envoyer collectivement en un seul lot. Permet la création de plusieurs messages SMS simultanément à travers une seule requête.
Point de terminaison : https://smsgateway24.com/getdata/smstosend
Méthode :: GET, POST ( Utilisez %2B au lieu du signe plus "+" dans la requête GET )
Paramètres de la requête:
Variable Type de texte Libellé
email string [Obligatoire] Votre adresse e-mail
pass string [Obligatoire] Votre mot de passe
sendto string [Obligatoire]Numéro de téléphone de l'abonné. Tous les caractères sont autorisés. Par exemple: +4915752982212, +4917642111111, +1 17642031984. Alternativement, plusieurs nombres peuvent être spécifiés par des virgules
body string [Obligatoire] Corps du message
device_id string [Obligatoire] ID de l'appareil
timetosend string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[optionnel] Heure indiquée pour l'envoi d'un message. Par exemple, 2024-07-22 14:44:53
sim int, default = 0 [optionnel] SIM slot # 0 or 1
customerid int [optionnel] Numéro d'identification de votre client. Champ facultatif.
urgent int [optionnel] SMS marqué comme urgent. Ce champ est facultatif. Le SMS sera envoyé avec priorité, et peut être bénéfique lors de l'envoi de mots de passe uniques (OTP).

Réponse au format JSON ::
Variable Type de texte Libellé
token string Votre jeton est acquis par la méthode de récupération des jetons:
error int 0 | 1 - indique s'il y a une erreur dans le traitement de la requête
message string Message d'erreur, vide si tout est dans l'ordre.
Lien vers l'exemple de code Curl
Lien vers la gueule d'exemple de code
Exemple de réponse:
{ "error": 0, "sms_id": 62807347, "message": "Sms has been saved successfully"}

3. Envoi de SMS en vrac en utilisant JSON

Description : Crée des SMS sur le serveur à envoyer. Après cela, le téléphone avec l'application Smsgateway24 appelle le serveur et prend le SMS et l'envoie de votre carte SIM Téléchargez l'application à partir du lien
Point de terminaison : https://smsgateway24.com/getdata/addalotofsms
Méthode :: GET, POST
Paramètres de la requête:
Variable Type de texte Libellé
datajson string [Obligatoire] {"token":"df427bfcf113c9a21c67718035076b5b","smsdata":[{"sendto":"015752982212","body":"Test message","sim":1,"timetosend":"2019-07-01 23:50:00","device_id":260},{"sendto":"+4915752982212","body":"Test message 2","sim":1,"timetosend":"2019-07-01 23:50:00","device_id":260,"urgent":1}]}

Réponse au format JSON ::
Variable Type de texte Libellé
error int 0 | 1 - indique s'il y a une erreur dans le traitement de la requête
message string Message d'erreur, vide si tout est dans l'ordre.
Lien vers l'exemple de code Curl
Lien vers la gueule d'exemple de code
Request example:
{ "token":"df427bfcf113c9a21c6771803501", "smsdata":[ { "sendto":"015752982212", "body":"Your password is 12345", "sim":1, "timetosend":"2019-07-01 23:50:00", "device_id":260, "customerid":122, "urgent":1 }, { "sendto":"015752982212", "body":"Regular SMS. Not urgnet", "sim":1, "timetosend":"2019-07-01 23:50:00", "device_id":260, "customerid":122, "urgent":0 } ] }

4. Recevoir tous les SMS (y compris les SMS entrants):

Libellé: Cette requête vous permet de récupérer tous les messages associés à votre compte, y compris les SMS entrants des clients. Toutes les variables d'entrée sont obligatoires dans cette méthode, et les messages SMS peuvent varier dans le statut.
Endpoint: https://smsgateway24.com/getdata/getallsms
Méthode: GET, POST (Utiliser %2B au lieu du signe plus "+" dans la requête GET)
Paramètres de la requête:
Variable Type de texte Libellé
token string [Obligatoire] Votre jeton est acquis par la méthode de récupération de jetons.
device_id string [optionnel] ID de l'appareil
status int [optionnel]
  • 1 - En attente de SMS
  • 2 - SMS pris par téléphone
  • 3 - En attente d'envoi. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
  • 5 - SMS entrants
  • 6 - SMS envoyé par téléphone
  • 7 - Le SMS a été envoyé
  • 8 - Le SMS n'a pas été envoyé
  • 9 - SMS n'a pas du tout été envoyé - Échec générique. (Lire ce qu'il faut faire avec cette erreur ici)
  • Autre, erreurs moins courantes:
  • 10 - SMS non envoyé - No Service
  • 11 - SMS non envoyé - Null PDU
  • 12 - SMS non envoyé - Radio Off
  • 100, 101 - SMS non envoyé - NOT ALLOWED. (Les autorisations pour l'envoi de SMS dans l'application n'ont pas été accordées)
begindate string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[optionnel] Begin Date Time
enddate string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[optionnel] End Date Time
sim int [optionnel] SIM slot # 0 or 1
customerid int [optionnel] Numéro d'identification de votre client. Champ facultatif
onlycount int [optionnel] 0 | 1 nombre seulement
phone string [optionnel] 0 | 1 Filtre de numéro de téléphone
orderbydesc int [optionnel] 0 | 1 Order by any field
timezone int [optionnel] Indiquez votre fuseau horaire local, comme par exemple le paramétrage de l'Australie/Sydney.

Réponse au format JSON ::
Variable Type de texte Libellé
token string Votre jeton est acquis par la méthode de récupération des jetons:
error int 0 | 1 - indique s'il y a une erreur dans le traitement de la requête
message string Message d'erreur, vide si tout est en ordre
count int SMS amount
smss int JSON object
Lien vers l'exemple de code Curl
Lien vers la gueule d'exemple de code
Exemple de réponse ... :
{ "smss": { "62050971": { "id": 62050971, "sendto": "+4912312312332", "body": "Hello! Thank you for Order! ", "customerid": null, "status": 2, "statustitle": "sending", "deviceid": 11231, "urgent": null, "created": { "date": "2023-11-02 22:44:43.000000", "timezone_type": 3, "timezone": "Europe/Paris" }, "senttime": null, "timetosend": null, "paketid": null, "pakettitle": null, "paketbody": null }, "62051117": { "id": 62051117, "sendto": "+4912312312332", "body": "Hello! Thank you for Order! ", "customerid": null, "status": 7, "statustitle": "delivered", "deviceid": 11231, "urgent": null, "created": { "date": "2023-11-02 22:46:09.000000", "timezone_type": 3, "timezone": "Europe/Paris" }, "senttime": null, "timetosend": null, "paketid": null, "pakettitle": null, "paketbody": null } } }

5. Ajouter une nouvelle liste de contacts

Description : Le tag est requis pour générer une newsletter ciblant un groupe de numéros. Par exemple, utilisez le tag Employés
Point de terminaison : https://smsgateway24.com/getdata/savetag
Méthode :: GET, POST
Paramètres de la requête:
Variable Type de texte Libellé
token string [Obligatoire] Votre jeton est acquis par la méthode de récupération de jetons.
title string [Obligatoire] Nom du tag

Réponse au format JSON ::
Variable Type de texte Libellé
tag_id int Tag ID
error int 0 | 1 - indique s'il y a une erreur dans le traitement de la requête
message string Message d'erreur, vide si tout est dans l'ordre.
Lien vers l'exemple de code Curl
Lien vers la gueule d'exemple de code
Exemple de réponse:
{ "error": 0, "tag_id": 8303, "message": "OK" }

6. Ajouter des contacts à la liste de contacts:

Description : Ajoutez des contacts pour n'importe quel tag. Par exemple, pour le tag * Employés * vos collègues seront parfaitement adaptés.
Point de terminaison : https://smsgateway24.com/getdata/savecontact
Méthode :: GET, POST
Paramètres de la requête:
Variable Type de texte Libellé
token string [Obligatoire] Votre jeton est acquis par la méthode de récupération de jetons.
phone string [Obligatoire] phone number
ctag_id int [Obligatoire] Tag ID
fullname string [Obligatoire] Nom de votre client

Réponse au format JSON ::
Variable Type de texte Libellé
contact_id int Contact Id
error int 0 | 1 - indique s'il y a une erreur dans le traitement de la requête
message string Message d'erreur, vide si tout est dans l'ordre.
Lien vers l'exemple de code Curl
Lien vers la gueule d'exemple de code
Exemple de réponse ... :
{"error":0,"contact_id":15954765,"message":"ok"}

7. Créer une Newsletter

Description :Une fois que vous avez créé le tag, vous pouvez faire le mailing sur les tags.
Point de terminaison : https://smsgateway24.com/getdata/savepaket
Méthode :: GET, POST
Paramètres de la requête:
Variable Type de texte Libellé
token string [Obligatoire] Votre jeton est acquis par la méthode de récupération de jetons.
title string [Obligatoire] Titre de la newsletter
device_id string [Obligatoire] ID de l'appareil
body string [Obligatoire] Corps du message cible
tags string [Obligatoire] Identifiant de balise. Peut être plusieurs, séparés par des virgules. Par exemple: 12,13,14
sim int, default = 0 [Obligatoire]numéro d'emplacement SIM dans le téléphone: 0 or 1
time_to_send int, default = 0 [Obligatoire]Date time when Newsletter should be sent. Do not forget tap start on device. DD.MM.YYYY H:i:s

Réponse au format JSON ::
Variable Type de texte Libellé
contact_id int Id du contact
error int 0 | 1 - indique s'il y a une erreur dans le traitement de la requête
message string Message d'erreur, vide si tout est dans l'ordre.
paket_id int Package ID
Lien vers l'exemple de code Curl
Lien vers la gueule d'exemple de code
Exemple de réponse ... :
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

8. Obtenir la liste des appareils

Description : Vous pouvez tout savoir sur vos appareils.
Point de terminaison : https://smsgateway24.com/getdata/getalldevices
Méthode :: GET, POST
Paramètres de la requête:
Variable Type de texte Libellé
token string [Obligatoire] Votre jeton est acquis par la méthode de récupération de jetons.

Réponse au format JSON ::
Variable Type de texte Libellé
count int Nombre d'appareils:
device json
  • id - ID de l'appareil
  • title - Nom de l'appareil
  • created - Date de création de l'appareil
  • createdhumanformat - Date de création de l'appareil au format normal
  • lastseen - La date à laquelle l'appareil a été vu la dernière fois
  • lastseenhumanformat - La date à laquelle l'appareil a été vu la dernière fois
  • serialnumber - Numéro de série de l'appareil
  • siminfo - Informations sur les cartes SIM en JSON
  • appversion - La version de l'application installée sur l'appareil
  • subscription - Y a-t-il un abonnement sur l'appareil
message string Message d'erreur, vide si tout est dans l'ordre.
Lien vers l'exemple de code Curl
Lien vers la gueule d'exemple de code
Exemple de réponse:
    {
    "count": 2,
    "device": {
        "1576": {
            "id": 1576,
            "title": "AOSP_on_IA_Emulator",
            "number": null,
            "imei": "358240051111110",
            "created": {
                "date": "2020-03-28 20:10:29.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "createdhumanformat": "28.03.2020 20:10:29",
            "lastseen": {
                "date": "2020-04-23 17:02:21.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "lastseenhumanformat": "23.04.2020 17:02:21",
            "serialnumber": "EMULATOR30X0X5X0",
            "siminfo": [
                {
                    "Slot": "0",
                    "IccId": "89014103211118510720",
                    "Number": " 15555215554",
                    "Roaming": "0",
                    "CountryIso": "us",
                    "CarrierName": "Android (T-Mobile)"
                }
            ],
            "appversion": "12.1.21",
            "isappversionactual": false,
            "delaybetweeneachsms": null,
            "delaybetweenrequest": 1,
            "subscription": true
        },
        "1297": {
            "id": 1297,
            "title": "Android_SDK_built_for_x86",
            "number": null,
            "imei": "null",
            "created": {
                "date": "2020-01-20 14:01:05.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "createdhumanformat": "20.01.2020 14:01:05",
            "lastseen": {
                "date": "2020-04-20 20:51:34.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "lastseenhumanformat": "20.04.2020 20:51:34",
            "serialnumber": "unknown",
            "siminfo": [
                {
                    "Slot": "0",
                    "IccId": "8949226172233934327",
                    "Number": "+4915752982212",
                    "Roaming": "1",
                    "CountryIso": "de",
                    "CarrierName": "Drillisch (o2)"
                }
            ],
            "appversion": "12.1.21",
            "isappversionactual": false,
            "delaybetweeneachsms": 5,
            "delaybetweenrequest": 10,
            "subscription": false
        }
    }
}

9. Obtenir le statut de livraison d'un seul SMS

Description : Vous pouvez trouver le statut de livraison de chaque SMS en utilisant cette méthode
Point de terminaison : https://smsgateway24.com/getdata/getsmsstatus
Méthode :: GET, POST
Paramètres de la requête:
Variable Type de texte Libellé
token string [Obligatoire] Votre jeton est acquis par la méthode de récupération de jetons.
sms_id int [Obligatoire] Sms Id

Réponse au format JSON ::
Variable Type de texte Libellé
sms_id int SMS ID
status int SMS Status
  • 1 - En attente de SMS
  • 2 - SMS pris par téléphone
  • 3 - En attente d'envoi. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
  • 5 - SMS entrants
  • 6 - SMS envoyé par téléphone
  • 7 - Le SMS a été envoyé
  • 8 - Le SMS n'a pas été envoyé
  • 9 - SMS n'a pas du tout été envoyé - Échec générique. (Lire ce qu'il faut faire avec cette erreur ici)
  • Autre, erreurs moins courantes:
  • 10 - SMS non envoyé - No Service
  • 11 - SMS non envoyé - Null PDU
  • 12 - SMS non envoyé - Radio Off
  • 100, 101 - SMS non envoyé - NOT ALLOWED. (Les autorisations pour l'envoi de SMS dans l'application n'ont pas été accordées)
status_description string Nom du statut
error int 0 | 1 - y a-t-il une erreur dans le traitement de la requête
message string Message d'erreur, vide si tout est dans l'ordre.
Lien vers l'exemple de code Curl
Lien vers la gueule d'exemple de code
Exemple de réponse:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}