菜单
集成商务聊天、网络会议、日程安排、文档管理、工作流程和网络会议出席功能的组件 |
  1. 家
  2. 待遇
  3. 云移动
  4. 通过应用程序接口连接实现内部操作自动化。

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

云移动
目录

应用程序接口连接

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

  • 与内部系统连接，并将业务数据通知聊天室。
  • 发现系统错误并通知相关方。
  • 从内部群件连接网络会议
  • 获取日程安排和会议室预订信息，并与其他系统链接。
API 連携はクラウド Enterprise / オンプレミス Ultimate 以上のプランが必要です。

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

从管理屏幕获取 API 标记

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

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

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

应用程序接口

API インターフェイスとして、JavaScript / curl コマンドライン / 任意のHTTPアクセスプログラムが利用できます。以下のサンプルは共に、会議室の登録情報を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実行は Content-Type 表示渴望、喜欢、憎恨等的对象。 application/x-www-form-urlencoded とし、POSTで送信してください。

应用程序接口示例屏幕

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

消息 API

发送消息

发送信息

样品

用 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

参数

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

发送信息。

从 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"}
]

调用 API

快速网络会议 创建 URL。

创建快速呼叫

样品

let response = await getAPIClient().createQuickCall(
	1624368868714, 	// クイック会議の期限(UnixTimeミリ)
	"password!",  	// クイック会議のパスワードを指定
	);

参数

过期日期指定快速会议的截止时间（UnixTime 毫米
title会議画面に表示されるタイトルを設定
※ ブランクの場合は、表示されない
暗号为快速会议指定密码。
※ ブランクの場合は、パスワード無しの会議URLが作成される

レスポンス

sidWeb会議ID
urlWeb会議URL
presenterPass視聴のみモードの会議を生成した場合に、プレゼンターが必要になるパスワード

自動ログイン

createQuickCall で生成した会議URLに自動でログインするには、次のようにURLパラメータに userName、password を連結してアクセスしてください。

https://app.chat-messenger.com/share/{Web会議ID}?userName=太郎&password=000

getCallStats

Web会議の現在の参加者数などステータスを返却します。

样品

let response = await getAPIClient().getCallStats(
	8sQYFO2sPYHb7xSsibpVCKaqrFmTpCureVqKvwKgSZJs, 	// Web会議のID
	);

参数

roomNameWeb会議のIDを指定、クイック会議の場合はSID

レスポンス

roomNameWeb会議ID
titleWeb会議件名
creationDate作成日時
过期日期有効期限
participants現在の参加者数
inProgress会議が進行中の場合は true、そうでない場合は false

用户 API

用户 API 仅提供 curl 命令。您还需要管理员权限才能运行它。

导出用户

用户信息将以CSV格式下载到路径指定的位置。

样品

curl -H "x-cam-apiToken:token******" -d "path=exportUsers.csv" ${serverURL}/exportUsers

更新用户CSV

从 CSV 文件批量更新用户信息。 ※ 参考 CSV 格式

样品

curl -H "x-cam-apiToken:token******" -F "file=@updateUsers.csv" ${serverURL}/updateUsersCSV

聊天室 API

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"]);

参数

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

计划 API

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

API のエラー判定

API のエラー判定は、次の通り判定してください。

HTTPステータスが200以外

HTTPステータスが200以外の場合は、例外なくエラーです。

HTTPステータスが200だが、サーバでエラー

APIトークンが不正や、対象データが存在しない場合などは、HTTPステータスそのものは200で返却され、レスポンス中の status が 520 で判定可能です。また errors にはエラー原因の code と message が配列で格納されます。

{"status":520, "errors":[{"code":"805","message":"APIトークンが正しくありません"}]}

code の意味と、同時に返却される message の詳細は以下です。

code意味信息
400クライアント側の不正なリクエストこのリクエストは無効です。
405存在しないグループ–
406グループ変更ができない–
451ユーザが登録されていないユーザが登録されていません。先にユーザ登録してください。
※ユーザが自身で登録できる場合
452ユーザが登録されていないユーザが登録されていません。
490ログイン施行回数を超過したパスワード試行回数の上限に達しためログインできません。しばらく時間をおいてから再度お試しください。
491リクエスト回数が多すぎる–
500予期せぬサーバ起因のエラー–
503サービスが利用できない–
800管理者専用機能のため利用できないこの機能は管理者しか利用できません。
802API専用機能のため利用できないこの操作はAPIのみで利用可能です。
805APIトークン不正APIトークンが正しくありません。
云移动
  • URLをコピーしました！
目录