API HTTP - Action 'receivemessage'

Cette action peut être utilisée pour recevoir des SMS depuis la passerelle SMS en utilisant le sondage HTTP. Le sondage HTTP signifie que vous téléchargez les SMS depuis le dossier de réception de la passerelle comme vous téléchargeriez une page web. Dans cette section, vous pouvez obtenir des informations sur la manière d'utiliser l'action receivemessage, quels sont les paramètres, et vous trouverez un exemple de requête HTTP pour télécharger les messages entrants.

Description

Pour télécharger les messages texte entrants, utilisez le format d'URL suivant :

https://127.0.0.1:9508/api?action=receivemessage&username=UUUUU&password=PPPPP&
folder=inbox&limit=2&afterdownload=delete

Pour 127.0.0.1, vous devez substituer le nom d'hôte ou l'adresse IP de l'ordinateur sur lequel votre passerelle SMS est installée. Le numéro de port 9508 est le port HTTP par défaut de la passerelle SMS Ozeki. Son numéro de port peut être configuré dans l'interface utilisateur d'Ozeki 10 SMS Gateway, en cliquant sur le bouton Avancé dans la barre d'outils.

Le nom d'utilisateur et le mot de passe doivent être substitués à "UUUUU" et "PPPPP". Le nom d'utilisateur et le mot de passe identifient l'utilisateur que vous avez créé dans la passerelle SMS. Lorsque vous invoquez l'action receivemessage en appelant l'URL, vous téléchargerez les messages depuis la boîte de réception de l'utilisateur spécifié dans la requête avec le nom d'utilisateur et le mot de passe.

Le paramètre folder du message doit être défini sur inbox.

Le paramètre limit spécifie le nombre de messages qui seront téléchargés. Il est recommandé de télécharger moins de 1000 messages en une seule requête. Vous pouvez télécharger les messages restants dans des requêtes ultérieures.

Le paramètre afterdownload peut être utilisé pour supprimer les messages de la passerelle SMS une fois qu'ils ont été téléchargés avec succès.

Exemple de requête URL

https://127.0.0.1:9508/api?action=receivemessage&username=admin&password=abc123&
folder=inbox&limit=2&afterdownload=delete

Exemple de réponse

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 824

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE response PUBLIC "-//OZEKI//DTD XML 1.0//EN" "http://www.ozekisms.com/DTD/response.xml">
<response>
   <action>receivemessage</action>
   <data>
   <message>
   <messageid>ERFAV23D</messageid>
   <originator>06301234567</originator>
         <recipient>06201112222</recipient>
         <messagetype>SMS:TEXT</messagetype>
         <messagedata>Bonjour le monde</messagedata>
         <senttime>2008-01-16 10:04:00</senttime>
         <receivedtime>2008-01-18 20:58:04</receivedtime>
      </message>
      <message>
         <messageid>GYT4455D</messageid>
         <originator>06209994444</originator>
         <recipient>06201112222</recipient>
         <messagetype>SMS:TEXT</messagetype>
         <messagedata>Deuxième message</messagedata>
         <senttime>2008-01-16 10:08:00</senttime>
         <receivedtime>2008-01-18 20:58:05</receivedtime>
      </message>
   </data>
</response>

Paramètres de la requête

Paramètre	Description	Valeurs possibles	Exemple	O/M*
action	Spécifie la commande de l'API HTTP	receivemessage	action=receivemessage	M
username	Spécifie le nom d'utilisateur. Les paramètres username et password sont utilisés pour authentifier l'utilisateur. Une fois l'utilisateur authentifié, les messages seront téléchargés depuis sa boîte de réception. La valeur doit être encodée en URL.	valeur string, longueur maximale de 16 caractères	username=admin	M
password	Spécifie le mot de passe. Les paramètres username et password sont utilisés pour authentifier l'utilisateur. Une fois l'utilisateur authentifié, les messages seront téléchargés depuis sa boîte de réception. La valeur doit être encodée en URL.	valeur string, longueur maximale de 16 caractères	password=abc123	M
folder	Spécifie le nom du dossier. Par défaut, les messages seront téléchargés depuis le dossier inbox. Vous pouvez utiliser l'action receivemessage pour télécharger des messages depuis d'autres dossiers également.	inbox (par défaut) outbox deliveredtonetwork deliveredtohandset deliveryfailed	folder=inbox	O
limit	Spécifie le nombre maximum de messages à télécharger depuis le serveur dans la requête. Vous pouvez télécharger les messages restants avec des requêtes ultérieures.	valeur entière, la limite par défaut est 1000	limit=10	O
afterdownload	Spécifie la manière dont les messages doivent être traités après un téléchargement réussi. Les messages peuvent être supprimés de la passerelle SMS ; ils peuvent être marqués comme téléchargés ou laissés intacts. S'ils sont laissés intacts, la prochaine fois que vous initierez une requête de téléchargement, ils seront téléchargés à nouveau.	delete (par défaut) mark untouch	afterdownload=delete	O
responseformat	Vous pouvez spécifier le format des messages entrants de l'utilisateur.	xml, html, url-encoded	responseformat=xml	O

