System Requirements
Need IntraMessenger server (on local network or on internet).Syntax and writing conventions
The called server script serveur will be: /distant/actions.php
Query will use this form:
http://your-server/im/distant/actions.php?parameter1=value1¶meter2=value2¶meter3=value3&
For easy reading, url will be displayed (shortly) to only parameters, like this:
?parameter1=value1¶meter2=value2¶meter3=value3&
To nota: the first parameter sending is preceded by a question mark, he following are separated by a ampersand.
Parameters are always written in lower case.
The addresses (url) do not contain any spaces.
If texts are sent, they are then encoded in base 64.
This format ensures the integrity of texts sent as parameters (spaces are forbidden, it circumvents these problems).
Server returned values
>F00#value1#value2#value3#4 first characteres ( >F00 ) indicates the returned function number (see /doc/fr/tech/liste_fonctions.txt).
The values are shown just after, separated by pound.
If texts are received, they are then encoded in base 64.
Unlike sending a request to the server, the receipt parameters order is important.
Tester la présence et le bon fonctionnement du serveur
Requête envoyée au serveur :?a=1&ip=MTkyLjE2OC4wLjEw&v=32&
- Le 1er paramètre (a) est le numéro de l'action demandée (1) : test du serveur.
Exécution du script /distant/include/sql_test.inc.php (voir fichier /distant/actions.php).
- Le 2ème paramètre (ip) est votre address IP encodée en base 64.
>F02#OK####
- La fonction retournée (2) est donc bien le test de connexion au serveur (avec vérification que la base de données fonctionne).
- La 1ère value renvoyée (OK) confirme que le serveur fonctionne correctement,
dans le cas contraire elle aurait contenu KO. - La 2ème value est vide, mais elle aurait pu contenir (si 1ère value à KO) :
- MAINTENANCE : si le serveur est en mode maintenance ( >F02#KO#MAINTENANCE# ).
- MAX : si le serveur a atteint le nombre maxium d'utilisateurs simultanés autorisés (voir options serveur _MAX_NB_USER et _MAX_NB_SESSION).
Récupération des options (étape 1/2)
Requête envoyée au serveur :?a=2&v=32&ip=MTkyLjE2OC4wLjEw&x=&
- Le paramètre a est le numéro de l'action 2 : récupération des options courtes.
Exécution du script /distant/include/get_options_1.inc.php.
- Le paramètre ip est votre address IP (encodée en base 64).
>F01##X#23##1#X####X#X#X######DOL3#20#2#5##X###X#X##2.0.3.225#...
- La fonction retournée (1) est donc la récupération des options courtes.
- La 1ère value renvoyée est vide, indiquant que l'utilisateur peux choisir son login/pseudo (sinon force le pseudo au nom de session Windows)
(option serveur _FORCE_USERNAME_TO_PC_SESSION_NAME ).
- La 2ème value n'est pas vide, l'utilisateur doit utiliser un mot de passe pour s'authentifier
(option serveur _USER_NEED_PASSWORD).
- La 4ème value est vide, les messages échangés ne sont pas chiffrés
(option serveur _CRYPT_MESSAGES).
- La 6ème value est l'option serveur _FORCE_AWAY_ON_SCREENSAVER.
- La 7ème value est l'option serveur _HIDE_COL_FUNCTION_NAME.
- La 9ème value indique si le serveur est privé ou public (vide) (voir l'option serveur _PASSWORD_FOR_PRIVATE_SERVER).
- La 10ème value est l'option serveur _ALLOW_INVISIBLE.
- La 11ème value est l'option serveur _ALLOW_SEND_TO_OFFLINE_USER.
- La 12ème value est l'option serveur _ALLOW_CHANGE_CONTACT_NICKNAME.
- La 13ème value est l'option serveur _LOCK_USER_CONTACT_LIST.
- La 14ème value est l'option serveur _LOG_MESSAGES.
- La 15ème value est l'option serveur _LOCK_USER_OPTIONS.
- La 16ème value est l'option serveur _SPECIAL_MODE_OPEN_COMMUNITY.
- La 17ème value est l'option serveur _SPECIAL_MODE_GROUP_COMMUNITY.
- La 18ème value indique si la liste des options est publique (voir l'option serveur _PUBLIC_OPTIONS_LIST).
- La 19ème value est l'option serveur _CHECK_NEW_MSG_EVERY.
- La 20ème value est l'option serveur _MINIMUM_USERNAME_LENGTH.
- La 21ème value est l'option serveur _MINIMUM_PASSWORD_LENGTH.
- La 22ème value est l'option serveur _ALLOW_USER_TO_HISTORY_MESSAGES (contenu inversé).
- La 23ème value est l'option serveur _ALLOW_CONFERENCE.
- La 24ème value est le type d'authentification externe (voir l'l'option serveur _EXTERNAL_AUTHENTICATION).
- La 25ème value est le titre de l'authentification externe (voir aussi l'option serveur _SITE_TITLE).
- La 26ème value si non vide indique que la mise à jour du client via votre serveur est possible.
- Si la mise à jour du client via votre serveur est possible, la 27ème value est l'option serveur _FORCE_UPDATE_BY_SERVER.
- La 28ème value est le numéro de version du serveur.
- La 29ème value est l'option serveur _ALLOW_CHANGE_EMAIL_PHONE.
- La 30ème value est l'option serveur _ALLOW_CHANGE_FUNCTION_NAME.
- La 31ème value est l'option serveur _ALLOW_SMILEYS.
- La 32ème value est l'option serveur _ALLOW_CHANGE_AVATAR.
- La 33ème value est l'option serveur _ALLOW_USE_PROXY.
- La 34ème value est l'option serveur _MAX_NB_CONTACT_BY_USER.
- La 35ème value est l'option serveur _ALLOW_UPPERCASE_SPACE_USERNAME.
- La 36ème value est l'option serveur _NEED_QUICK_REGISTER_TO_AUTO_ADD_NEW_USER.
- La 37ème value est l'option serveur _PWD_NEED_DIGIT_LETTER.
- La 38ème value est l'option serveur _PWD_NEED_UPPER_LOWER .
- La 39ème value est l'option serveur _PWD_NEED_SPECIAL_CHARACTER.
- La 41ème value est l'option serveur _SHOUTBOX.
- La ème value est l'option serveur _SHOUTBOX_VOTE.
- La ème value est l'option serveur _GROUP_FOR_SBX_AND_ADMIN_MSG.
- La ème value est l'option serveur _GROUP_USER_CAN_JOIN.
- La ème value est l'option serveur _SHOUTBOX_REFRESH_DELAY.
- La ème value est l'option serveur _SERVERS_STATUS.
- La ème value est l'option serveur _SHOUTBOX_NEED_APPROVAL.
- La ème value est l'option serveur _BOOKMARKS.
- La ème value est l'option serveur _BOOKMARKS_VOTE.
- La ème value est l'option serveur _BOOKMARKS_NEED_APPROVAL.
- La ème value est l'option serveur _BOOKMARKS_PUBLIC.
- La ème value est l'option serveur _LOCK_USER_PROFILE.
- La ème value est l'option serveur _ROLES_TO_OVERRIDE_PERMISSIONS.
Récupération des options (étape 2/2)
Requête envoyée au serveur :?a=3&v=32&ip=MTkyLjE2OC4wLjEw&x=&
- Le paramètre a est le numéro de l'action 3 : récupération des options longues.
Exécution du script /distant/include/get_options_2.inc.php
>F09####dG90b0B0aXRpLmZy#MzYxNQ##...
- La fonction retournée (9) est bien la récupération des options longues (encodées en base 64).
- La 1ère value est l'option serveur _SITE_URL_TO_SHOW.
- La 2ème value est l'option serveur _SITE_TITLE_TO_SHOW.
- La 3ème value est l'option serveur _EXTERN_URL_TO_REGISTER.
- La 4ème value est l'option serveur _ADMIN_EMAIL.
- La 5ème value est l'option serveur _ADMIN_PHONE.
- La 6ème value contient la liste des status (si l'option serveur _FORCE_STATUS_LIST_FROM_SERVER est activée).
- La 7ème value est l'option serveur _AWAY_REASONS_LIST.
- La 8ème value est l'option serveur _EXTERN_URL_FORGET_PASSWORD.
- La 9ème value est l'option serveur _SCROLL_TEXT.
- La 10ème value est l'option serveur _INCOMING_EMAIL_SERVER_ADDRESS.
- La 11ème value est l'option serveur _EXTERN_URL_CHANGE_PASSWORD.
- La 12ème à 15ème values contiennent le paramètrage des versions personnalisées.
- La 16ème value est l'option serveur _PUBLIC_FOLDER.
- La 17ème value est l'option serveur _ONLINE_REASONS_LIST.
- La 18ème value est l'option serveur _BUSY_REASONS_LIST.
- La 19ème value est l'option serveur _DONOTDISTURB_REASONS_LIST.
Démarrage : ouverture de la session
Requête envoyée au serveur :?a=4&un=VEhl&v=1.23A&ip=MTkyLjE2OC4wLjEw&c=UTRFVUZu&p=anZPa3&v_n=32&ln=FR&hr=&mn=&dt_j=&dt_m=&os=&pc=&rs=&br=&ml=&mc=&oo=&
- Le paramètre a est le numéro de l'action 4 : demande d'ouverture d'une session.
Exécution du script /distant/include/start.inc.php.
- Le paramètre un est le pseudo (en base 64).
- Le paramètre v est le numéro de version client.
- Le paramètre c est l'identifiant unique du PC (par rapport au matériel).
- Le paramètre p est le mot de passe chiffré.
- Le paramètre ln est la langue utilisée (FR, EN...).
- Les paramètres hr et mn sont l'heure du poste client (afin de calculer le décalage horaire).
- Les paramètres dt_j dt_m sont la date du poste client (afin de calculer le décalage horaire).
- Le paramètre os est l'abréviation du système d'exploitation du PC (XP, 7...).
- Le paramètre pc est le nom de l'ordinateur.
- Le paramètre rs est la résolution d'écran.
- Le paramètre br est le nom du navigateur par défaut.
- Le paramètre ml est le nom du logiciel de courrié par défaut.
- Le paramètre mc est l'address MAC.
- Le paramètre oo est la version d'Open-Office installée.
En mode entreprise (option serveur _ENTERPRISE_SERVER) :
>F05#NDAz#NDg0OA##31###########
- La fonction retournée (5) est donc l'ouverture de session.
- La 1ère value est différente de KO, l'ouverture de session est confirmée : c'est le numéro de session (en base 64).
- La 2ème value est votre identifiant numérique (en base 64).
- La 3ème value si indiquée, précise la différence horaire avec le serveur.
- La 4ème value est le numéro de jour de la date.
- La 5ème value est le numéro du dernier post dans la ShoutBox.
- La 6ème value si indiquée, peut contenir 2 values :
- A : vous recevez les alertes administrateur.
- N : c'est un nouveau compte, suivants options vous allez devoir renseigner votre profil.
Récupérer la liste de vos contacts
Requête envoyée au serveur :?a=12&iu=NDg2MA&is=NDAz&v=32&ip=MTkyLjE2OC4wLjEw&
- Le paramètre a est le numéro de l'action 12 : récupération de votre liste de contacts.
Exécution du script /distant/include/list_all_contacts.inc.php.
- Le paramètre iu est identifiant numérique (identifiant utilisateur) en base 64 (augmenté de la value de la fonction).
- Le paramètre is est votre numéro de session (en base 64).
>F19#OK####|MzA2MTk1MTQ3MTc4MjE3MzQ...
- La fonction retournée (19) est donc la liste des contacts.
- La 1ère value est OK confirmant le succès de la requête.
- La 4ème value est la liste des contacts (en base 64) séparés par le caractères "pipe" (très vertical).
Elle est décomposée :
- Pseudo;
- Identifiant numérique;
- Nom/fonction;
- Langue utilisée;
- Nom de l'avatar;
- Différence de temps (par rapport au serveur)
- address email;
- Numéro de téléphone;
- Genre:
- Code pays;
- Niveau hiérarchique (si option serveur activée);
- Note moyenne;
- Identifiant numérique dans votre liste de contacts;
- Etat du contact (validé, caché, VIP...);
- Nouveau nom (si renommé);
- Groupe;
Récupérer la liste des utilisateurs (contacts) connectés
Requête envoyée au serveur :?a=20&iu=NDg3Mg&is=NDAz&v=32&bi=MTE3&ip=MTkyLjE2OC4wLjEw&
- Le paramètre a est le numéro de l'action 20 (avec aussi les contacts offline) ou 22 : récupération des utilisateurs en ligne.
Exécution du script /distant/include/list_contact_online_offline.inc.php.
- Le paramètre bi est l'identifiant (en base 64) du dernier message lu de la ShoutBox.
>F16#-1#0#0##0#0#NyUyJTIlMiUyJTIlMiUyJQ##|>F16#ODEjIzQ3NTYjIyM|>F16#ODIjMCM0ODQ4IzAjIw|...
- La fonction retournée (16) est donc la liste des utilisateurs en ligne.
- La 1ère value est le nombre de messages privés en attente (en authentification externe, donc à consulter sur le forum, blog...).
- La 2ème value est le nombre de demandes de contacts en attente de validation.
- La 3ème value est le nombre de nouveaux messages non lus.
- La 5ème value contient l'indication si vous êtes invité à rejoindre une conférence, avec son identifiant ainsi que celui de celui qui vous invite.
- La 6ème value est l'identifiant du dernier message de la ShoutBox.
- La 7ème value est le numéro de groupe du dernier message de la ShoutBox.
- La 8ème value est la liste des états des serveurs/services (si option serveur _SERVERS_STATUS activée).
- Les values suivantes étant les utilisateurs en ligne (en base 64, précédés par l'entête >F16#), contenant pour chacun :
- Identifiant numérique dans votre liste de contacts;
- Numéro d'état (1 : en ligne, 2 : absent, ...);
- Identifiant numérique;
- Motif d'état (si option serveur activée);
- Groupe;
Récupérer la liste des demandes d'ajouts aux contacts en attente de confirmation
Requête envoyée au serveur :?a=25&iu=NDg3Nw&is=NDA2&st=1&v=32&bi=MTE3&bm=MTA&ip=MTkyLjE2OC4wLjEw&
- Le paramètre a est le numéro de l'action 25 : récupération ....................
Exécution du script /distant/include/list_contact_to_confirm.inc.php.
- Le paramètre iu est l'identifiant utilisateur (en base 64, augmenté de la value de la fonction).
- Le paramètre is est votre numéro de session (en base 64).
- Le paramètre st est votre numéro d'état (1 : online, 2 : away...).
- Le paramètre bi est le dernier numéro de message reçu de la ShoutBox non encore lu.
- Le paramètre bm eest l'identifiant du dernier marque page non encore lu.
>F12#-1#-1#0##0###|>F12#0#-#0#
- La fonction retournée () est donc la liste des contacts en attente de validation.
- La 1ère value est OK confirmant le succès de la requête.
- La 2ème value est le nombre de messages privés en attente (en authentification externe, donc à consulter sur le forum, blog...).
- La 3ème value est l'identifiant du dernier message de la ShoutBox non encore lu.
- La 4ème value est le numéro de groupe du dernier message de la ShoutBox.
- La 5ème value est la liste des états des serveurs/services (si option serveur _SERVERS_STATUS activée).
- La 6ème value est l'identifiant du dernier marque page non encore lu.
- Les values suivantes étant les contacts en attente de validation en ligne (en base 64, précédés par l'entête >F12#), contenant pour chacun :
- Identifiant numérique dans votre liste de contacts;
- Pseudo;
- Nom/fonction;
- Identifiant numérique;
- Code pays;
- Commentaire de proposation d'ajout de contact;
Envoyer un message
Requête envoyée au serveur :?a=50&u1=NDkwMg&u2=NDg0OA&s=NDA1&cr=64&m=Y291Y291&v=32&ip=MTkyLjE2OC4wLjEw&
- Le paramètre a est le numéro de l'action 50 : envoyer un message.
Exécution du script /distant/include/message_send.inc.php.
- Le paramètre s est votre numéro de session.
- Le paramètre u1 est l'identifiant utilisateur expéditeur (en base 64, augmenté de la value de la fonction).
- Le paramètre u2 est l'identifiant utilisateur destinataire (en base 64).
- Le paramètre cr indique que le message est juste chiffré en base 64 (option serveur _CRYPT_MESSAGES non activée).
- Le paramètre m est le message encodé.
>F40#OK#15:32:14######
- La fonction retournée (40) est donc l'envoi d'un message.
- La 1ère value est OK confirmant le succès de la requête.
- La 2ème value est l'heure d'expédition.
Recevoir un message
Requête envoyée au serveur :?a=51&u1=NDkwMw&u2=NDg0OA&s=NDA2&c=NEVVRm&v=32&ip=MTkyLjE2OC4wLjEw&dt_f=EN&
- Le paramètre a est le numéro de l'action (51) : récupération d'un message.
Exécution du script /distant/include/message_get.inc.php.
- Le paramètre u1 est l'identifiant utilisateur expéditeur (en base 64, augmenté de la value de la fonction).
- Le paramètre u2 est l'identifiant utilisateur destinataire (en base 64).
- Le paramètre c est l'identifiant unique du PC.
- Le paramètre dt_f est le format date (EN ou vide).
>F42#OK#dGVzdA#15:44:35##64##
- La fonction retournée (42) est donc la réception d'un message.
- La 1ère value est OK confirmant le succès de la requête.
- La 2ème value est le message (encodé).
- La 3ème value est son heure d'expédition.
- La 5ème value est le type d'encodage utilisé.
>F42#OK##h#2#0#### si aucun message.
- La fonction retournée (42) est donc la réception d'un message.
- La 1ère value est OK confirmant le succès de la requête.
- La 2ème value est vide, aucun message.
- La 4ème value est le numéro d'état du contact distant (1 : online, 2 : away...).
- La 5ème value est l'éventuel motif lié à l'état.
Informations
-
Forum officiel : http://www.intramessenger.com/forum/
N'hésitez pas à venir y proposer vos améliorations et suggestions ainsi que vos traductions.
-
Support : http://www.intramessenger.net/contact.php?lang=FR&
- Les mises à jours (nouvelles versions) du serveur ont lieu deux fois par an (vers septembre et janvier environ).
Consulter la liste des nouveautés ainsi que la liste des prochaines améliorations (sur internet).
THeUDS © 2006 - 2012