API SMS


API SMS

Un service simple et fiable pour envoyer des SMS à travers le monde.

Intégrez l'envoi de SMS au cœur de vos algorithmes et de vos procédures métier et profitez d’un moyen de communication instantané et global.

 

Les cas d'usage

Rappels et rendez-vous SMS

Rappeler un rendez-vous par SMS constitue un moyen fiable de s’assurer du respect des horaires. Vous représentez un établissement recevant du public sur rendez-vous ? Évitez les oublis et les retards grâce aux rappels par SMS.

RAPPEL : vous avez RDV le 15/09/23 à 11 h 00 à la maison médicale Saint-Gabriel.

SMS marketing

Profitez du taux de lecture élevé offert par le SMS pour améliorer le ROI de vos campagnes de communication, annoncer des événements, etc. Animez votre fichier contact en un clic grâce à l’envoi groupé, en flash ou en différé.

Bon anniversaire ERIC ! Vos points fidélité sont doublés le mois de votre anniversaire :)

SMS transactionnels

Restez en contact avec votre clientèle, informez automatiquement vos destinataires de l’envoi d'un colis et gérez les tâches de vos équipes par SMS. Envoyez-leur également des rappels et des alertes avec accusé de réception.

Votre colis 13618678 est à retirer avant le 05/11/23 au Point Relais choisi à Roubaix.

Alerte SMS - Monitoring SMS

Supervisez l’état d’un équipement, d’un serveur, etc. Avec notre API, vous pouvez transformer n’importe quel objet connecté à Internet en objet communiquant par SMS.

L'alarme de surveillance a été déclenchée le 04/08/2022 à 14 h 48 dans la zone C, BAT 3.

Les avantages

API Rest

Icons/concept/Pen Created with Sketch.

Expéditeur personnalisable

Icons/concept/Cloud/Cloud Eye Created with Sketch.

Accusé de réception

SMS différé

Icons/concept/Envelop/Envelop Created with Sketch.

200 000 SMS

Icons/concept/Gear/Gear Arrow Created with Sketch.

Haute délivrabilité, routes redondées

Icons/concept/Hands/Hand World Created with Sketch.

Couverture mondiale avec plus de 600 opérateurs

Tout savoir sur l'envoi de SMS au sein d'applications

Envoyer mon premier SMS

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs
{
  "message": "Test message",
  "receivers": ["+33601020304"],
  "senderForResponse": true
}

Le ou la destinataire recevra un SMS provenant d'un numéro court dont le contenu sera « Test message ».
L'API retournera le nombre de crédits retirés, les destinataires valides et invalides, ainsi que les identifiants des SMS pour suivre leur état.

 

Programmer l'envoi d'un SMS

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs
{
  "message": "Test message",
  "receivers": ["+33601020304"],
  "differedPeriod": 120,
  "senderForResponse": true
}

OVHcloud vous permet de programmer l'envoi d'un SMS à une date ultérieure.


Le champ « differedPeriod » permet ici de décaler l'envoi de 120 minutes.

 

Suivre l'envoi de mon SMS

L'état du SMS est récupérable via le champ « deliveryReceipt » :

GET https://api.ovh.com/1.0/sms/sms-aa1-1/outgoing/123456

Le champ « deliveryReceipt » peut contenir les valeurs suivantes :

  • 0 → En cours d'envoi ;
  • 1 → Envoyé ;
  • 2 → Rejeté ou Expiré ;
  • 4 → En attente sur le réseau de l'opérateur du destinataire ;
  • 8 → Transmis au réseau de l'opérateur du destinataire ;
  • 16 → Non distribuable.

Une information supplémentaire est disponible avec le champ « ptt » :

Le champ « ptt » retournera un code dont la description est disponible via l'appel à la méthode :

https://api.ovh.com/1.0/sms/ptts
{
  "ptt":  4
}

Être notifié·e du changement d’état d’un SMS

OVHcloud peut vous prévenir en temps réel du changement d'état d'un SMS via un appel HTTP.

Pour paramétrer l'URL sur laquelle vous voulez être appelé·e :

PUT https://api.ovh.com/1.0/sms/sms-aa1-1                        {                            "callBack": "http://www.monsite.com/callbackSmsOvh.php"                        }                    

Une fois la configuration effectuée, à chaque changement d'état d'un SMS, l'URL sera appelée avec les paramètres suivants :

  • Id → L'ID du SMS ;
  • dlr → Le statut deliveryReceipt ;
  • ptt → Le statut ptt ;
  • date → Date de mise à jour du statut ;
  • sender → L'expéditeur du SMS ;
  • receiver → Le numéro du destinataire du SMS.

Créditer mon compte SMS manuellement

Vous pouvez générer un bon de commande via l'API d'OVHcloud :

POST https://api.ovh.com/1.0/order/sms/sms-aa1-1/credits                        {                            "quantity":     100                        }                    

Recréditer automatiquement mon compte en-dessous d'un certain seuil

OVHcloud vous propose de recréditer automatiquement votre compte lorsque vous franchissez un seuil défini de crédits.


Un bon de commande sera généré et payé automatiquement sur votre compte client OVHcloud, puis régularisé.


Pour paramétrer la recharge automatique de 100 crédits lorsque vous passez en-dessous de 10 crédits sur votre compte :

PUT https://api.ovh.com/1.0/sms/sms-aa1-1                        {                            "automaticRecreditAmount":              100,                            "creditThresholdForAutomaticRecredit":  10,                        }                    