* M = Paramètre obligatoire, O = Paramètre optionnel

Paramètres de réponse
(format de réponse xml)

Paramètre	Description	Valeurs possibles	Exemple
message	Contient un seul message. La section des données peut contenir plusieurs messages. Le nombre de messages dans les données du message peut être inférieur ou égal à la valeur du paramètre limite		<message> <messageid>ERFAV23D</messageid> <originator>06301234567</originator> <recipient>06201112222</recipient> <messagetype>SMS:TEXT</messagetype> <messagedata>Bonjour le monde</messagedata> <senttime>2028-01-16 10:04:00</senttime> <receivedtime>2028-01-18 20:58:04</receivedtime> </message>
message.messageid	Contient une référence de message qui peut être utilisée pour suivre le message dans la passerelle SMS. Cette référence de message est également utilisée pour identifier les rapports de livraison au réseau et à l'appareil ou pour interroger des informations sur le message.	valeur de chaîne, longueur maximale de 16 caractères	<messageid>ERFAV23D</messageid>
message.originator	Contient le numéro de téléphone de l'expéditeur. C'est le numéro de téléphone du téléphone portable qui a envoyé le message.	valeur de chaîne, longueur maximale de 16 caractères	<recipient>06301234567</recipient>
message.recipient	Contient l'adresse du destinataire. C'est le numéro de téléphone qui a été utilisé pour envoyer le message.	valeur de chaîne, longueur maximale de 16 caractères	<recipient>06201112222</recipient>
message.messagetype	Contient l'identifiant du type de message spécifié dans la Spécification des types de messages mobiles. Dans la plupart des cas, ce sera SMS:TEXT.	valeur de chaîne, longueur maximale de 1024 caractères	<recipient>SMS:TEXT</recipient>
message.messagedata	Contient les données du message. Pour les messages texte, il s'agit du texte du message SMS. Pour d'autres types de messages, il s'agit d'une structure XML spécifiée dans la Spécification des types de messages mobiles. Les données du message sont encodées en UTF8.	valeur de chaîne	<messagedata>Bonjour le monde</messagedata>
message.senttime	Contient l'horodatage qui indique quand le message a été soumis depuis le téléphone de l'expéditeur.	Valeur de date et heure au format suivant : AAAA-MM-JJ hh:mm:ss	<senttime>2028-01-16 10:04:00</senttime>
message.receivedtime	Contient l'horodatage qui indique quand le message a été reçu par la passerelle SMS.	Valeur de date et heure au format suivant : AAAA-MM-JJ hh:mm:ss	<senttime>2028-01-18 20:58:04</senttime>

Résumé

Dans cet article, vous avez trouvé toutes les informations nécessaires pour utiliser l'action 'receivemessage' avec notre API SMS HTTP.

Avec cette solution, vous pouvez profiter des avantages du polling HTTP pour recevoir les messages texte entrants. Nous avons fait de notre mieux pour simplifier les choses et vous guider à travers tous les détails aussi facilement que possible. Si vous avez déjà terminé les étapes, vous avez vu les avantages d'utiliser notre API SMS HTTP. Si vous n'avez pas encore commencé à travailler sur la finalisation de votre système SMS via l'API, ne perdez plus de temps. Commencez maintenant !

Si vous souhaitez en savoir plus sur les avantages d'autres solutions SMS similaires, veuillez ouvrir la page sur l'envoi de messages avec le même système.

J'espère que cette page sera utile à tous les lecteurs et surtout aux débutants.