Une interface XML-RPC permet de communiquer avec notre passerelle depuis vos propres applications, quel que soit le langage de programmation employé (VisualBasic, C#, Perl, PHP, Java, etc.).

La documentation de l’API est disponible à l’adresse suivante: API XML-RPC

Il existe plusieurs implémentations d’XML-RPC pour .Net, on peut par exemple utiliser
celle-ci : xml-rpc.net (C# ou VB.NET).

Une version SOAP de notre API est maintenant disponible : définition WSDL.

Une classe PHP est disponible pour intégrer de façon très simple notre passerelle SMS dans les applications Web.

Elle est disponible sur GitHub à cette adresse: https://github.com/Net Oxygen/smsapiv2clients/tree/master/PHP

Le fichier exemple.php qui se trouve dans l’archive sert d’exemple complet d’utilisation de la classe PHP No2SMS_Client en ligne de commande.

L’envoi de SMS est disponible par l’envoi d’un mail.

Le format est le suivant « destinataire+user+pass[+sender+type]@sms.netoxygen.ch »

• destinataire : un ou plusieurs destinataires (séparés par « ; »)
• user : votre nom d’utilisateur
• pass : votre mot de passe
• sender : l’expéditeur du message (optionnel, ne fonctionne que si la modification de l’expéditeur à la volée est activée pour le compte)
• type : le type du message (‘text’ ou ‘flash’) (optionnel)

le sujet du mail sera le texte envoyé par SMS au destinataire.

Une interface d’envoi de SMS par URL (méthodes GET et POST) à l’adresse https://sms.netoxygen.ch/url/. Les paramètres sont les suivants :

• action : une action parmi ‘send’ (par défaut, envoie un SMS), ‘get_status’ (permet d’obtenir le statut d’un SMS envoyé précédemment), ‘get_credits’ (permet d’obtenir le nombre de crédits SMS restants), ‘cancel’ (permet d’annuler un SMS planifié)
• user : votre nom d’utilisateur
• pass : votre mot de passe
• format:  ‘csv’ (par défaut) ou ‘json’. Ce paramètre permet de contrôler le format de la réponse (optionnel). S’il n’est pas renseigné, alors ‘csv’ est utilisé.

De plus pour l’action ‘send’ :

• dest : un ou plusieurs destinataires (séparés par « ; »)
• msg : le message à envoyer
• from : l’expéditeur du message (optionnel, ne fonctionne que si la modification de l’expéditeur à la volée est activée pour le compte)
• date : une date (dans le futur, format YYYY-MM-DD HH:MM) à laquelle le message sera envoyé (optionnel)
• type : le type du message (‘text’ ou ‘flash’) (optionnel)

De plus pour l’action ‘get_status’ :

• msgid : un ou plusieurs identifiants de messages à interroger (séparés par « ; »)

En cas de succès, l’appel de cette adresse renvoie :

• si l’action est ‘send’ : pour chaque destinataire, une ligne avec les champs suivants, séparés par « ; » : destinataire, code d’acceptation du message (1 = accepté), identifiant du message
• si l’action est ‘get_status’ : pour chaque identifiant de message, une ligne avec les champs suivants, séparés par « ; » : l’identifiant du message, le destinataire du message, la date d’envoi, le code d’erreur, le message d’erreur correspondant,la date de dernière mise à jour du statut, le code de statut, la valeur de statut correspondant
• si l’action est ‘get_credits’ : le nombre de crédits restant
• si l’action est ‘cancel’ : pour chaque identifiant de message, une ligne avec l’identifiant du  message et une valeur booléenne qui indique si l’annulation a pu être effectuée ou non

Remplacer les <> par vos données.

Pour envoyer un sms (méthode send):

• https://sms.netoxygen.ch/url/?action=send&user=&pass=&msg=&dest=

Pour obtenir le nombre de crédits restant (méthode get_credits):

• https://sms.netoxygen.ch/url/?action=get_credits&user=&pass=

Pour obtenir le statut du message (méthode get_status) et reçevoir la réponse en JSON:

• https://sms.netoxygen.ch/url/?action=get_status&user=&pass=&msgid=&format=json

Cette méthode est particulièrement intéressante pour envoyer automatiquement des alertes SMS depuis votre NAS (Synology par exemple) ou un autre appareil capable d’appeler une URL lors d’un événement prédéfini. Si vous avez besoin d’assistance pour intégrer notre solution d’envoi de SMS avec un logiciel ou un appareil tiers ou que vous souhaitez simplement nous informer que vous l’utilisez, nous serions ravi que vous preniez contact avec nous !