Differences

This shows you the differences between two versions of the page.

Link to this comparison view

ravenweb_api_fr [2012/02/14 16:40] (current)
Line 1: Line 1:
 +{{:logo_trasp.png|}}
 +
 +
 +
 +==== Langue ====
 +
 +
 +
 +[[ravenweb api|{{italy.png|Italiano}}]] [[ravenweb api en|{{united_kingdom_great_britain_.png|English}}]] [[ravenweb api fr|{{france.png|Français}}]]
 +
 +
 +
 +====== RavenWeb API ======
 +
 +
 +
 +===== Envoi SMS unique =====
 +
 +
 +
 +
 +
 +<note important>Avec ce type d'envoi, on peut envoyer un message unique vers un numéro de téléphone portable.</note>
 +
 +
 +
 +
 +
 +URL de référence : http://gateway.airtelco.com/raven/sms/send
 +
 +
 +
 +<note> Exemple :
 +
 +                 http://gateway.airtelco.com/raven/sms/send?login=LOGIN&password=PASSWORD
 +
 +                               &phone=%2b393330000000&from=Mittente&body=Testo
 +
 +</note>
 +
 +
 +
 +
 +
 +==== Paramètres ====
 +
 +
 +
 +
 +
 +  * __nom utilisateur__
 +
 +
 +
 +//Identifiant du compte, fourni avec l'activation du service.//
 +
 +
 +
 +
 +
 +  * __mot de passe__
 +
 +
 +
 +//Mot de passe du compte, fourni avec l'activation du service.//
 +
 +
 +
 +  * __de__
 +
 +
 +
 +//Paramètre non obligatoire. La valeur de ce paramètre s'affichera comme expéditeur du message.//
 +
 +
 +
 +  * __corps__
 +
 +
 +
 +//La valeur de ce paramètre sera utilisée comme corps du message.//
 +
 +
 +
 +  * __téléphone__
 +
 +
 +
 +//Paramètre obligatoire. Indique le destinataire du message.// 
 +
 +
 +
 +<note important>Le numéro de téléphone doit être au format international : +[préfixe international][préfixe opérateur][numéro de téléphone] 
 +
 +Exemple : +393330000000</note>
 +
 +
 +
 +  * __qualité__
 +
 +
 +
 +//Paramètre facultatif. Indique la qualité du message. Si le paramètre qualité n'était pas renseigné, la qualité Premium serait alors utilisée.
 +
 +//
 +
 +
 +
 +**Valeurs possibles : p (Qualité Premium), s (Qualité Standard)**
 +
 +
 +
 +  * __action__
 +
 +
 +
 +//Paramètres facultatif pour l'envoi unique. S'il n'était pas renseigné, l'action par défaut serait utilisée.
 +
 +default sms.//
 +
 +
 +
 +  * __type__
 +
 +
 +
 +//Paramètres facultatif. Indique le type de message en cours d'envoi.//
 +
 +
 +
 +**Valeurs possibles : texte, ucs, long, lucs, binaire, wappush**
 +
 +
 +
 +//La valeur par défaut est **texte**.//
 +
 +
 +
 +  * __encodage__
 +
 +
 +
 +//Paramètre facultatif. On peut spécifier l'encodage utilisé par le client.//
 +
 +
 +
 +**Valeurs possibles : latin-1, utf8.**
 +
 +
 +
 +S'il n'était pas renseigné, l'encodage par défaut **latin-1** serait utilisé.
 +
 +
 +
 +  * __url__
 +
 +
 +
 +__Paramètre obligatoire pour les sms de type wappush__. Indique l'URL qui sera utilisé pour la création du message WAP PUSH.
 +
 +
 +
 +  * __udh__
 +
 +
 +
 +__Paramètre obligatoire pour les sms de type binaire.__ Indique la valeur du champ Utilisateur En-tête données du message à 8bit qui sera envoyé vers le téléphone portable.
 +
 +
 +
 +
 +
 +=== Description des valeurs possibles du paramètre type ===
 +
 +
 +
 +  * texte
 +
 +
 +
 +//Message textuel (7octets) de 160 caractères//
 +
 +
 +
 +  * ucs
 +
 +
 +
 +//Message unicode de 70 caractères.// Pour envoyer des messages de type Unicode, il faut convertir chaque caractère du texte du message à la valeur unicode hexadécimale correspondante. (En utilisant cette modalité, vous pourrez envoyer des textes contenant des caractères non supportés par l'alphabet GSM comme par exemple les idéogrammes japonais).
 +
 +
 +
 +<note>Exemple : pour le texte “AABB”, la valeur du champ corps devra être “41414242”</note>
 +
 +
 +
 +  * long
 +
 +
 +
 +//Message long.// Permet d'envoyer des messages textuels contenant plus de 160 caractères dans une seule demande. Chaque partie séparée d'un long message textuel se compose de 152 caractères. Par exemple, un message de 320 caractères sera comptabilisé comme 3 messages, la première et la seconde
 +
 +partie de 152 caractères et la troisième partie de 16 caractères.
 +
 +
 +
 +  * lucs
 +
 +
 +
 +//Message long unicode.// Permet d'envoyer des messages Unicode ayant plus de 70 caractères dans une requête unique. Chaque partie composée d'un long message unicode se compose de 62 caractères. Par exemple, un message de 140 caractères comptera comme 3 messages, la première et la
 +
 +seconde de 62 caractères et la troisième de 16 caractères.
 +
 +
 +
 +  * binaire
 +
 +
 +
 +//Message binaire (8bit).// Permet d'envoyer des messages binaires comme par exemple des logos, des sonneries, des messages image et des EMS. En utilisant ce type de message, il faudra également renseigner le paramètre udh. Pour envoyer des messages de type binaire, il faut convertir chaque octet du corps du message avec sa valeur hexadécimale. 
 +
 +
 +
 +  * wappush
 +
 +
 +
 +Message WAP PUSH. Permet d'envoyer des messages wap push (Message composé d'une partie textuelle et d'une URL) . En utilisant ce type de message, il faudra également renseigner le paramètre url.
 +
 +
 +
 +
 +
 +
 +
 +==== Réponse de la passerelle SMS ====
 +
 +
 +
 +
 +
 +  * **Succès**
 +
 +  
 +
 +La passerelle renverra une chaîne formée comme suit : **ENVOYE [Identifiant du message]**
 +
 +
 +
 +<note tip>Exemple : ENVOYE 1344</note>
 +
 +
 +
 +  * **Erreur**
 +
 +
 +
 +La passerelle renverra une chaîne formée comme suit : **ERR [Code Erreur] [Message]**
 +
 +
 +
 +
 +
 +===== Envoi SMS multiples =====
 +
 +
 +
 +<note important>Grâce à ce type d'envoi, on peut envoyer le même message vers une liste de numéros séparés par des virgules. La liste pourra contenir au maximum 500 numéros.</note>
 +
 +
 +
 +URL de référence : http://gateway.airtelco.com/raven/sms/send
 +
 +
 +
 +<note>Exemple : 
 +
 +<code>http://gateway.airtelco.com/raven/sms/send?login=LOGIN&password=PASSWORD&phone=%2b393330000000,%2b393112222222&
 +
 +from=Mittente&body=Testo&action=batch</code></note>
 +
 +
 +
 +
 +
 +==== Paramètres ====
 +
 +
 +
 +<note>La description des paramètres reste inchangée par rapport à l'envoi d'un SMS unique</note>pt
 +
 +
 +
 +  * __action__
 +
 +
 +
 +//Paramètre obligatoire.// Pour pouvoir activer cette méthode d'envoi, le paramètre action devra contenir la valeur **batch**.
 +
 +
 +
 +  * __téléphone__
 +
 +
 +
 +//Paramètre obligatoire.// Le paramètre téléphone pourra contenir un ou plusieurs numéros de téléphone séparés par des virgules comme dans l'exemple.
 +
 +
 +
 +
 +
 +==== Réponse de la passerelle SMS ====
 +
 +
 +
 +  * **Succès**
 +
 +
 +
 +La passerelle renverra une chaîne formée comme suit : **ENVOYE [Identifiant expédition] – [Envoi réussi] – [Non envoyés]**
 +
 +
 +
 +<note tip>Exemple : SENT 100 – 500 – 0</note>
 +
 +
 +
 +
 +
 +  * **Erreur**
 +
 +
 +
 +La passerelle renverra une chaîne formée comme suit : **ERR [Code Erreur] [Message]**
 +
 +
 +
 +===== Contrôle SMS et crédit restant =====
 +
 +
 +
 +<note important>Grâce à cette fonction, on peut contrôler le crédit restant ou le numéro de SMS encore à disposition.</note>
 +
 +
 +
 +URL de référence : http://gateway.airtelco.com/raven/sms/send
 +
 +
 +
 +==== Crédit restant ====
 +
 +
 +
 +http://gateway.airtelco.com/raven/sms/send?login=LOGIN&password=PASSWORD&action=credit
 +
 +
 +
 +==== SMS disponibles ====
 +
 +
 +
 +http://gateway.airtelco.com/raven/sms/send?login=LOGIN&password=PASSWORD&action=sms
 +
 +
 +
 +==== SMS disponibles pour la qualité ====
 +
 +
 +
 +http://gateway.airtelco.com/raven/sms/send?login=LOGIN&password=PASSWORD&action=smsdetails
 +
 +
 +
 +
 +
 +==== Réponse de la passerelle SMS ====
 +
 +
 +
 +  * **crédit**
 +
 +
 +
 +Résumé : **[Valeur] [Crédit restant]**
 +
 +
 +
 +<note tip>Exemple : EUR 45,10</note>
 +
 +
 +
 +  * **sms**
 +
 +
 +
 +Résumé : **[Numéro SMS]**
 +
 +
 +
 +<note tip>Exemple : 1100</note>
 +
 +
 +
 +  * **smsdétails**
 +
 +
 +
 +<code><?xml version="1.0" encoding="iso-8859-1"?><xml><premium>80</premium><standard>100</standard></xml></code>
 +
 +
 +
 +===== Alertes SMS =====
 +
 +
 +
 +<note important>En envoyant des messages en qualité Premium, on pourra recevoir l'alerte de livraison du message.
 +
 +La livraison est confirmée par un message envoyé vers le téléphone portable du destinataire au centre  de services de l'opérateur qui a
 +
 +envoyé le SMS. La passerelle, à son tour, enverra l'alerte au client, reçue par l'opérateur, grâce à un POST HTTP
 +
 +vers une URL renseigné précédemment par le client dans l'espace réservé.</note>
 +
 +
 +
 +Exemple : http://sitoclient/script?obj_id=1344&send_id=340&status=Delivered&timestamp=2008-11-07%2015:10:00&phone=%2b393112222222
 +
 +
 +
 +
 +
 +==== Paramètres côté Client ====
 +
 +
 +
 +  * obj_id
 +
 +
 +
 +//Identifiant univoque du message envoyé.// Ce paramètre sera renseigné avec l'identifiant indiqué précédemment par la passerelle en réponse à un envoi unique.
 +
 +
 +
 +  * envoi_id
 +
 +
 +
 +//Identifiant univoque d'une expédition.// Ce paramètre sera renseigné avec l'identifiant indiqué précédemment par la passerelle en réponse à un envoi multiple.
 +
 +
 +
 +  * statut
 +
 +
 +
 +//Etat du message.// Valeurs possibles “Livré” “Non livré” ; la livraison ou la non livraison du message seront indiquées.
 +
 +
 +
 +  * pointeur
 +
 +
 +
 +//Date et heure de réception du message.// Si le message est au statut “Livré”, la date et l'heure de livraison du message seront indiquées. Dans le cas contraire, c'est la date et l'heure de réception de l'alerte qui s'affichera.
 +
 +
 +
 +  * téléphone
 +
 +
 +
 +__Numéro de téléphone destinataire du message.__
 +
 +
 +
 +
 +
 +<note>Si l'URL du client n'était pas accessible, le système effectuera une nouvelle tentative incrémentale pendant 10 minutes. En cas de retour négatif en continu, il enregistrera les données associées à l'alerte dans un répertoire dédié pour permettre au client de demander, en contactant l'assistance, un rapport des alertes reçues pendant une période donnée. Les détails des alertes seront conservés dans ce répertoire pendant 30 jours. La passerelle conservera l'URL inaccessible même à cause d'un problème de dépassement de délais, l'attente maximale étant de 5 secondes.</note>
 +
 +===== Liste des Erreurs =====
 +
 +
 +
 +**ERR 10** Erreur d'authentification\\
 +
 +**ERR 11** Aucun utilisateur ou mot de passe\\
 +
 +**ERR 12** Adresse IP non autorisée\\
 +
 +**ERR 20** Valeur d'action erronée\\
 +
 +**ERR 23** Mauvaise date ou heure différée\\
 +
 +**ERR 64** Contenu expéditeur non autorisé\\
 +
 +**ERR 65** Contenu du message non autorisé\\
 +
 +**ERR 66** Mode bloqué différé\\
 +
 +**ERR 67** Blocage qualité\\
 +
 +**ERR 68** Compte bloqué\\
 +
 +**ERR 299** Type message erroné\\
 +
 +**ERR 301** Url Wap Push erroné\\
 +
 +**ERR 302** Mauvais encodage unicode ou binaire\\
 +
 +**ERR 303** Mauvais en-tête de données utilisateur\
 +
 +**ERR 304** 
 +
 +  * Message binaire trop long
 +
 +  * Message unicode trop long (Max 140 octets)
 +
 +  * Message unicode long trop long (Max 496 octets - 4 parties)
 +
 +**ERR 305** Mauvais expéditeur\\
 +
 +**ERR 306** Message trop long (Max 760 caractères)\\
 +
 +**ERR 307** Type de message non disponible en qualité standard\\
 +
 +**ERR 308** Crédit insuffisant\\
 +
 +**ERR 309** Numéro de téléphone hors de la liste de couverture\\
 +
 +**ERR 400** Erreur système\\
 +
 +**ERR 401** Impossible de mettre les messages en file d'attente\\
 +
 +===== Liens Utiles =====
 +
 +
 +
 +__Message binaire__ : 
 +
 +
 +
 +  - http://en.wikipedia.org/wiki/Smart_Messaging (introduction)\\
 +
 +  - http://www.forum.nokia.com/main/html_readers/smart_messaging_faq.html (détaillée)
 +
 +
 +
 +__Alphabet GSM__ :
 +
 +
 +
 +  - http://www.airtelco.com/docs/gsm_default_alphabet.html
  
ravenweb_api_fr.txt · Last modified: 2012/02/14 16:40 (external edit)
 
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki