SMS

GRATUIT 2 demandes/an

0,004 € + TVA

Demandes GRATUITES

Envoyez des messages SMS de haute qualité dans le monde entier, en mode unique ou multiple et avec des rapports de livraison.

Livraison

En temps réel

API

SMS

Disponible pour
  • gz

SMS via API est le service qui permet d'envoyer des SMS certifiés, de haute qualité et professionnels dans le monde entier, avec un expéditeur personnalisé et un rapport de livraison.

Le SMS est le premier canal de communication mobile, offrant la certitude de réception du message même en l'absence de couverture réseau. Pour cette raison, il représente l'outil idéal pour les communications en temps réel et sécurisées comme les alertes, les messages transactionnels, l'authentification à deux facteurs, la disponibilité des rapports.

Le service d'Openapi permet d'envoyer rapidement le même message à un ou plusieurs destinataires.

ENVOI SMS

Le méthode POST/messages permet d'envoyer un ou plusieurs messages SMS directement depuis le gateway d'Openapi.

EXEMPLE REQUÊTE

POST/messages

Voici un exemple de requête:

{
  "test": false,
  "sender": "alberto",
  "body": "test envoi",
  "recipients": "+39-349xxxxx18"
}

EXEMPLE RÉPONSE

POST/messages

La réponse renvoie les détails de l'envoi effectué récemment:

{
  "data": [
    {
      "test": false,
      "sender": "alberto",
      "body": "test envoi",
      "recipients": {
        "valid": {
          "count": 1
        },
        "invalid": {
          "total": 0,
          "list": []
        }
      },
      "transaction": false,
      "options": {
        "flash": false,
        "realtime": false,
        "timestamp_send": "1564752494920"
      },
      "statistics": {
        "error": 0,
        "sent": 0,
        "delivered": 0,
        "total": 1,
        "sms_total": 1
      },
      "base_price": 0.0315,
      "timestamp": "1564752494920",
      "last_update": "1564752494920",
      "priority": 1,
      "price": 0.0315,
      "state": 0,
      "id": "5d443a6e9f2725660f3db347"
    }
  ],
  "message": "Message en file d'attente",
  "credit": "90.90849999999988",
  "success": true,
  "error": null
}

VÉRIFIER LA LISTE DES SMS ENVOYÉS

GET /messages

Via l'endpoint GET/messages, il est possible de vérifier à tout moment la liste de tous les SMS envoyés.

{
  "data": [
    {
      "sender": "alberto",
      "timestamp": "1564411330117",
      "id": "5d3f05c29f2725610c2b4e60"
    },
    {
      "sender": "3939989741",
      "timestamp": "1563554978976",
      "id": "5d31f4a29f27257de166d960"
    },
    {
      "sender": "3939989741",
      "timestamp": "1562686328690",
      "id": "5d24b3789f27257de1645bda"
    },
    {
      "sender": "Nom de l'expéditeur",
      "timestamp": "1562142688118",
      "id": "5d1c67e09f27255e2f4079a3"
    },
    {
      "sender": "Nom de l'expéditeur",
      "timestamp": "1562142398400",
      "id": "5d1c66be9f272563102e8045"
    }
  ],
  "success": true,
  "message": "5 Résultats",
  "credit": "91.00299999999986",
  "error": null
}

OBTENIR DES INFORMATIONS SUR LE MESSAGE ENVOYÉ

GET /messages/{id}

La méthode GET /messages/{id} permet d'obtenir toutes les informations sur le message envoyé, par exemple l'expéditeur, le contenu, le nombre de destinataires, les statistiques générales de livraison, les coûts.

{
 "data": [
        {
          "test": false,
          "sender": "Simone",
          "body": "Production test 4 ",
          "recipients": {
            "valid": {
              "count": 1
            },
            "invalid": {
              "total": 0,
              "list": []
            }
          },
          "priority": 1,
          "options": {
            "flash": true,
            "realtime": true,
            "timestamp_send": "326152800000",
            "custom": {
              "test": 123,
              "best": 321,
              "trest": [
                12,
                3,
                12,
                3
              ]
            },
            "callback_url": "https://test.ws.messaggisms.com/callbackTest.php"
          },
          "transaction": false,
          "statistics": {
            "error": 0,
            "sent": 1,
            "delivered": 1,
            "total": 1,
            "sms_total": 1
          },
          "base_price": 0.03,
          "timestamp": "1559743507600",
          "last_update": "1559743510156",
          "price": 0.036,
          "state": 2,
          "id": "5cf7cc139f272546624d3795"
        }
      ],
      "message": "1 Result",
      "credit": "90.97149999999986",
      "success": true,
      "error": null
   
}

VÉRIFICATION DES DONNÉES DES DESTINATAIRES

GET /messages/{id}/recipients

