MENU

Automatisez les opérations internes avec la collaboration API

table des matières

Coopération API

En utilisant l'API Chat&Messenger, vous pouvez facilement vous connecter à des systèmes et programmes externes.
L'intégration de l'API permet le traitement suivant.

  • Se connecte au système interne et notifie les données de l'entreprise au salon de discussion
  • Détecter les erreurs du système et informer les parties liées
  • Lien vers des conférences Web à partir d'un logiciel de groupe interne
  • Obtenez des informations sur les horaires et les réservations de salles de conférence et établissez des liens avec d'autres systèmes.
L'intégration d'API nécessite un plan Cloud Enterprise ou On-Premises Ultimate ou supérieur.

Jeton API et interface API

Obtention d'un jeton API depuis l'écran de gestion

Lors de l'intégration de l'API, obtenez d'abord un jeton API.

Veuillez transmettre l'apiToken/serverURL obtenu à JavaScript/curl comme décrit dans « Interface API » ci-dessous.

Veuillez manipuler le jeton API avec précaution car il est identique à un mot de passe.

Interface API

API インターフェイスとして、JavaScript / curl コマンドライン / 任意のHTTPアクセスプログラムが利用できます。以下のサンプルは共に、会議室の登録情報をJSON形式で取得する事ができます。

Dans les environnements où SSL standard n'est pas appliqué, l'URL du serveur sera le port HTTP 8080.

Javascript

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

ligne de commande curl

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

Tout programme d'accès HTTP

Il peut également être lié à n’importe quel programme d’accès HTTP.

Exemple d'écran d'API

Il existe un exemple d'URL où vous pouvez facilement tester l'exécution de l'API. Si vous souhaitez l'utiliser pour des tests, veuillez nous contacter à partir du formulaire de demande.

API de messagerie

envoyer le message

Envoyer un message.

échantillon

Envoyer en spécifiant l'ID utilisateur dans 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}/sendMessage
Spécifiez la salle de discussion et envoyez
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

argument

envoyer
  • Spécifier la cible d'envoi
  • Pour Messenger, spécifiez Messenger ; pour Chat, spécifiez le nom de la salle.
utilisateurs
  • Si l'envoi est Messenger, à l'utilisateur de destination. Dans le cas d'un salon de discussion, vous serez averti par mention après avoir partagé le tout.
  • Rechercher l'utilisateur correspondant par adresse email
  • Lors de l'envoi de plusieurs e-mails, spécifiez , comme délimiteur d'e-mail.
message
  • Précisez le message à envoyer
  • Si vous souhaitez que le texte soit interrompu sur une nouvelle ligne, insérez le code de saut de ligne \n.
joint
  • Précisez vrai/faux. Envoyer avec accusé de lecture

envoyer des messages

Envoyez des messages en masse à partir d'un fichier json.

Veuillez enregistrer le fichier json dans le code de caractère UTF8.

échantillon

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

Appeler l'API

conférence Web rapide Créez une URL.

créer un appel rapide

échantillon

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

argument

date d'expirationSpécifiez la date limite pour une réunion rapide (millimètres UnixTime)
title会議画面に表示されるタイトルを設定
※ ブランクの場合は、表示されない
mot de passeSpécifier le mot de passe de la réunion rapide
※ ブランクの場合は、パスワード無しの会議URLが作成される

レスポンス

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

自動ログイン

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

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

getCallStats

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

échantillon

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

argument

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

レスポンス

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

API utilisateur

L'API utilisateur fournit uniquement la commande curl. Vous aurez également besoin de privilèges d’administrateur pour l’exécuter.

exportUtilisateurs

Les informations utilisateur seront téléchargées au format CSV à l’emplacement spécifié par le chemin.

échantillon

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

updateUsersCSV

Mettre à jour les informations utilisateur en masse à partir d'un fichier CSV. ※ référence Format CSV

échantillon

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

API de salle de discussion

mettre à jourChatRoom

Créer/mettre à jour une salle de discussion

échantillon

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

argument

tchat
  • JSON pour créer/mettre à jour une salle de discussion
  • l'identifiant n'est pas requis si nouveau

API de planification

getConferenceMaster

Obtenez la liste principale des salles de conférence.

échantillon

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

argument

aucun

getConferenceRoomStatus

Obtenir une liste des statuts de réservation de salles de conférence

échantillon

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

argument

aaaaMMjj
  • Si aucun argument n'est spécifié, une liste principale des salles de conférence est obtenue.
  • Si vous saisissez le mois ou la date dans l'argument aaaaMMjj, vous pourrez obtenir le statut de réservation de la salle de conférence correspondante. Exemple) 201908 ou 20190801
  • Les réservations sont stockées dans 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意味message
400クライアント側の不正なリクエストこのリクエストは無効です。
405存在しないグループ
406グループ変更ができない
451ユーザが登録されていないユーザが登録されていません。先にユーザ登録してください。
※ユーザが自身で登録できる場合
452ユーザが登録されていないユーザが登録されていません。
490ログイン施行回数を超過したパスワード試行回数の上限に達しためログインできません。しばらく時間をおいてから再度お試しください。
491リクエスト回数が多すぎる
500予期せぬサーバ起因のエラー
503サービスが利用できない
800管理者専用機能のため利用できないこの機能は管理者しか利用できません。
802API専用機能のため利用できないこの操作はAPIのみで利用可能です。
805APIトークン不正APIトークンが正しくありません。
  • URLをコピーしました!
table des matières