Dans les exemples de cette documentation l'on utilise le symbole {:name} pour votre nom d'utilisateur et {:pass} pour votre mot de passe.

Transcription

1 SMTP XML API Aspects généraux Envoyez des SMS à travers le courrier électronique. Dans les exemples de cette documentation l'on utilise le symbole {:name} pour votre nom d'utilisateur et {:pass} pour votre mot de passe. Pour envoyer SMS/MMS par la plateforme d'envoi de SMS par de Lleida Networks, il suffit d'envoyer un avec les paramètres suivants: Objet du message Vide. Destinataire Corps du message Le corps du message doit être formaté selon les spécifications des sections 1, 2, ou 3. Éléments communs Élément dst Cet élément doit contenir un ou plus subéléments num, chacun d'entre eux contenant un numéro de téléphone destinataire du SMS: <num> </num> <num> </num> <num> </num> Les numéros de téléphone doivent être indiqués en format international (c'est à dire, avec le signe + au début du code du pays). Il n'y a pas de limite définie pour la quantité de destinataires d'un SMS, mais il est recommandé de ne pas dépasser les Notez que l'url doit être correctement coder des symboles spéciaux. Par exemple, dans ce cas %2B correspondant au symbole +. Élément src

2 Cet élément contient l'émetteur du SMS, l'émetteur peut être numérique ou alphanumérique. Si l'émetteur est alphanumérique, celui-ci ne peut pas dépasser le 11 caractère de longueur; s'il est numérique, il ne peut pas dépasser les 15 caractères. <src>miremitente</src>... Élément txt L'élément txt contient le texte du SMS qui s'enverra. Si la longueur du texte dépasse la limite de caractères par SMS (160 pour les messages texte avec codage ASCII et 70 pour les messages en codage Unicode), le SMSC de Lleida.net divisera le message en plusieurs SMS enchaînés. Cet élément dispose de deux paramètres optionnels, encoding et charset, pour les cas où le texte du message ait une codification différente à la spécifiée dans l'entête du XML. Un exemple serait le cas où le XML soit codé en ISO (latin-1) et le SMS soit envoyé en Unicode. Si le texte du message a un codage différent à celui du XML, le paramètre encoding doit avoir la valeur base64, et le contenu de l'élément txt doit être codé en base64. De cette manière l'on évite que l'xml ne soit pas valide à cause des caractères non valides dans le codage utilisé. En outre, le paramètre charset doit contenir le code de caractères utilisé (par exemple, "utf-16" pour codage Unicode). Lors que le serveur de l'api/xml/http trouve ces paramètres, il décode en premier le texte de base64, et ensuite il l'importe selon le charset spécifié. Il faut remarquer que les paramètres encoding et charset n'affectent pas au codage du SMS résultat: sa seule fonction est de pouvoir inclure le texte dans n'importe quel charset dans l'xml. Le codage du SMS variera lors de l'envoi en fonction du contenu de l'élément data_coding. L'exemple suivant spécifie comme texte du SMS la phrase "hello world", mais ave le codage utf-16. Exemple <txt encoding="base64" charset="utf-16"> /v8asab1agwababvacaadwbvahiababk </txt> Élément data_coding Cet élément optionnel contrôle le codage d'envoi du SMS (voir la spécification de la 3GPP numéro TS ). Les deux valeurs autorisées sont: text (valeur par défaut), et unicode. Si la valeur text est spécifiée, seulement seront autorisés dans le

3 texte du message les caractères de l'alphabet GSM (la majorité des caractères ASCII). Cependant, avec la valeur unicode l'on peut utiliser des caractères de n'importe quel alphabet (à condition que le téléphone récepteur l'admet), car le SMS est envoyé en UTF-16. Si vous envoyez des SMS Unicode, vous devrez probablement combiner cet élément avec les paramètres encoding et charset de l'élément txt. L'exemple suivant envoie un SMS qui contient les lettres grecques alpha et bêta: <num> </num> <txt encoding="base64" charset="utf-16"> /v8dsq0y </txt> <data_coding>unicode</data_coding> Élément delivery_receipt Cet élément active la demande de notification de remise pour le SMS. L'élément peut être vide, ou contenir une adresse de courrier électronique. S'il contient une adresse de courrier électronique, un sera envoyé à cette adresse lors que l'opérateur notifie une modification de l'état du SMS, qui peut être Remise à l'opérateur, Remis au destinataire, Échoué, parmi d'autres. Si l'élément est vide, la demande de notification sera également activée. Lors de la réception, l'état du message sera noté dans les bases de données du SMSC de Lleida.nt, et peut être consulté à travers le portail utilisateur, et si l'envoi a été effectué en utilisant l'élément mt_id, il pourra être consulté à travers la consultation d'état d'un message de la même API. Cet élément dispose de quatre paramètres optionnels pour activer et configurer le service de SMS certifié. Dans le paramètre lang vous devez indiquer la langue dans laquelle vous souhaitez recevoir le certificat. Si l'élément delivery_receipt ne contient pas le paramètre lang, le certificat sera envoyé en espagnol. Le paramètre cert_type doit contenir le type de certificat que vous souhaitez consulter. Actuellement il n'y a qu'un certificat disponible. Pour cela, le paramètre cert_type doit contenir la valeur D (de certificat par défaut). Les paramètres cert_name et cert_name_id s'utilisent pour indiquer la Raison sociale et le NIF dynamique qui apparaitra dans la certification du PDF pour pouvoir configurer ces données à chaque envoi. Les langues disponibles pour le certificat sont:

