通过应用程序接口连接实现内部操作自动化。

2018 年 1 月 18 日。

应用程序接口连接

通过使用Chat&Messenger API，您可以轻松地与外部系统和程序链接。
应用程序接口连接可实现以下流程

与内部系统连接，并将业务数据通知聊天室。
发现系统错误并通知相关方。
从内部群件连接网络会议
获取日程安排和会议室预订信息，并与其他系统链接。

应用程序接口集成需要企业或更高级别的云计划和内部部署计划。

应用程序接口令牌和应用程序接口

从管理屏幕获取 API 标记

执行 API 链接时，首先要获取一个 API 令牌。

API 标记和密码一样，都应小心处理。

如下文 "API 接口 "所述，将获取的 apiToken / serverURL 传递给 JavaScript / curl。

应用程序接口

JavaScript / curl 命令行可作为 API 接口使用。以下两个示例都可以检索 JSON 格式的会议室注册信息。

JavaScript

让 config = {
"apiToken": "QIQVOSvRJHrQElDwj20x******",.
"serverURL": "https://*****************"
}
let client = new CAMAPIClient(config);.
let response = await client.getConferenceRooms();.

curl 命令行

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

内部环境的服务器 URL 是 HTTP 8080 端口。

任何 HTTP 访问程序

任何 HTTP 访问程序也都可以连接。

应用程序接口示例屏幕

为方便测试 API 的执行情况，我们提供了一个 URL 样本。如果您想使用它进行测试，请通过 "联系我们 "与我们联系。

应用程序接口

应用程序的数量将分阶段增加，首先从使用率高的应用程序开始。

发送消息

发送信息

样品

用 Messenger 中的用户 ID 发送。

let response = await getAPIClient().sendMessage().
"信使", // 指定信使的直接消息
"Hello!", // 要发送的消息
false, // 信封已关闭。
["user1@xxx.com", "user2@xxx.com"] // 目标电子邮件地址
);

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"] // 指定为提及的电子邮件地址。
);

curl -H "x-cam-apiToken:token******" -d message="{\"panelName\":\"roomName\",\"message\":\"Hello\",\"isOpened\":false,\"generalPurposes\${serverURL}/sendMessage

参数

发送	指定传输目标对于信使，请指定信使；对于聊天，请指定聊天室名称。
用户	如果发送的是信使，则发送给目的地用户。如果是聊天室，Mention 会共享和通知整个聊天室。通过电子邮件地址搜索相关用户对于多路传输，请指定，作为电子邮件分隔符。
信息	指定要发送的信息要换行，请插入换行代码（\n）。
封条	真/假。与开箱确认一起发送。

发送信息。

从 json 文件批量发送信息。

json 文件应以 UTF8 编码保存。

样品

curl 命令行

curl -H "x-cam-apiToken:token******" -d @messages.json ${serverURL}/sendMessages

用于直接发送信息的 messages.json 文件示例

messages=[[.
 {"message": "hello 1", "property":{"users": "user1@test.com,user2@test.com"}},.
 {"message": "hello 2", "property":{"users": "user1@test.com,user2@test.com"}},.
 {"消息": "hello 3", "属性":{"用户": "user1@test.com,user2@test.com"}}, {"消息": "hello 3", "属性":{"用户": "user1@test.com,user2@test.com"}}.
 {"消息": "hello 4", "属性":{"用户": "user1@test.com,user2@test.com"}}
]

用于发送给聊天室测试所有参与者的 messages.json 文件示例
```
messages=[[.
  {"发送": "测试", "消息": "测试 1"}.
]
```

创建快速呼叫

快速网络会议创建 URL。

样品

创建快速会议 URL。

let response = await getAPIClient().createQuickCall().
1624368868714，//快速会议截止时间（UnixTime 毫米）
"password!", // 快速会议密码（UnixTime mm.
);

参数

过期日期	指定快速会议的截止时间（UnixTime 毫米
暗号	为快速会议指定密码。如果为空，则创建不带密码的会议 URL。

updateChatRoom.

创建和更新聊天室

样品

让 chatRoom = {
   "id": "1564831284702237059",.
   "name": "Secret meeting".
   "createUserId": "11u1pu9d32p8vuvjoZdd",.
   "adminUserId": "11u1pu9d32p8vuvjoZdd",.
   "isMessageThread":true,.
   "isPublic":false,.
   "memberUids":{
      "11u1pu9d32p8vuvjoZdd":true, "memberUids":{
      "1lmn7hoh3s1ja26fsazw":false, "memberUids":{ "1lmn7hoh3s1ja26fsazw":false, "memberUids".
      
      
      "309d32p8vuvjo5euuuwx":false
   },
}
let response = await getAPIClient().updateChatRoom(chatRoom);.
let errors = response['errors']；
if (errors) {
console.log(errors)；
返回；
}
console.log(response["chatRoom"]);.

参数

聊天室	创建和更新聊天室 JSON 新案件不需要 ID

getConferenceMaster.

检索会议室总清单。

样品

获取会议室总清单

let response = await getAPIClient().getConferenceMaster()；
let errors = response['errors']；
if (errors) {
console.log(errors)；
返回；
}
console.log(response["conferenceRooms"]);.

参数

不带

getConferenceRoomStatus.

获取会议室预订清单

样品

let response = await getAPIClient().getConferenceRoomStatus("201908")；
let errors = response['errors']；
if (errors) {
console.log(errors)；
返回；
}
console.log(response["conferenceRoomStatus"]);.

参数

yyyyMMdd

如果没有指定参数，则会获得会议室的主列表。
如果参数 yyyyMMdd 是月份或日期，则可检索相应会议室的预订状态。例如）201908 或 20190801
预订状态存储在 conferenceRooms.reservedSchedules 中。

URLをコピーしました！