目录
应用程序接口连接
通过使用Chat&Messenger API，您可以轻松地与外部系统和程序链接。
应用程序接口连接可实现以下流程
- 与内部系统连接，并将业务数据通知聊天室。
- 发现系统错误并通知相关方。
- 从内部群件连接网络会议
- 获取日程安排和会议室预订信息，并与其他系统链接。
应用程序接口集成需要企业或更高级别的云计划和内部部署计划。
应用程序接口令牌和应用程序接口
从管理屏幕获取 API 标记
执行 API 链接时，首先要获取一个 API 令牌。
API 标记和密码一样，都应小心处理。
如下文 "API 接口 "所述，将获取的 apiToken / serverURL 传递给 JavaScript / curl。
应用程序接口
JavaScript / curl 命令行可作为 API 接口使用。以下两个示例都可以检索 JSON 格式的会议室注册信息。
在不应用常规 SSL 的环境中，serverURL 将是 HTTP 8080 端口。
JavaScript
let config = {
"apiToken": "QIQVOSvRJHrQElDwj20x******",
"serverURL": "https://*****************"
}
let client = new CAMAPIClient(config);
let response = await client.getConferenceRooms();curl 命令行
curl -H "x-cam-apiToken:token******" ${serverURL}/getConferenceRooms任何 HTTP 访问程序
任何 HTTP 访问程序也都可以连接。
应用程序接口示例屏幕
为方便测试 API 的执行情况，我们提供了一个 URL 样本。如果您想使用它进行测试，请通过 "联系我们 "与我们联系。
应用程序接口
应用程序的数量将分阶段增加，首先从使用率高的应用程序开始。
发送消息
发送信息
样品
用 Messenger 中的用户 ID 发送。
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}/sendMessage通过指定聊天室发送
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}/sendMessage参数
| 发送 |
|
| 用户 |
|
| 信息 |
|
| 封条 |
|
发送信息。
从 json 文件批量发送信息。
json 文件应以 UTF8 编码保存。
样品
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"}
]创建快速呼叫
快速网络会议 创建 URL。
样品
创建快速会议 URL
let response = await getAPIClient().createQuickCall(
1624368868714, // クイック会議の期限(UnixTimeミリ)
"password!", // クイック会議のパスワードを指定
);参数
| 过期日期 |
|
| 暗号 |
|
updateChatRoom.
创建和更新聊天室
样品
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"]);参数
| 聊天室 |
|
getConferenceMaster.
检索会议室总清单。
样品
let response = await getAPIClient().getConferenceMaster();
let errors = response['errors'];
if (errors) {
console.log(errors);
return;
}
console.log(response["conferenceRooms"]);参数
不带
getConferenceRoomStatus.
获取会议室预订清单
样品
let response = await getAPIClient().getConferenceRoomStatus("201908");
let errors = response['errors'];
if (errors) {
console.log(errors);
return;
}
console.log(response["conferenceRoomStatus"]);参数
| yyyyMMdd |
|