SMS

  1. Home
  2. Bibliothèque d'API
  3. SMS
SMS de haute qualité avec rapport de livraison, expéditeur personnalisé et livraison en temps réel

Intégration via API du service professionnel d'envoi de SMS pour l'authentification, les notifications, les rappels, les alertes à un ou plusieurs destinataires.

Toutes les connaissances dont vous avez besoin

Vous trouverez ici quelques conseils à prendre en compte pour aborder cette API. Si vous préférez, nous fournissons des exemples de code, la documentation OAS3, la possibilité d'essayer l'API en direct via Swagger UI ou d'importer l'intégralité de la collection dans Postman. Nous proposons également un environnement Sandbox où vous pouvez expérimenter toutes sortes de requêtes de manière totalement gratuite.

Conseils utiles pour commencer SMS

Obtenir le Token dans la section appropriée avant de commencer.

Utilisez l'outil en ligne ou générez-le via l'API. Définissez la date d'expiration, un nom utile et ajoutez maintenant un ensemble d'étendues pour limiter les actions possibles que votre jeton peut effectuer.
En savoir plus sur l'API oauth Gérer mes jetons
API docs by Redocly

Gateway SMS (1.0.0)

URL: https://openapi.it/en/support License: Apache 2.0 Terms of Service

Ce service web propose des appels REST pour envoyer des messages texte directement depuis notre passerelle.

Première fois ici ? Génération d'un nouveau jeton d'accès

Messages

Appel pour l'envoi, l'affichage et la modification de messages SMS

Liste des messages

Cette méthode vous permet de consulter la liste des messages envoyés par votre compte.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects (Messages)
success
boolean
message
string
credit
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "5 Results",
  • "credit": "91.00299999999986",
  • "error": null
}

Envoyer un message texte

Cette méthode permet d'envoyer un message texte directement depuis notre passerelle.

Authorizations:
bearerAuth
Request Body schema: application/json
test
boolean

Par défaut, elle est fausse, si elle est définie sur true, un envoi est simulé

sender
required
string

L'expéditeur doit comporter entre 3 et 11 caractères s'il est alphanumérique et entre 3 et 14 s'il est numérique.

body
required
string

Texte du SMS ; dans le texte, les valeurs des paramètres "joker" contenus dans les "champs" peuvent être insérées comme suit : "body" : "Test sending {{name}}".

required
string or Array of strings or object

Le numéro de téléphone du destinataire et les 'champs' de l'objet, dans lesquels seront inscrits les paramètres que nous voulons insérer dans le 'corps', à peu près comme ceci : {'Numéro':'+39-34xxx987', 'Champs':{'Prénom':'simone', 'Nom':'rossi'}}. Le préfixe international est obligatoire et doit être séparé du reste par '-', par exemple : '+39-numéro'. Tout autre format sera considéré comme un faux destinataire et sera enregistré comme non valable.

priority
number <double>

priorité d'envoi ; le paramètre par défaut est 1,00, c'est le minimum ; une augmentation de la priorité augmente le coût total du message, mais en supposant qu'il y a 1000 messages de priorité 1,00 dans la file d'attente, l'envoi d'un message de priorité 1,01 saute la file d'attente

object (Options)
transaction
boolean

La valeur par défaut est FALSE. Si TRUE, une transaction est lancée en enregistrant les données envoyées, mais la demande n'est pas mise en file d'attente. Les appels PUT suivants peuvent être effectués au point final "/messages/{id}/" pour compléter le premier appel POST (par exemple en ajoutant des destinataires), jusqu'à ce qu'un PUT avec "transaction" : FALSE soit envoyé. Le champ ID est renvoyé par le premier appel POST. À ce moment-là, la transaction (si elle est valide) est fermée et les messages sont placés normalement dans la file d'attente.

Responses

Response Schema: application/json
Array of objects (Message_Object)
success
boolean
message
string
credit
string
error
integer

Request samples

Content type
application/json
{
  • "test": false,
  • "sender": "alberto",
  • "body": "test invio",
  • "recipients": "+39-349xxxxx18"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Message Queued",
  • "credit": "90.90849999999988",
  • "success": true,
  • "error": null
}

Recevoir un seul message

Cette méthode affiche le message unique qui se rapporte au paramètre passé dans le chemin d'accès

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 5cf7cc139f272546624d3795

Message Id

Responses

Response Schema: application/json
Array of objects (Message_Object)
success
boolean
message
string
credit
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "1 Result",
  • "credit": "90.97149999999986",
  • "success": true,
  • "error": null
}

Intégration de messages

S'il existe un message avec "transaction = true", cette méthode permet de compléter l'appel POST initial (par exemple en ajoutant des destinataires) jusqu'à ce qu'un PUT avec "transaction = false" soit transmis. À ce stade, le message est fermé et placé dans la file d'attente d'envoi. Cette méthode permet également de modifier la date d'envoi du message ('timestamp_send') (s'il n'a pas déjà été envoyé ou s'il n'est pas prévu de l'envoyer).

Authorizations:
bearerAuth
Request Body schema: application/json
required
string or Array of strings or object

Le numéro de téléphone du destinataire et les 'champs' de l'objet, dans lesquels seront inscrits les paramètres que nous voulons insérer dans le 'corps', à peu près comme ceci : {'Numéro':'+39-34xxx987', 'Champs':{'Prénom':'simone', 'Nom':'rossi'}}. Le préfixe international est obligatoire et doit être séparé du reste par '-', par exemple : '+39-numéro'. Tout autre format sera considéré comme un faux destinataire et sera enregistré comme non valable.

transaction
boolean

Tant qu'elle n'est pas définie sur false, la transaction n'est pas fermée et le message n'est pas placé dans la file d'attente d'envoi.

object

Responses

Response Schema: application/json
object (Message_Object)
success
boolean
message
string
credit
string
error
integer

Request samples

Content type
application/json
{
  • "recipients": [
    ],
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Updated",
  • "credit": "90.97149999999986",
  • "success": true,
  • "error": null
}

Suppression d'un seul message

Cette méthode vous permet d'annuler un message et donc de ne pas l'envoyer (non autorisé pour les messages déjà envoyés ou prévus pour être envoyés). L'annulation n'entraîne pas le remboursement des crédits dépensés.

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 5cf7cc139f272546624d3795

Message Id

Responses

Response Schema: application/json
data
Array of strings
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [ ],
  • "message": "5cf7cc139f272546624d3795 Deleted",
  • "success": true,
  • "error": null
}

Récupérer les destinataires d'un message

Cette méthode permet d'afficher les destinataires d'un message donné.

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 5e5e65429f272510fb6adcc0

Message Id

Responses

Response Schema: application/json
Array of objects (Recipient_Object)
success
boolean
message
string
credit
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D/recipients/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "1 Result",
  • "credit": 90.20949999999985,
  • "success": true,
  • "error": null
}

Déterminer le destinataire d'un message

Cette méthode permet d'afficher le destinataire spécifique d'un message donné.

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 5e5e65429f272510fb6adcc0

Message Id

number
required
string
Example: +39-34xxxxx018

Numéro du destinataire

Responses

Response Schema: application/json
Array of objects (Recipient_Object)
success
boolean
message
string
credit
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D/recipients/%7Bnumber%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "1 Result",
  • "credit": 90.20949999999985,
  • "success": true,
  • "error": null
}
Web Service Revision: 2.0.0