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
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.
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.
En entornos donde no se aplica SSL normal, la URL del servidor será el puerto HTTP 8080.
javascript
let config = {
"apiToken": "QIQVOSvRJHrQElDwj20x******",
"serverURL": "https://*****************"
}
let client = new CAMAPIClient(config);
let response = await client.getConferenceRooms();línea de comando curl
curl -H "x-cam-apiToken:token******" ${serverURL}/getConferenceRoomsCualquier 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 de mensajes
enviar mensaje
Enviar un mensaje.
muestra
Enviar especificando el ID de usuario en Messenger
let response = await getAPIClient().sendMessage(
"messenger", // messenger を指定したダイレクトメッセージを指定
"Hello!", // 送信するメッセージ
false, // 封書は off
["user1@xxx.com", "user2@xxx.com"] // 宛先 Email アドレス
);curl -H "x-cam-apiToken:token******" -d message="{\"panelName\":\"messenger\",\"message\":\"Hello\",\"isOpened\":false,\"generalPurposes\":{\"users\":\"user1@xxx.com,user2@xxx.com\"}}" ${serverURL}/sendMessageEspecificar sala de chat y enviar
let response = await getAPIClient().sendMessage(
"ルーム名",
"Hello!",
false,
["user1@xxx.com", "user2@xxx.com"] // メンションとして Email アドレス指定
);curl -H "x-cam-apiToken:token******" -d message="{\"panelName\":\"ルーム名\",\"message\":\"Hello\",\"isOpened\":false,\"generalPurposes\":{\"users\":\"user1@xxx.com,user2@xxx.com\"}}" ${serverURL}/sendMessageargumento
| enviar |
|
| usuarios |
|
| mensaje |
|
| sello |
|
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
curl -H "x-cam-apiToken:token******" -d @messages.json ${serverURL}/sendMessages messages=[
{"message":"こんにちは 1","property":{"users":"user1@test.com,user2@test.com"}},
{"message":"こんにちは 2","property":{"users":"user1@test.com,user2@test.com"}},
{"message":"こんにちは 3","property":{"users":"user1@test.com,user2@test.com"}},
{"message":"こんにちは 4","property":{"users":"user1@test.com,user2@test.com"}},
]messages=[
{"send": "test", "message":"テスト 1"}
]Llamar a API
crearQuickCall
conferencia web rápida Crea una URL.
muestra
Crear URL de reunión rápida
let response = await getAPIClient().createQuickCall(
1624368868714, // クイック会議の期限(UnixTimeミリ)
"password!", // クイック会議のパスワードを指定
);argumento
| Fecha de vencimiento |
|
| contraseña |
|
API de usuario
La API de usuario solo proporciona el comando curl. También necesitarás privilegios de administrador para ejecutarlo.
Exportar usuarios
La información del usuario se descargará en formato CSV a la ubicación especificada por la ruta.
muestra
curl -H "x-cam-apiToken:token******" -d "path=exportUsers.csv" ${serverURL}/exportUsersactualizarUsuariosCSV
Actualice la información del usuario de forma masiva desde un archivo CSV. ※ referencia Formato CSV
muestra
curl -H "x-cam-apiToken:token******" -F "file=@updateUsers.csv" ${serverURL}/updateUsersCSVAPI de sala de chat
actualizarChatRoom
Crear/actualizar sala de chat
muestra
let chatRoom = {
"id":"1564831284702237059",
"name":"秘密会議"
"createUserId":"11u1pu9d32p8vuvjoZdd",
"adminUserId":"11u1pu9d32p8vuvjoZdd",
"isPublic":false,
"memberUids":{
"11u1pu9d32p8vuvjoZdd":true,
"1lmn7hoh3s1ja26fsazw":true,
"hhx10sfdv1jyou4la1ny":true,
"3400w9rfvs504c35dt99":true,
"309d32p8vuvjo5euuuwx":true
},
}
let response = await getAPIClient().updateChatRoom(chatRoom);
let errors = response['errors'];
if (errors) {
console.log(errors);
return;
}
console.log(response["chatRoom"]);argumento
| sala de chat |
|
API de programación
obtenerConferenceMaster
Obtenga la lista maestra de salas de conferencias.
muestra
let response = await getAPIClient().getConferenceMaster();
let errors = response['errors'];
if (errors) {
console.log(errors);
return;
}
console.log(response["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 response = await getAPIClient().getConferenceRoomStatus("201908");
let errors = response['errors'];
if (errors) {
console.log(errors);
return;
}
console.log(response["conferenceRoomStatus"]);argumento
| aaaaMMdd |
|