Webservices

Services Web (Webservices) avec playSMS

On pourrait encore appeler Webservices, API web, en gros c'est la fonctionnalité qui vous permet

d'envoyer des SMS via une instance playSMS depuis votre n'importe quel site web par la méthode

GET du protocole HTTP, via un formulaire ou en utilisant l'esthétique technologie Ajax

Cet article est inspiré du document officiel, que vous pouvez retrouver ici : https://github.com/antonraharja/playSMS/wiki/Webservices, écrit par Anton Rahardja le créateur et

développeur principal de playSMS.

Comment accéder aux Webservices de playSMS

L'accès aux Webservices se fait comme sus-mentionné par une requêtes HTTP formatée ainsi :

http://[domaine_web_de_playSMS_ou_url]/index.php?app=webservices

Les paramètres des webservices

Vous devez être familier avec le protocole HTTP et que vous devez savoir comment lui passer des

paramètres quelque soit : dans un formulaire, dans une URL ou par Ajax, si vous ne connaissez pas

cela, merci de demander à Google c'est un investissement que vous n'allez pas regretter.

Les paramètres sont :

u : le username

p : le mot de passe

ta : le type d'action exemple :

pv : envoi privé;

bc : diffusion;

ds : delivery status;

sms_poll : resultats du poll du plugin sms_poll;

sms_board : board results from plugin sms_board

to : numéro destinataire (pour ta=pv) ou code du groupe destinataire (pour ta=bc).

     On peut mettre plusieurs numéros de destinataires (séparés par des virgules)

     utilisable lorsque ta=pv

msg : type de message (flash ou text)

unicode : si le message est codé en unicode ou non(1=unicode, 0=non unicode)

last : L'ID log du dernier SMS (ce nombre n'est pas inclus dans le resultat)

c : nombre de delivery status qui seront recupérés

slid : ID log du SMS (pour ta=ds, quand slid est défini 'last' et 'c' sont sans effets)

les erreurs retournées (ERROR RETURNS )

OK : action exécutée et  avec succès et rien n'est retourné ceci uniquement quand "ta=bc"

OK [SMS_LOG_ID] : action excécutée avec succès et l'ID du log du SMS est retourné

OK [NUMBER],[SMS_LOG_ID] : action excécutée avec succès et le numéro de destination

                           est retourné. Ceci uniquement quand "ta=pv" et "to" contient

                           plusieurs destinations

OK [CREDIT] : action excécutée avec succès et le crédit de l'utilisateur est retourné

ERR 100 : erreur d'authentification

ERR 101 : type d'action non valide

ERR 102 : Un ou plusieur champs vides

ERR 200 : errer d'envoi privé

ERR 201 : numéro de destination ou message vide

ERR 300 : erreur d'envoi de diffusion

ERR 301 : groupe de destination ou message vide

ERR 400 : pas de statu de réception retourné

Spécification du Protocol

Send SMS ta : pv parameters : u, p, to, msg, type, unicode returns : error returns notes : to parameter is a valid international formatted mobile number

Send broadcast SMS ta : bc parameters : u, p, to, msg, type, unicode returns : error returns notes : to parameter is group code
Delivery reports ta : ds parameters : u, p, slid, c, last returns : formatted text: SMS log ID; Source number; Destination Number; Message; Delivery Time; Update Pending Status Time; SMS Status notes : slid retrieves only 1 delivery report at particular SMS log ID c retrieves as many as c value last retrieves from last SMS log ID
User credits ta : cr parameters : u, p returns : user's credit

Exemple :

Example webservice URLs:

http://playsms.org/trial/index.php?app=webservices&ta=pv&u=admin&p=rahasia&to=01234567890&msg=meeting+at+15.00+today!http://playsms.org/trial/index.php?app=webservices&ta=pv&u=admin&p=rahasia&to=01234567890,0134455667788&msg=meeting+today!http://playsms.org/trial/index.php?app=webservices&ta=bc&u=admin&p=rahasia&to=TI&msg=meeting+at+15.00+today!http://playsms.org/trial/index.php?app=webservices&ta=ds&u=admin&p=rahasia&c=100 http://playsms.org/trial/index.php?app=webservices&ta=cr&u=admin&p=rahasia

Another example, a webservice URL: http://x.com/index.php?app=webservices&ta=bc&u=admin&p=rahasia&to=TI&msg=meeting+at+15.00+today!

Explanation: User admin access playSMS webservices in x.com with type of action bc (broadcast) if succeded returns: OK SMS_LOG_ID (eg: OK 754) if error occured returns one of the ERROR RETURNS mentioned above