4 Code CA DE EN ES FR IT NL PT Code Langue Catalá Deutsch English Espagnol Français Italiano Netherlands Português Langue IMPORTANT: Si le service de SMS certifié est activé, l'élément doit contenir delivery_receipt où le certificat sera envoyé. Mauvaise défaut de l' contiennent -8 erreur apparaît. Exemple d'envoi de SMS avec notivication via <delivery_receipt> </delivery_receipt> Exemple d'envoi de SMS avec demande d'état de remise sans être envoyée à un

5 <delivery_receipt/> Exemple d'envoi de SMS avec certificat de réception: <delivery_receipt lang = "ES" cert_type="d"> micorreo@electronico.es </delivery_receipt> Élément allow_answer Cet élément permet de spécifier que l'envoi du message soit effectué avec un émetteur numérique long pour que le destinataire puisse y répondre. Si l'utilisateur a un numéro propre attribué, l'on utilisera celui-ci. Dans le cas contraire, l'on lui en attribuera un dynamique. Lors que cet élément est spécifié, l'élément src ne peut pas apparaître. <allow_answer/>

6 Élément mt_id Cet élément permet que l'utilisateur assigne un identifiant unique pour chaque message, qui peut être utilisé ultérieurement pour vérifier l'état du message. Le contenu de l'élément doit être une chaîne alphanumérique unique, à laquelle le système ajoutera, ultérieurement, le numéro de destination pour former l'identifiant. <mt_id>abcde1234</mt_id> Tel qu'il a été indiqué, le système ajoute le téléphone de destination à l'identifiant pour pouvoir gérer le cas d'envois multiples. Dans l'exemple précédent, l'identifiant généré pour le premier message serait ABCDE1234: , et pour le deuxième, ABCDE1234: IMPORTANT:: Si avec le même mt_id, le destinataire se répète, la consultation d'état (voir 4) ne renverra que l'information du dernier envoyé. Élément schedule Avec cet élément l'on peut spécifier la date et l'heure où vous souhaitez remettre le message au destinataire. De cette manière, il est possible d'effectuer un envoi de messages programmé pour une date et une heure concrètes. Le format de la date et l'heure doit être YYYYMMDDhhmm. Cet exemple programmerait le message de texte pour être remis aux deux destinataires le 1 décembre 2007 à 13:50.

7 <schedule> </schedule> Élément mail Cet élément permet de spécifier une adresse de courrier électronique où sera envoyé le rapport avec le résultat de l'envoi du message et le crédit disponible dans le compte de l'utilisateur qui effectue l'envoi. <txt>this is the SMS text</txt> Types de MMS MMS Permet d'envoyer et de recevoir des contenus multimédia, y compris audio, vidéos, photos et tout autre contenu disponible à l'avenir. Wappush L'envoi d'un Wappush est significativement plus économique que l'envoi d'un MMS, et est obligatoire lorsqu'il s'agit de contenus qui ne sont pas multimédia, comme par exemple des jeux Java. Cependant, il est moins directe pour l'utilisateur final, car celui-ci doit autoriser le téléchargement du contenu. Waplink Le format du corps du message pour ce type d'envoi est similaire à celui d'un SMS. Le téléphone recevra un message de navigateur (message WAP) avec le commentaire envoyé et l'url pour accéder au site ou télécharger le contenu. Mime Types supportés Types de contenus autorisés dans les MMS Les MMS peuvent inclure les formats de contenu suivants: Images formats GIF et JPEG (normal et progressive) image/gif image/jpeg Audio AMR, WAV, MP3 et MIDI audio/amr audio/x-wav audio/mpeg audio/midi

