SMS - Didacticiels

Documentation de l'API

La documentation Swagger API est disponible ici :

URL et URI de base

Le chemin de base de l'API Vortext est situé à l'adresse :

Toutes les méthodes sont relatives à cette URL.

Par exemple, si vous voulez obtenir le statut de Vortext, vous devez utiliser :

GET https://messages.cloud.cegedim.com/status

Sécurité

Protocole HTTPS

Toutes les demandes à l'API de Vortext sont effectuées par le protocole HTTP, en utilisant le cryptage de transport TLSv1.

Authentification

Pour l'instant, l'authentification de base est utilisée pour chaque demande faite au service de Vortext.

Chaque demande est complètement apatride, de sorte que vous pouvez utiliser le service Vortext avec une simple ligne decurl.

Si vous ne connaissez pas l'authentification de base, il suffit d'un en-tête de requête http 'Authorization' :

Authorization Basic YWRtaW5pc3RyYXRvc5cnF2NjBTenh3djRuaU5meEV5VFgwaUN4VmNTaHF1djBYU0RIbjY2

L'identifiant utilisé est username:password encodé en base 64. La plupart des bibliothèques vous demanderont simplement de fournir un nom d'utilisateur et un mot de passe.

Format des demandes et réponses HTTP : json

Cette API est principalement destinée à traiter les messages json dans les corps de demande et de réponse http.

Format de la demande HTTP

Utilisez l'en-tête Content-Type : application/json pour indiquer au service Vortext le format du corps de votre requête.

Format de la réponse HTTP

Utilisez l'en-tête Accept : application/json pour indiquer au service Vortext le format que vous souhaitez pour le corps de la réponse.

Format de la date et de l'heure

Comme json ne supporte pas nativement la date et l'heure, tous les paramètres étiquetés comme date dans cette API sont des chaînes au format ISO8601 :

`YYYY-MM-DDTHH:MM:SS.sssZ`

où Z est le fuseau horaire (comme+0200).

Exemples : 2016-06-01T12:27:19.000+0200

Pour les paramètres de requête, n'oubliez pas d'encoder ces paramètres en url.

Nom de l'expéditeur

Vous pouvez personnaliser le nom de l'expéditeur du SMS, au lieu d'un numéro classique tel que "30180". Pour ce faire, veuillez faire une demande dans ITCare à notre équipe en demandant la mise en place de cette fonctionnalité.

Une fois votre compte configuré, tous les SMS envoyés le seront avec ce nom d'expéditeur. Pour l'instant, il n'est pas possible d'avoir plusieurs noms d'expéditeur par compte.

Réponses PUSH

Il est possible de recevoir des réponses PUSH (appel REST https) dès qu'un client répond à un SMS envoyé précédemment. Pour activer cette fonctionnalité, veuillez faire une demande dans ITCare à notre équipe.

Voici les spécifications des demandes sortantes que vous recevrez une fois activées :

Limites

Vous pouvez fixer des limites pour éviter les appels multiples / mauvaises boucles et empêcher certaines inondations :

  • le nombre total de SMS envoyés par minute

  • total des SMS envoyés par heure

  • nombre total de SMS envoyés par jour

Pour activer cette fonctionnalité, veuillez faire une demande dans ITCare à notre équipe.

Dernière mise à jour