API HTTP - Action 'sendmessage'

Cette commande API HTTP permet d'envoyer un message SMS via la passerelle SMS. La commande peut être utilisée pour envoyer des SMS texte ou d'autres types de messages, tels que des SMS binaires, des logos d'opérateur, des sonneries, des WAP PUSH, etc... Lorsque vous utilisez cette commande, vous devez utiliser un nom d'utilisateur et mot de passe API HTTP, vous devez spécifier le numéro de téléphone du destinataire et le texte du message.

Description

Pour envoyer un SMS, utilisez le format d'URL suivant :

https://127.0.0.1:9508/api?action=sendmessage&username=UUUUU&password=PPPPP&
recipient=NNNNN&messagetype=MMMMM&messagedata=DDDDD

127.0.0.1 est une IP locale, veuillez donc la remplacer par l'adresse IP ou le nom d'hôte de l'ordinateur sur lequel la passerelle SMS Ozeki est installée. (Remarque : 127.0.0.1 est une adresse de bouclage locale qui peut être utilisée lorsque vous vous connectez à la passerelle SMS depuis le même ordinateur.) 9508 est le port par défaut de l'API HTTP de la passerelle SMS Ozeki. Ce numéro de port peut être visualisé et modifié dans l'interface utilisateur de la passerelle SMS Ozeki 10, en cliquant sur le bouton Avancé dans la barre d'outils.

"UUUUU" et "PPPPP" doivent être remplacés par le nom d'utilisateur et le mot de passe de l'utilisateur que vous avez créé dans la passerelle SMS.

Remplacez "NNNNN" par le numéro de téléphone auquel vous souhaitez envoyer le SMS. Vous pouvez utiliser le format de numéro de téléphone local ainsi que les formats internationaux (les numéros de téléphone formatés selon le format international commencent toujours par un signe '+'). Si le format international est utilisé, notez que vous devez remplacer le caractère '+' par '%2B', en raison des règles d'encodage des URL.

Remplacez "MMMMM" par le type de message. Le type de message "SMS:TEXT" doit être utilisé pour les messages texte.

Les données du message contiennent le message que vous souhaitez envoyer. Placez les données du message à la place de "DDDDD". Les données du message doivent utiliser des caractères UTF-8 et doivent être encodées en URL.

D'autres paramètres peuvent également être ajoutés à la requête.
Pour une liste complète des paramètres disponibles, veuillez consulter le tableau 'Paramètres de requête' ci-dessous :

Exemple de requête URL

https://127.0.0.1:9508/api?action=sendmessage&username=admin&password=abc123&
recipient=06203105366&messagetype=SMS:TEXT&messagedata=Hello+World

Exemple de réponse

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

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE smsapi PUBLIC "-//OZEKI//DTD XML 1.0//EN" "http://www.ozekisms.com/DTD/smsapi.xml">
<response>
   <action>sendmessage</action>
   <data>
      <acceptreport>
         <statuscode>0</statuscode>
         <statusmessage>Message accepté pour livraison</statusmessage>
         <messageid>ERFAV23D</messageid>
         <recipient>06203105366</recipient>
      </acceptreport>
   </data>
</response>

<acceptreport>
   <statuscode>0</statuscode>
   <statusmessage>Message accepté pour livraison</statusmessage>
   <messageid>ERFAV23D</messageid>
   <recipient>06203105366</recipient>
</acceptreport>

Résumé

Cet article portait sur l'action 'sendmessage' de l'API HTTP. Avec cette action, vous pouvez envoyer des SMS texte et de nombreux autres types de messages à des destinataires via la passerelle SMS Ozeki. Vous avez vu des exemples de réponses et d'autres requêtes HTTP avec description, valeurs possibles et exemples.

Si vous souhaitez en savoir plus sur l'état de livraison de vos messages, n'hésitez pas à cliquer sur la page concernant les statuts de livraison SMS. Si vous souhaitez obtenir un modèle d'URL, visitez la page correspondante.

Si vous souhaitez utiliser cette solution dans des situations réelles, téléchargez la passerelle SMS Ozeki et commencez à l'utiliser dès maintenant !