8 Vidéo formats 3GP et MPEG4 video/3gpp video/mpeg Il convient de prendre en compte que l'opérateur du réseau, lors de la configuration de son MMSC, décide des types de contenu qui peuvent être envoyés au terminal de l'utilisateur. Pour les Waplink, il est possible de configurer davantage de MimesTypes que ceux affichés sur cette liste. Format des SMIL Lleida.net n'est pas responsable du format incorrect d'un SMIL envoyé grâce à cette API. Il est la responsabilité de l'application client de générer un SMIL bien formé et correcte. SMIL Recommendation: ( SMIL 2 version: ( SMIL 3 version: ( Envoi de SMS Le corps du message doit être en format XML, étant celui-ci le seul contenu (pas de signatures, etc). Le nœud principal XML doit être obligatoirement la balise sms. Paramètres Exemple user Login de l'utilisateur dans la plateforme d'envois de SMS de Lleida.net. password Login de l'utilisateur dans la plateforme d'envois de SMS de Lleida.net. txt Le texte du SMS. dst Contient un ou plusieurs éléments num, avec les numéros destination du SMS. src Optionnel. Contient l'émetteur du message. data_coding Optionnel. Spécifie la codification du SMS. delivery_receipt Optionnel. Active la notification de remise. allow_answer Optionnel. Active l'envoi avec émetteur numérique long. mt_id Optionnel. Spécifie un identifiant unique pour le message. schedule Optionnel. Spécifie l'heure de remise du message destination souhaitée. mail Optionnel. Un de contrôle, où le résultat de l'opération et le crédit disponible sera envoyé. <num> </num> <num> </num> <txt>el texto del mensaje</txt>

9 Envoi de liens Web via WAP Le format du corps du message pour ce type d'envois est similaire à celui de l'envoi d'un SMS. Le téléphone recevra un message de navigateur (message WAP) avec le commentaire envoyé et l'url pour accéder au site ou télécharger le contenu. Le nœud principal XML doit être obligatoirement la balise waplink. Avec les envois de Waplink ne peut pas activer l'option de SMS Certifié. Dans ce cas-ci, les paramètres optionnels lang et cert_type ne doivent pas être introduis. Paramètres Exemple user Login de l'utilisateur dans la plateforme d'envois de SMS de Lleida.net. password Mot de passe de l'utilisateur dans la plateforme d'envois de SMS de Lleida.net. txt Le texte affiché comme commentaire du message au destinataire avant de télécharger son contenu. dst Contient un ou plusieurs éléments num, avec les numéros destination du SMS. url Lien web (URL), habituellement il s'agira d'un lien vers une image, un audio ou une application. delivery_receipt Optionnel. Active la notification de remise. mail Optionnel. Un de contrôle, à laquelle un message sur le résultat de l'opération et le solde disponible est envoyé. <waplink> <url> </url> <txt> Descripción </txt> <delivery_receipt> </delivery_receipt> </waplink> Envoi de MMS Le format du corps du message pour l'envoi de MMS est similaire au précédent, mais avec quelques modifications. Tout d'abord, le fichier multimédia qui va être envoyé (image, audio, etc) doit être inclus dans le mail en tant qu'attachment, donc le corps du courrier doit être codé en fonction du standard MIME avec content-type 'multipart/mmixed', où la première partie correspond au XML de contrôle et la deuxième correspond au fichier. Les applications de courrier effectuent cette étape automatiquement, et il ne faut qu'écrire dans le corps le XML de contrôle puis ajouter l'attachment. Cependant, si l'envoi s'effectue depuis une application, il faut réaliser le codage expressément (il existe des bibliothèques MIME disponibles dans presque toutes les langages de programmation). Il est important que les entêtes MIME de la sous-partie

10 correspondante au fichier multimédia incluent le content-type des données, car, le cas échéant, les téléphones portables ne pourront pas lire le fichier. Le root element du XML doit être obligatoirement le tag mms. Paramètres Exemple user Login de l'utilisateur dans la plateforme d'envois de SMS de Lleida.net. password Mot de passe de l'utilisateur dans la plateforme d'envois de SMS de Lleida.net. txt Le texte affiché comme commentaire du message au destinataire avant de télécharger son contenu. dst Contient un ou plusieurs éléments num, avec les numéros destination du MMS. subject Objet du MMS. waplink Optionnel. Indique si le message doit être envoyé comme WAPPUSH. mail Optionnel. Un de contrôle, où le résultat de l'opération et le crédit disponible sera envoyé. <mms> <subject>envio MMS</subject> <txt> el texto que se mostrará a continuación del contenido multimedia </txt> <waplink/> </mms>