MENÚ

Automatice las operaciones internas con la colaboración API

Tabla de contenido

Cooperación API

Al utilizar la API de Chat&Messenger, puede vincularse fácilmente con sistemas y programas externos.
La integración API permite el siguiente procesamiento.

  • Se vincula con el sistema interno y notifica los datos comerciales a la sala de chat.
  • Detectar errores del sistema y notificar a partes relacionadas
  • Enlace de conferencia web desde software colaborativo interno
  • Obtenga información sobre horarios y reservas de salas de conferencias y vincúlelos con otros sistemas
La integración de API requiere un plan Enterprise o superior tanto para la nube como para las instalaciones.

Token API e interfaz API

Obtención de un Token API desde la pantalla de gestión

Al realizar la integración de API, primero obtenga un token de API.

Maneje el token API con cuidado, ya que es lo mismo que una contraseña.

Pase el apiToken / serverURL obtenido a JavaScript / curl como se describe en "Interfaz API" a continuación.

interfaz API

La línea de comando JavaScript/curl se puede utilizar como interfaz API. Los dos ejemplos siguientes pueden obtener información de registro de la sala de conferencias en formato JSON.

javascript

let config = { "apiToken": "QIQVOSvRJHrQElDwj20x******", "serverURL": "https://******************" } let client = nuevo CAMAPIClient(config);let respuesta = esperar client.getConferenceRooms();

línea de comando curl

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

*La URL del servidor para el entorno local es el puerto HTTP 8080.

Cualquier programa de acceso HTTP

También se puede vincular con cualquier programa de acceso HTTP.

Pantalla de muestra de API

Hay una URL de muestra donde puede probar fácilmente la ejecución de la API. Si desea utilizarlo para realizar pruebas, contáctenos desde el formulario de consulta.

API

* Planeado expandirse en etapas a partir de artículos con alto uso.

enviar mensaje

Enviar un mensaje.

muestra

  • Enviar especificando el ID de usuario en Messenger
    let respuesta = await getAPIClient().sendMessage( "messenger", // Especifica un mensaje directo con messenger "¡Hola!", // Mensaje para enviar falso, // Sobre desactivado ["user1@xxx.com", "user2@ xxx.com"] // Dirección de correo electrónico de destino);
    
    curl -H "x-cam-apiToken:token******" -d message="{\"panelName\":\"messenger\",\"message\":\"Hola\",\" isOpened\":false,\"generalPurposes\":{\"usuarios\":\"usuario1@xxx.com,usuario2@xxx.com\"}}" ${serverURL}/sendMessage
    
  • Especificar sala de chat y enviar
    let respuesta = await getAPIClient().sendMessage( "Nombre de la habitación", "¡Hola!", false, ["usuario1@xxx.com", "usuario2@xxx.com"] // Especifique la dirección de correo electrónico como mención);
    
    curl -H "x-cam-apiToken:token******" -d message="{\"panelName\":\"Nombre de la habitación\",\"message\":\"Hola\",\ "isOpened\":false,\"generalPurposes\":{\"usuarios\":\"usuario1@xxx.com,usuario2@xxx.com\"}}" ${serverURL}/sendMessage
    

argumento

enviar
  • Especificar el destino de envío
  • Para Messenger, especifique Messenger; para chat, especifique el nombre de la sala
usuarios
  • Si el envío es messenger, al usuario de destino. En el caso de una sala de chat, se le notificará mediante una mención después de compartir todo.
  • Busque el usuario correspondiente por dirección de correo electrónico
  • Al enviar varios correos electrónicos, especifique como delimitador de correo electrónico.
mensaje
  • Especifica el mensaje a enviar
  • Si desea que el texto se rompa en una nueva línea, inserte el código de salto de línea \n.
sello
  • Especifique verdadero/falso. Enviar con recibo de lectura

enviar mensajes

Envíe mensajes de forma masiva desde un archivo json.

Guarde el archivo json con el código de carácter UTF8.

muestra

  • línea de comando curl
    curl -H "x-cam-apiToken:token******" -d @messages.json ${serverURL}/sendMessages
    
  • Ejemplo de archivo message.json al enviar por mensaje directo
    mensajes=[ {"message":"Hola 1","property":{"usuarios":"user1@test.com,user2@test.com"}}, {"message":"Hola 2","propiedad ":{"usuarios":"usuario1@test.com,usuario2@test.com"}}, {"message":"Hola 3","property":{"usuarios":"usuario1@test.com,usuario2 @test.com"}}, {"message":"Hola 4","property":{"usuarios":"user1@test.com,user2@test.com"}}, ]
    
  • Archivo de mensajes.json de muestra al enviarlo a todos los participantes en la prueba de la sala de chat
    mensajes=[ {"enviar": "prueba", "mensaje": "Prueba 1"} ]
    

crearQuickCall

conferencia web rápida Crea una URL.

muestra

  • Cree una URL de reunión rápida.
    let respuesta = await getAPIClient().createQuickCall( 1624368868714, // Fecha límite de la reunión rápida (UnixTime mm) "contraseña!", // Especifique la contraseña de la reunión rápida);
    

argumento

Fecha de vencimiento
  • Especifique la fecha límite para una reunión rápida (milímetros UnixTime)
contraseña
  • Especificar contraseña de reunión rápida
  • Si se deja en blanco, se creará una URL de reunión sin contraseña.

actualizarChatRoom

Crear/actualizar sala de chat

muestra

let chatRoom = { "id":"1564831284702237059", "name":"Reunión secreta" "createUserId":"11u1pu9d32p8vuvjoZdd", "adminUserId":"11u1pu9d32p8vuvjoZdd", "isMessageThread":true, "isPublic":false, "memberUids }, } let respuesta = await getAPIClient().updateChatRoom(chatRoom); let errores = respuesta['errores']; if (errores) { console.log(errors); return; } console.log(respuesta["chatRoom" ]);

argumento

sala de chat
  • JSON para crear/actualizar sala de chat
  • No se requiere identificación si es nuevo.

obtenerConferenceMaster

Obtenga la lista maestra de salas de conferencias.

muestra

Obtenga la lista maestra de salas de conferencias

let respuesta = espera getAPIClient().getConferenceMaster(); let errores = respuesta['errores']; if (errores) { console.log(errors); return; } console.log(respuesta["conferenceRooms"]);

argumento

ninguno

obtener estado de la sala de conferencias

Obtener una lista del estado de la reserva de la sala de conferencias

muestra

let respuesta = await getAPIClient().getConferenceRoomStatus("201908"); let errores = respuesta['errores']; if (errores) { console.log(errors); return; } console.log(respuesta["conferenceRoomStatus"] );

argumento

aaaaMMdd
  • Si no se especifica ningún argumento, se obtiene una lista maestra de salas de conferencias.
  • Si ingresa el mes o fecha en el argumento aaaaMMdd, podrá obtener el estado de la reserva de la sala de conferencias correspondiente. Ejemplo) 201908 o 20190801
  • Las reservas se almacenan en ConferenceRooms.reservedSchedules.
  • URLをコピーしました!
Tabla de contenido