Connaître le tarif des SMS vers une destination

Pour connaître à l'avance le tarif de votre envoi, vous pouvez effectuer l’appel suivant :

GET https://api.ovh.com/1.0//sms/sms-aa1-1/seeOffers)                        {                            "countryDestination": "fr",                            "countryCurrencyPrice": "fr",                            "quantity": 1000,                        }                    

Cet appel vous retournera une structure vous permettant de connaître le prix de 1 000 SMS dans la devise du pays de destination (ex. € pour la France).

Envoyer une campagne de SMS à un grand nombre de destinataires

Pour optimiser vos envois groupés, vous pouvez précharger les destinataires dans un fichier CSV.

Pour créer un fichier de destinataires, utilisez la méthode suivante :

POST https://api.ovh.com/1.0/sms/sms-aa1-1/receivers                        {                            "csvUrl":       "http://monsite.com/mes_destinataires.csv",                            "description":  "Liste de mes clients",                            "slotId":       1                        }                    

Le fichier doit comporter au minimum une colonne « number » avec le numéro des destinataires. Vous pouvez définir d'autres colonnes pouvant être utilisées pour remplacer des variables dans vos envois. Exemple de fichier :

number;name;age                        +33601020304;Dupont;47                        +33602030405;Martin;36                        +33603040506;Dupond;39                    

Pour envoyer un SMS à tous les destinataires de ce fichier, il ne vous reste plus qu'à utiliser l’appel suivant :

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs                        {                            "message":              "Bonjour, M. #NAME#. Vous avez #AGE# ans.",                            "receiversSlotId":      1,                            "senderForResponse":    true                            "tag": "MaCampagne"                        }                    

Avec cet appel, les trois destinataires recevront un message personnalisé.
Par exemple, monsieur Dupont recevra le message « Bonjour M. Dupont, c’est votre anniversaire ! ».

De plus, l'ajout du paramètre « tag » vous permettra de rechercher les SMS correspondant à cet envoi via la méthode :

GET https://api.ovh.com/1.0//sms/sms-aa1-1/outgoing)                            {                                "tag": "MaCampagne"                            }                    

Veuillez noter que la méthode ne vous renverra pas les ID des SMS dans ce mode. L'envoi se fera, en effet, de façon asynchrone.

Recevoir des réponses à un SMS

OVHcloud vous permet de recevoir des réponses à vos SMS.
Lorsque vous envoyez un SMS avec le champ « senderForResponse », votre destinataire pourra vous répondre.

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs                        {                            "message":              "Votre rendez-vous est programmé au 13 février. Pour accepter, répondez OUI",                            "receivers":            ["+33601020304"],                            "senderForResponse":    true                        }                    

Personnaliser l'expéditeur de mon SMS

Le service SMS d'OVHcloud vous permet de personnaliser vos expéditeurs (11 caractères alphanumériques maximum).
Pour éviter toute usurpation d'identité, il est nécessaire de procéder à la validation de votre expéditeur.

1. Pour déclarer un nouvel expéditeur :

POST https://api.ovh.com/1.0/sms/sms-aa1-1/senders
{
  "reason": "I own the company and need to send SMS to my customers",
  "sender": "SMS inc."
}

2. Une validation manuelle est alors déclenchée :

Pour connaître l'état de la validation, récupérez le champ « status » :

GET https://api.ovh.com/1.0/sms/sms-aa1-1/senders/SMS inc.

3. Le champ « status » peut contenir les valeurs suivantes :

  • waitingValidation → En attente de validation ;
  • refused → Validation refusée (la raison sera disponible dans le champ « comment ») ;
  • enable → Activé (votre expéditeur est utilisable) ;
  • disable → Désactivé (l'expéditeur est temporairement désactivé et ré-activable à tout moment).

Une fois votre expéditeur validé, vous pouvez envoyer un SMS avec ce dernier.

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs
{
  "message": "Test message",
  "receivers": ["+33601020304"],
  "sender": "SMS inc."
}

Lors de l'envoi d'un SMS avec un expéditeur personnalisé, une mention légale « STOP 36111 » sera ajoutée à la fin de votre SMS. Ainsi, il ne sera pas envoyé le week-end et entre 22 h et 8 h du matin. Par exemple, si vous envoyez votre SMS le dimanche à 16 h, l'envoi sera automatiquement repoussé au lundi à 8 h.

Toutefois, si votre SMS n'est pas à vocation marketing, vous pouvez spécifier le paramètre « 'noStopClause': true » dans l'appel pour que cette mention ne soit pas ajoutée et que votre SMS soit envoyé à tout moment.

Être notifié·e lors d'une réponse à un SMS

OVHcloud peut vous prévenir en temps réel d’une réponse à votre SMS via un appel HTTP.
Pour paramétrer l'URL sur laquelle vous voulez être appelé·e :

PUT https://api.ovh.com/1.0/sms/sms-aa1-1                        {                            "cgiUrl":       "http://www.monsite.com/incomingSmsOvh.php",                            "responseType": "cgi"                        }                    

Une fois la configuration effectuée, à chaque SMS entrant, l'URL sera appelée avec les paramètres suivants :

  • id → Identifiant du SMS ;
  • alias → Numéro de l'expéditeur ;
  • shortcode → Numéro auquel l'expéditeur a répondu ;
  • keyword → Premier mot de la réponse ;
  • moMessage → Réponse.

SDK PHP pour envoyer des SMS