API Event SFR – Réception en temps réel de SMS, MMS, etc.

Recevez en temps réel des événements sur vos applications

Utilisez l’API Event pour intégrer à vos applications des fonctionnalités de réception d’événements en provenance de clients SFR Mobile et opérateurs partenaires : réception de SMS/MMS, de réponse à des requêtes de géolocalisation (API Géoloc) ou d’accès au carnet d’adresse (API PAB).

Description

L’API Event en quelques mots

  • Réception en temps  réel de SMS / MMS envoyé depuis un téléphone mobile SFR
  • Réception de notifications de consentement utilisateur pour la géolocalisation ou l’accès au carnet d’adresse
  • Compatible avec tous les mobiles SFR et opérateurs partenaires
  • Gratuit et illimité

Les usages

Les usages sont divers et variés et dépendent du type d’événement attendu. Néanmoins l’API Event est utilisé dans deux cas de figure bien différents :

  • Réception de SMS et/ou MMS sur votre application.
  • Réception d’acceptations/révocations de consentement utilisateurs nécessaires lors de l’utilisation des APIs de Géoloc et de Carnet d’adresses.

Schéma du fonctionnement de l'API Event de SFR

Réception de SMS et/ou MMS
Pour envoyer un SMS ou MMS à votre application les utilisateurs doivent envoyer leur message au numéro court attribué à cette dernière (par défaut le 6010 pour le SMS et le 6016 pour le MMS) en y intégrant #ApplicationID#  au début de leur message.

Ce ApplicationID est indispensable afin de router les messages vers votre application. Par défaut il correspond à la concaténation du nom de votre application (red101) et de votre nom de partenaire (login Dev’Zone). A noter qu’il peut être personnalisé sur simple demande dès lors que vous passez en mode « commercial ».

Ex. Envoi d’un sms à votre application : « #red101mickey#  Salut les amis ! »

Réception d’acceptations/révocations de consentement utilisateurs
Les utilisateurs ont la possibilité d'accepter ou de révoquer les autorisations d'accès à leur position ou à leur carnet d'adresse en envoyant par SMS (par défaut au 6010) contenant OUI suivi de votre ApplicationID.
Ex. Message type d’un utilisateur autorisant votre application à le localiser : « OUI red101mickey »

Ils utilisent l'API Event

Application ThinksWall
L’utilisateur envoi, depuis son mobile SFR, un SMS à un numéro court qui lui est précisé et son message s’affiche sous forme de post-it sur une page web.

Plus d’informations sur ThinksWall

Tutoriel

Les APIs SFR sont accessibles au travers des différents SDK (PHP, Java, et bientôt Flex/AS3) téléchargeables gratuitement. Pour plus d’informations se référer à l’onglet Documentation.

Prix et Quotas

Tarifs

L’API Event est utilisable gratuitement.

Quotas

Par défaut l’API Event autorise:

Envoi requêtes / minuteEnvoi requêtes / mois
6036 000

Documentation

Méthodes

L'ensemble des méthodes sont accessibles au travers des différents SDK (PHP, Java et bientôt Flex/AS3) disponibles gratuitement en téléchargement. Pour plus de sécurité, les web services sont exposés via une interface de type SOAP/HTTPs.

Méthode eventConsume()

La méthode eventConsume vous permet de recevoir des événements. Cette méthode fonctionne dans un mode asynchrone qui vous impose de devoir faire un polling sur la méthode (sauf en Java où le SDK permet de gérer le polling de façon transparente).

Au cours de l'appel la méthode peut récupérer un événement (code événement + contenu) ou arriver à terme et provoquer un TimeOut (fenêtre de 120s). A vous alors d'appeler de nouveau la méthode eventConsume afin de veiller à l'arrivé d'un nouvel événement.

Nous rencontrons actuellement quelques problèmes techniques qui rendent impossible la réception de MMS vers vos applications. Veillez nous excuser pour la gêne occasionnée.

Exemples d'utilisation

  1. En cours de mise à jour.
  1. En cours de mise à jour.
  1. Prochainement disponible.
  1. Prochainement disponible.