- Comment configurer la connexion
- Comment rechercher des webinaires
- Comment vérifier si un utilisateur est présent dans un webinaire actif
- Comment obtenir les données d'historique d'un utilisateur
- Comment vérifier si un utilisateur est dans la liste de tous les participants
- Comment créer un participant
- Comment inscrire un participant à un webinaire
Comment configurer la connexion
Vous devez d'abord obtenir la clé API. Vous pouvez la trouver dans la section Profil de votre compte personnel sur MyOwnConference
Après avoir copié la clé, ouvrez Paramètres -> Constantes du projet sur Mavibot et collez-la dans la variable myownconference_api_key :
Chaque fonction renvoie un dictionnaire qui possède un paramètre status ; sa valeur peut être 0 ou 1.
Si status=1, la requête dans MyOwnConference a réussi et le paramètre result contiendra le résultat de la requête, par exemple :
{'status': '1', 'result': [{'name': 'Super web', 'alias': 'csml-sjgf-cnjp-clkw', 'start': '2022-02-12 00:00:00'}]}
ou la requête a réussi, mais rien n'a été trouvé :
{'status': '1', 'result': []}
Si status=0, il y a un problème et la description se trouvera dans error, par exemple :
{"status":"0","error":"Webinar with alias "wenk-gjkc-teqp-nteh" not active"} {'status': '0', 'error': 'Missing required variables - email'}
Comment rechercher des webinaires
La fonction myownconference_find_webinars(date, status) est utilisée pour rechercher des webinaires, où
date - la date au format jj.mm.aaaa - sélection des webinaires pour une date spécifique
status - valeur 1 pour les webinaires actifs ou futurs, 0 pour les terminés
myownconference_find_webinars() - renvoie le tableau de tous les webinaires trouvés
La fonction renvoie un dictionnaire de ce type :
En cas de succès (exemple) :
{'status': '1', 'result': [{'name': 'Super web', 'alias': 'csml-sjgf-cnjp-clkw', 'start': '2022-02-12 00:00:00'}]}
En cas d'échec (exemple) :
{"status":"0","error":"Format not supported or date is not valid. Params must be yyyy-mm-dd"}
Comment vérifier si un utilisateur est présent dans un webinaire actif
La fonction myownconference_is_online_user(webinar_id, email), où :
webinar_id - l'identifiant du webinaire, ou, en d'autres termes, la valeur « alias » de la requête lors de la recherche du webinaire
email - l'adresse e-mail de l'utilisateur ; si elle n'est pas fournie, l'e-mail de la variable email est utilisé, s'il existe
Le résultat si la fonction a réussi :
{"status":"1","result":true} - l'utilisateur est présent en ce moment dans le webinaire {"status":"1","result":false} - l'utilisateur n'est pas présent
Le résultat en cas d'erreur dans la requête :
{"status":"0","error":"Webinar with alias "serg-dhpq-mznf-fwcb" not active"}
Comment obtenir les données d'historique d'un utilisateur
La fonction myownconference_history_user(webinar_id, email), où
webinar_id - l'identifiant du webinaire, ou, en d'autres termes, la valeur « alias » de la requête lors de la recherche du webinaire
email - l'adresse e-mail de l'utilisateur ; si elle n'est pas fournie, l'e-mail de la variable email est utilisé, s'il existe
Le résultat en cas de succès :
Dans le paramètre result, il y aura un tableau avec les données de l'utilisateur
{'status': '1', 'result': ['John Smith', '[email protected]', 'ua', '12:02:45', '12:12:15', 'G', '28%']} {"status":"1","result":false} - l'utilisateur n'a pas été trouvé
En cas d'échec :
{'status': '0', 'error': 'Missing required variables - email'} - l'e-mail n'a pas été fourni et n'a pas été trouvé dans la variable email
Un exemple de requête et d'obtention du nom de l'utilisateur :
Comment vérifier si un utilisateur est dans la liste de tous les participants
La fonction myownconference_is_our_user(email), où :
email - l'adresse e-mail de l'utilisateur ; si elle n'est pas fournie, l'e-mail de la variable email est utilisé, s'il existe
Le résultat en cas de succès :
{"status":"1","result":true} - l'utilisateur est dans votre base de données {"status":"1","result":false} - cet utilisateur n'est pas dans votre base de données
En cas d'échec :
{'status': '0', 'error': 'Missing required variables - email'} - l'e-mail n'a pas été fourni et n'a pas été trouvé dans la variable email
Comment créer un participant
Cette fonction ajoute un participant au webinaire dans la liste de tous les utilisateurs. Après la création réussie, cet utilisateur peut être inscrit à un webinaire (plus d'informations ci-dessous)
La fonction myownconference_add_user(email), où :
email - l'adresse e-mail de l'utilisateur ; si elle n'est pas fournie, l'e-mail de la variable email est utilisé, s'il existe
Le résultat en cas de succès :
{"status":"1","result":true} - l'utilisateur a été ajouté à votre liste de tous les participants
En cas d'échec :
{'status': '0', 'error': 'Missing required variables - email'} - l'e-mail n'a pas été fourni et n'a pas été trouvé dans la variable email.
Comment inscrire un participant à un webinaire
Il est obligatoire de demander l'e-mail du client pour que l'inscription ait lieu. Tout le reste est facultatif.
La fonction myownconference_add_user_to_webinar(webinar_id, email), où
webinar_id - l'identifiant du webinaire, ou, en d'autres termes, la valeur « alias » de la requête lors de la recherche du webinaire
email - l'adresse e-mail de l'utilisateur ; si elle n'est pas fournie, l'e-mail de la variable email est utilisé, s'il existe
Le résultat en cas de succès :
{"status":"1","result":true} - l'utilisateur a été inscrit au webinaire
En cas d'échec :
{"status":"0","error":"Webinar with alias "serg-dhpq-mznf-fwcb" not active"}