CARDÁPIO

Automatize operações internas com colaboração de API

índice

Cooperação de APIs

Ao usar a API Chat&Messenger, você pode conectar-se facilmente a sistemas e programas externos.
A integração da API permite o seguinte processamento.

  • Vincula-se ao sistema interno e notifica os dados comerciais para a sala de bate-papo
  • Detecte erros do sistema e notifique as partes relacionadas
  • Vinculação de webconferência a partir de groupware interno
  • Obtenha informações de agendamento e reserva de salas de conferência e conecte-se a outros sistemas
A integração de API requer um plano Enterprise ou superior para nuvem e local.

Token de API e interface de API

Obtendo um token de API na tela de gerenciamento

Ao realizar a integração da API, primeiro obtenha um token de API.

Manuseie o token da API com cuidado, pois ele é igual a uma senha.

Passe o apiToken/serverURL obtido para JavaScript/curl conforme descrito em "Interface API" abaixo.

Interface API

A linha de comando JavaScript/curl pode ser usada como uma interface API. Ambos os exemplos abaixo podem obter informações de registro de sala de conferência no formato JSON.

JavaScript

deixe config = { "apiToken": "QIQVOSvRJHrQElDwj20x******", "serverURL": "https://*******************" } deixe cliente = novo CAMAPIClient(config); deixe resposta = aguardar client.getConferenceRooms();

linha de comando curl

curl -H "x-cam-apiToken:token******" ${serverURL}/getConferenceRooms

*A URL do servidor para ambiente local é a porta HTTP 8080.

Qualquer programa de acesso HTTP

Também pode ser vinculado a qualquer programa de acesso HTTP.

Tela de amostra da API

Há um URL de exemplo onde você pode testar facilmente a execução da API. Se desejar usá-lo para testes, entre em contato conosco através do formulário de consulta.

API

* Planejado para expandir em etapas a partir de itens com alto uso.

enviar mensagem

Envie uma mensagem.

amostra

  • Envie especificando o ID do usuário no Messenger
    let response = await getAPIClient().sendMessage( "messenger", // Especifique uma mensagem direta com o messenger "Hello!", // Mensagem para enviar false, // Envelope off ["user1@xxx.com", "user2@ xxx.com"] // Endereço de e-mail de destino);
    
    curl -H "x-cam-apiToken:token******" -d mensagem="{\"panelName\":\"messenger\",\"message\":\"Olá\",\" isOpened\":false,\"generalPurposes\":{\"users\":\"user1@xxx.com,user2@xxx.com\"}}" ${serverURL}/sendMessage
    
  • Especifique a sala de chat e envie
    let response = await getAPIClient().sendMessage( "Room name", "Hello!", false, ["user1@xxx.com", "user2@xxx.com"] // Especifique o endereço de e-mail como menção);
    
    curl -H "x-cam-apiToken:token******" -d mensagem="{\"panelName\":\"Nome da sala\",\"message\":\"Olá\",\ "isOpened\":false,\"generalPurposes\":{\"users\":\"user1@xxx.com,user2@xxx.com\"}}" ${serverURL}/sendMessage
    

argumento

enviar
  • Especifique o destino de envio
  • Para messenger, especifique messenger; para chat, especifique o nome da sala
Usuários
  • Se o envio for messenger, para o usuário de destino. No caso de uma sala de chat, você será notificado por menção após compartilhar tudo.
  • Procure o usuário correspondente por endereço de e-mail
  • Ao enviar vários emails, especifique , como delimitador de email.
mensagem
  • Especifique a mensagem a ser enviada
  • Se quiser que o texto seja quebrado em uma nova linha, insira o código de quebra de linha \n.
selo
  • Especifique verdadeiro/falso. Enviar com recibo de leitura

enviar mensagens

Envie mensagens em massa a partir de um arquivo json.

Salve o arquivo JSON no código de caracteres UTF8.

amostra

  • linha de comando curl
    curl -H "x-cam-apiToken:token******" -d @messages.json ${serverURL}/sendMessages
    
  • Exemplo de arquivo messages.json ao enviar via mensagem direta
    mensagens=[ {"message":"Olá 1","property":{"users":"user1@test.com,user2@test.com"}}, {"message":"Olá 2","property ":{"users":"user1@test.com,user2@test.com"}}, {"message":"Olá 3","property":{"users":"user1@test.com,user2 @test.com"}}, {"message":"Olá 4","property":{"users":"user1@test.com,user2@test.com"}}, ]
    
  • Exemplo de arquivo messages.json ao enviar para todos os participantes do teste da sala de chat
    mensagens=[ {"enviar": "teste", "mensagem":"Teste 1"} ]
    

criarQuickCall

webconferência rápida Crie um URL.

amostra

  • Crie um URL de reunião rápido.
    let response = await getAPIClient().createQuickCall( 1624368868714, // Prazo da reunião rápida (UnixTime mm) "password!", // Especifique a senha da reunião rápida );
    

argumento

data expirada
  • Especifique o prazo para uma reunião rápida (UnixTime milímetros)
senha
  • Especifique a senha da reunião rápida
  • Se deixado em branco, será criada uma URL de reunião sem senha.

atualizarChatRoom

Criar/atualizar sala de chat

amostra

deixe chatRoom = { "id":"1564831284702237059", "name":"Reunião secreta" "createUserId":"11u1pu9d32p8vuvjoZdd", "adminUserId":"11u1pu9d32p8vuvjoZdd", "isMessageThread":true, "isPublic":false, "memberUids }, } deixe resposta = aguarde getAPIClient().updateChatRoom(chatRoom); deixe erros = resposta['erros']; if (erros) { console.log(erros); return; } console.log(response["chatRoom" ]);

argumento

sala de bate-papo
  • JSON para criar/atualizar sala de chat
  • id não é necessário se for novo

getConferenceMaster

Obtenha a lista mestre de salas de conferência.

amostra

Obtenha a lista mestre de salas de conferência

deixe resposta = aguarde getAPIClient().getConferenceMaster(); deixe erros = resposta['erros']; if (erros) { console.log(erros); return; } console.log(response["conferenceRooms"]);

argumento

nenhum

getConferenceRoomStatus

Obtenha uma lista do status de reserva de salas de conferência

amostra

deixe resposta = aguarde getAPIClient().getConferenceRoomStatus("201908"); deixe erros = resposta['erros']; if (erros) { console.log(erros); return; } console.log(response["conferenceRoomStatus"] );

argumento

aaaaMMdd
  • Se nenhum argumento for especificado, será obtida uma lista mestre de salas de conferência.
  • Se você inserir o mês ou a data no argumento yyyyMMdd, poderá obter o status da reserva da sala de conferência correspondente. Exemplo) 201908 ou 20190801
  • As reservas são armazenadas em ConferenceRooms.reservedSchedules.
  • URLをコピーしました!
índice