Documentation API

Intégrez facilement nos services SMS dans vos applications avec nos endpoints REST.

POST Envoi d'un SMS simple

https://apisms.garec.net/SendSMS

Envoyez un SMS à un ou plusieurs destinataires en une seule requête.

Paramètres obligatoires

ParamètreTypeDescription
ApiKeystringClé API fournie par SMSCongo
ClientIdstringIdentifiant client
SenderIdstringNom de l'expéditeur (personnalisé)
MessagestringTexte du message (160 caractères max par SMS)
MobileNumbersstringNuméros séparés par des virgules (ex: 2439xxxx,2439yyyy)

Paramètres optionnels

ParamètreTypeDescription
Is_UnicodebooleanPour les caractères spéciaux (true/false)
Is_FlashbooleanMessage flash (true/false)
DataCodinginteger0: GSM 7 bits, 3: ISO-8859-1, 8: UCS-2
ScheduleTimestringProgrammation (format yyyy-MM-dd HH:mm)
GroupIdintegerID d'un groupe de contacts pré-enregistré

Exemple de requête (cURL)

curl -X POST "https://apisms.garec.net/SendSMS?ApiKey=VOTRE_API_KEY&ClientId=VOTRE_CLIENT_ID&SenderId=MON_ENTREPRISE&Message=Bonjour%20client&MobileNumbers=2439xxxxxx" \
  -H "Content-Type: application/json" \
  -H "Type: json"

Réponse en cas de succès

{
  "success": true,
  "http_code": 200,
  "response": {
    "Data": [
      {
        "MobileNumber": "243994061228",
        "MessageErrorCode": "",
        "MessageId": "xxxxxhhfvbv",
        "MessageErrorDescription": ""
      },
      {
        "MobileNumber": "243841048650",
        "MessageErrorCode": "",
        "MessageId": "xxxxxhhfvbv",
        "MessageErrorDescription": ""
      }
    ]
  }
}

Réponse en cas d'erreur (ex: token invalide)

{
  "success": false,
  "error": "Invalid token"
}

POST Envoi de SMS en masse (Bulk)

https://apisms.garec.net/SendBulkSMS

Envoyez des messages personnalisés à plusieurs destinataires en une seule requête.

Paramètres obligatoires (dans le corps JSON)

ParamètreTypeDescription
ApiKeystringClé API
ClientIdstringIdentifiant client
SenderIdstringNom de l'expéditeur
MessageParametersarrayTableau d'objets contenant 'Number' et 'Text' pour chaque destinataire

Paramètres optionnels

ParamètreTypeDescription
Is_Unicodebooleantrue/false
Is_Flashbooleantrue/false
DataCodinginteger0, 3 ou 8
SchedTimestringyyyy-MM-dd HH:mm

Exemple de requête (JSON)

{
  "ApiKey": "VOTRE_API_KEY",
  "ClientId": "VOTRE_CLIENT_ID",
  "SenderId": "MON_ENTREPRISE",
  "MessageParameters": [
    { "Number": "2439xxxxxx1", "Text": "Message personnalisé 1" },
    { "Number": "2439xxxxxx2", "Text": "Message personnalisé 2" }
  ],
  "Is_Unicode": false,
  "Is_Flash": false
}

Commande cURL

curl -X POST https://apisms.garec.net/SendBulkSMS \
  -H "Content-Type: application/json" \
  -H "Type: json" \
  -d '{
    "ApiKey": "VOTRE_API_KEY",
    "ClientId": "VOTRE_CLIENT_ID",
    "SenderId": "MON_ENTREPRISE",
    "MessageParameters": [
      {"Number": "2439xxxxxx1", "Text": "Message 1"},
      {"Number": "2439xxxxxx2", "Text": "Message 2"}
    ]
  }'

Réponse en cas de succès

{
  "success": true,
  "http_code": 200,
  "response": {
    "Data": [
      {
        "MobileNumber": "243994061228",
        "MessageErrorCode": "",
        "MessageId": "xxxxxhhfvbv",
        "MessageErrorDescription": ""
      },
      {
        "MobileNumber": "243841048650",
        "MessageErrorCode": "",
        "MessageId": "xxxxxhhfvbv",
        "MessageErrorDescription": ""
      }
    ]
  }
}
Réponse d'erreur (ex: token invalide)
{
  "success": false,
  "error": "Invalid token"
}

Notes importantes