Avec GET /messages/{id}/recipients, à partir de l'id du message, vous pouvez obtenir les données du ou des destinataires d'un SMS, telles que le numéro, le préfixe, le texte reçu, l'état de l'envoi et la description.

{
  "data": [
    {
      "number": "+39-3xxxxx5018",
      "prefix": "+39",
      "send_id": "5e5e65429f272510fb6adcc0_0",
      "body": "test summary2",
      "sms": 1,
      "remaining_chr": 147,
      "state": "DELIVERED",
      "state_description": "DELIVERED_TO_HANDSET",
      "price": 0.03,
      "fields": [],
      "message_id": "5e5e65429f272510fb6adcc0",
      "i": 0,
      "state_detail": "Message delivered to handset",
      "timestamp_sent": {
        "$date": {
          "$numberLong": "1583244661371"
        }
      },
      "real_cost": 0.03,
      "report": {
        "price": {
          "pricePerMessage": 0.03,
          "currency": "EUR"
        },
        "status": {
          "id": 5,
          "groupId": 3,
          "groupName": "DELIVERED",
          "name": "DELIVERED_TO_HANDSET",
          "description": "Message delivered to handset"
        },
        "error": {
          "id": 0,
          "name": "NO_ERROR",
          "description": "No Error",
          "groupId": 0,
          "groupName": "OK",
          "permanent": false
        },
        "messageId": "5e5e65429f272510fb6adcc1",
        "doneAt": "2020-03-03T15:11:03.168Z"
      }
    }
  ],
  "message": "1 Result",
  "success": true,
  "error": null
}

VÉRIFICATION DES DONNÉES D'UN DESTINATAIRE SPÉCIFIQUE

GET /messages/{id}/recipients/{number}

La méthode GET /messages/{id}/recipients/{number} permet de vérifier les mêmes données mais pour un destinataire spécifique.

{
  "data": [
    {
      "number": "+39-3xxxxx5018",
      "prefix": "+39",
      "send_id": "5e5e65429f272510fb6adcc0_0",
      "body": "test summary2",
      "sms": 1,
      "remaining_chr": 147,
      "state": "DELIVERED",
      "state_description": "DELIVERED_TO_HANDSET",
      "price": 0.03,
      "fields": [],
      "message_id": "5e5e65429f272510fb6adcc0",
      "i": 0,
      "state_detail": "Message delivered to handset",
      "timestamp_sent": {
        "$date": {
          "$numberLong": "1583244661371"
        }
      },
      "real_cost": 0.03,
      "report": {
        "price": {
          "pricePerMessage": 0.03,
          "currency": "EUR"
        },
        "status": {
          "id": 5,
          "groupId": 3,
          "groupName": "DELIVERED",
          "name": "DELIVERED_TO_HANDSET",
          "description": "Message delivered to handset"
        },
        "error": {
          "id": 0,
          "name": "NO_ERROR",
          "description": "No Error",
          "groupId": 0,
          "groupName": "OK",
          "permanent": false
        },
        "messageId": "5e5e65429f272510fb6adcc1",
        "doneAt": "2020-03-03T15:11:03.168+0100",
        "smsCount": 1,
        "sentAt": "2020-03-03T15:11:01.467+0100",
        "to": "393495155018"
      },
      "timestamp_delivery": {
        "$date": {
          "$numberLong": "1583244663000"
        }
      },
      "id": "5e5e65429f272510fb6adcc1"
    }
  ],
  "message": "1 Result",
  "credit": 90.20949999999985,
  "success": true,
  "error": null
}

Grâce à l'API SMS, il est également possible de modifier la date d'envoi d'un SMS planifié, en utilisant l'endpoint PUT/messages/{id}

et la valeur timestamp_send. Si l'SMS n'a pas encore été envoyé, il peut être supprimé via l'endpoint DELETE/messages/{id}.

Le service SMS est souvent intégré pour des rappels de rendez-vous ou des communications scolaires, entreprises, de service public, marketing et flux d'onboarding/activations pour des plateformes.

Le service permet également d'envoyer des SMS Flash, des messages qui ne nécessitent pas d'être ouverts, mais qui s'affichent directement sur l'écran du smartphone.

Avec l'API SMS, il est également possible de rendre l'envoi encore plus rapide en définissant une priorité plus élevée ou en sélectionnant l'option "realtime", ce qui est très utile pour l'envoi des OTP. Le coût de l'option realtime entraîne une majoration de 20 % sur le prix de l'SMS, tandis que le coût de la priorité dépend de la valeur définie, qui devient un multiplicateur du coût de l'SMS.

Les tarifs d'envoi des SMS peuvent varier en fonction du pays de destination. Pour une liste complète des coûts, veuillez consulter la section dédiée dans Console.

Inscription

Avez-vous besoin d'aide ?

Vous n'avez pas trouvé la réponse que vous cherchiez?

Remplissez tous les détails, nous vous contacterons dès que possible!