- Como configurar a conexão
- Como pesquisar webinars
- Como verificar se um usuário está presente em um webinar ativo
- Como obter dados do histórico do usuário
- Como verificar se um usuário está na lista de todos os participantes
- Como criar um participante
- Como registrar um participante em um webinar
Como configurar a conexão
Primeiro, você precisa obter a chave da API. Você pode encontrá-la na seção Perfil da sua conta pessoal no MyOwnConference
Após copiar a chave, abra Configurações -> Constantes do projeto no Mavibot e cole-a na variável myownconference_api_key:
Cada função retorna um dicionário que possui um parâmetro status; seu valor pode ser 0 e 1.
Se status=1, a requisição no MyOwnConference foi bem-sucedida e o parâmetro result conterá o resultado da requisição, como:
{'status': '1', 'result': [{'name': 'Super web', 'alias': 'csml-sjgf-cnjp-clkw', 'start': '2022-02-12 00:00:00'}]}
ou a requisição foi bem-sucedida, mas nada foi encontrado:
{'status': '1', 'result': []}
Se status=0, há um problema e a descrição estará em error, como:
{"status":"0","error":"Webinar with alias "wenk-gjkc-teqp-nteh" not active"} {'status': '0', 'error': 'Missing required variables - email'}
Como pesquisar webinars
A função myownconference_find_webinars(date, status) é usada para pesquisar webinars, onde
date - a data no formato dd.mm.yyyy - selecionando webinars para uma data específica
status - valor 1 - webinars ativos ou futuros, 0 - finalizados
myownconference_find_webinars() - retorna o array de todos os webinars encontrados
A função retorna um dicionário deste tipo:
Se bem-sucedido (exemplo):
{'status': '1', 'result': [{'name': 'Super web', 'alias': 'csml-sjgf-cnjp-clkw', 'start': '2022-02-12 00:00:00'}]}
Se mal-sucedido (exemplo):
{"status":"0","error":"Format not supported or date is not valid. Params must be yyyy-mm-dd"}
Como verificar se um usuário está presente em um webinar ativo
A função myownconference_is_online_user(webinar_id, email), onde:
webinar_id - o id do webinar, ou, em outras palavras, o valor “alias” da requisição ao pesquisar o webinar
email - o endereço de e-mail do usuário; se não for fornecido, será usado o e-mail da variável email, se houver
O resultado se a função foi bem-sucedida:
{"status":"1","result":true} - o usuário está presente neste momento no webinar {"status":"1","result":false} - o usuário não está presente
O resultado se houve um erro na requisição:
{"status":"0","error":"Webinar with alias "serg-dhpq-mznf-fwcb" not active"}
Como obter dados do histórico do usuário
A função myownconference_history_user(webinar_id, email), onde
webinar_id - o id do webinar, ou, em outras palavras, o valor “alias” da requisição ao pesquisar o webinar
email - o endereço de e-mail do usuário; se não for fornecido, será usado o e-mail da variável email, se houver
O resultado se bem-sucedido:
No parâmetro result haverá um array com dados do usuário
{'status': '1', 'result': ['John Smith', '[email protected]', 'ua', '12:02:45', '12:12:15', 'G', '28%']} {"status":"1","result":false} - o usuário não foi encontrado
Em caso de falha:
{'status': '0', 'error': 'Missing required variables - email'} - o e-mail não foi fornecido e não foi encontrado na variável email
Um exemplo da requisição e obtenção do nome do usuário:
Como verificar se um usuário está na lista de todos os participantes
A função myownconference_is_our_user(email), onde:
email - o endereço de e-mail do usuário; se não for fornecido, será usado o e-mail da variável email, se houver
O resultado se bem-sucedido:
{"status":"1","result":true} - o usuário está no seu banco de dados {"status":"1","result":false} - não há tal usuário no seu banco de dados
Se mal-sucedido:
{'status': '0', 'error': 'Missing required variables - email'} - o e-mail não foi fornecido e não foi encontrado na variável email
Como criar um participante
Esta função adiciona um participante do webinar à lista de todos os usuários. Após a criação bem-sucedida, este usuário pode ser registrado em um webinar (mais sobre isso abaixo)
A função myownconference_add_user(email), onde:
email - o endereço de e-mail do usuário; se não for fornecido, será usado o e-mail da variável email, se houver
O resultado se bem-sucedido:
{"status":"1","result":true} - o usuário foi adicionado à sua lista de todos os participantes
Se mal-sucedido:
{'status': '0', 'error': 'Missing required variables - email'} - o e-mail não foi fornecido e não foi encontrado na variável email.
Como registrar um participante em um webinar
É obrigatório solicitar o e-mail do cliente para que o registro ocorra. Qualquer outra coisa é opcional.
A função myownconference_add_user_to_webinar(webinar_id, email), onde
webinar_id - o id do webinar, ou, em outras palavras, o valor “alias” da requisição ao pesquisar o webinar
email - o endereço de e-mail do usuário; se não for fornecido, será usado o e-mail da variável email, se houver
O resultado se bem-sucedido:
{"status":"1","result":true} - o usuário foi registrado no webinar
Se mal-sucedido:
{"status":"0","error":"Webinar with alias "serg-dhpq-mznf-fwcb" not active"}