API SMS

Un service simple et fiable pour envoyer des SMS dans le monde.
Vous avez la liberté d'intégrer l'envoi de SMS au coeur de vos algorithmes et de vos procédures métiers afin de profiter du moyen de communication le plus instantané et global.



API OVH


Les cas d'usages

Rappels et rendez-vous SMS

Rappeler un rendez-vous par SMS est un moyen très fiable de s’assurer du respect des horaires. Vous êtes un établissement recevant du public sur rendez-vous, évitez les rendez-vous ratés en envoyant des rappels par SMS.

Les avantages

  • API Rest
  • Expéditeur personnalisable
  • Accusé de réception
  • SMS différé
  • 200 000 SMS
  • Haute délivrabilité, routes redondées
  • Couverture mondiale 600 opérateurs
  • SMS réponse (two-way)

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 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.

Personnaliser l'expéditeur de mon SMS

Le service SMS d'OVH 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érer 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 cet expéditeur.

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, et votre SMS ne sera pas envoyé le week-end et entre 22h et 8h du matin. Si vous envoyez votre SMS le dimanche à 16h, l'envoi sera automatiquement repoussé au lundi à 8h.

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é instantanément à tout moment.

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
                        }
                    

OVH 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. Le SMS sera donc envoyé deux heures plus tard.

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: Délivré
  • 2: Rejected or Expired
  • 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: Undeliverable


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é lors du changement d'état d'un SMS

OVH permet d'être notifié 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é :


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

Il est possible de générer un bon de commande via l'API d'OVH :

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

Vous ne souhaitez pas vous soucier de la quantité de crédit qu'il vous reste ?

OVH 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 OVH, puis régularisé.

Pour paramétrer le recrédit 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,
                        }
                    
Recevoir des réponses à un SMS

OVH 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
                        }
                    


La liste des SMS reçus est consultable via l'API :


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

Les détails des messages entrants sont consultables via l'appel suivant :


GET https://api.ovh.com/1.0/sms/sms-aa1-1/incoming/123456
                    
Être notifié lors d'une réponse à un SMS

OVH vous permet d'être notifié en temps réel lorsqu'un destinataire répond à votre SMS via un appel HTTP.
Pour paramétrer l'URL sur laquelle vous voulez être appelé :


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
Envoyer une campagne de SMS à de nombreux destinataires

Pour optimiser vos envois massifs, 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, a minima, une colonne "number" avec le numéro des destinataires.
Vous pouvez définir d'autres colonnes qui peuvent ê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'à appeler la méthode suivante :


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. Vous avez 47 ans."

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 https://api.ovh.com/1.0/sms/sms-aa1-1/jobs ne vous renverra pas les ID des SMS dans ce mode. L'envoi se fera, en effet, de façon asynchrone.

Connaître le tarif des SMS vers une destination

Pour connaître à l'avance le tarif de votre envoi, vous pouvez appeler la méthode suivante :

Cet appel vous retournera une structure vous permettant de connaître le prix de 1000 SMS vers la France, dans la devise utilisée en France (€).

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

SDK PHP pour envoyer des SMS

Devenir partenaireEspace clientWebmailSupport

En continuant votre navigation sur ce site, vous acceptez l'utilisation des cookies afin d'assurer le bon déroulement de votre visite et de réaliser des statistiques d'audience.
En savoir plus et gérer les cookies.

Ok
Haut de page