एपीआई सहयोग
चैट और मैसेंजर एपीआई का उपयोग करके, आप आसानी से बाहरी सिस्टम और प्रोग्राम से लिंक कर सकते हैं।
एपीआई एकीकरण निम्नलिखित प्रसंस्करण को सक्षम बनाता है।
- आंतरिक सिस्टम से लिंक करता है और व्यावसायिक डेटा को चैट रूम में सूचित करता है
- सिस्टम त्रुटियों का पता लगाएं और संबंधित पक्षों को सूचित करें
- इन-हाउस ग्रुपवेयर से वेब कॉन्फ्रेंस लिंकेज
- शेड्यूल और सम्मेलन कक्ष आरक्षण की जानकारी प्राप्त करें और अन्य प्रणालियों से लिंक करें
एपीआई टोकन और एपीआई इंटरफ़ेस
प्रबंधन स्क्रीन से एपीआई टोकन प्राप्त करना
एपीआई एकीकरण करते समय, पहले एक एपीआई टोकन प्राप्त करें।
कृपया प्राप्त एपीआईटोकन/सर्वरयूआरएल को नीचे दिए गए "एपीआई इंटरफ़ेस" में बताए अनुसार जावास्क्रिप्ट/कर्ल में पास करें।
एपीआई इंटरफ़ेस
API インターフェイスとして、JavaScript / curl コマンドライン / 任意のHTTPアクセスプログラムが利用できます。以下のサンプルは共に、会議室の登録情報をJSON形式で取得する事ができます。
ऐसे वातावरण में जहां नियमित एसएसएल लागू नहीं होता है, सर्वरयूआरएल HTTP 8080 पोर्ट होगा।
जावास्क्रिप्ट
let config = {
"apiToken": "QIQVOSvRJHrQElDwj20x******",
"serverURL": "https://*****************"
}
let client = new CAMAPIClient(config);
let response = await client.getConferenceRooms();कर्ल कमांड लाइन
curl -H "x-cam-apiToken:token******" ${serverURL}/getConferenceRoomsकोई भी HTTP एक्सेस प्रोग्राम
इसे किसी HTTP एक्सेस प्रोग्राम से भी जोड़ा जा सकता है।
एपीआई नमूना स्क्रीन
एक नमूना यूआरएल है जहां आप आसानी से एपीआई निष्पादन का प्रयास कर सकते हैं। यदि आप इसे परीक्षण के लिए उपयोग करना चाहते हैं, तो कृपया पूछताछ फ़ॉर्म से हमसे संपर्क करें।
संदेश एपीआई
मेसेज भेजें
एक संदेश भेजो।
नमूना
मैसेंजर में यूजर आईडी निर्दिष्ट करके भेजें
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"}
]कॉल एपीआई
त्वरित वेब सम्मेलन एक यूआरएल बनाएं.
त्वरित कॉल बनाएं
नमूना
let response = await getAPIClient().createQuickCall(
1624368868714, // クイック会議の期限(UnixTimeミリ)
"password!", // クイック会議のパスワードを指定
);तर्क
| अवधि समाप्त तारीख | त्वरित बैठक के लिए समय सीमा निर्दिष्ट करें (यूनिक्सटाइम मिलीमीटर) |
| title | 会議画面に表示されるタイトルを設定 ※ ブランクの場合は、表示されない |
| पासवर्ड | त्वरित मीटिंग पासवर्ड निर्दिष्ट करें ※ ブランクの場合は、パスワード無しの会議URLが作成される |
レスポンス
| sid | Web会議ID |
| url | Web会議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
);तर्क
| roomName | Web会議のIDを指定、クイック会議の場合はSID |
レスポンス
| roomName | Web会議ID |
| title | Web会議件名 |
| creationDate | 作成日時 |
| अवधि समाप्त तारीख | 有効期限 |
| participants | 現在の参加者数 |
| inProgress | 会議が進行中の場合は true、そうでない場合は false |
उपयोगकर्ता एपीआई
उपयोगकर्ता API केवल कर्ल कमांड प्रदान करता है। इसे चलाने के लिए आपको प्रशासकीय विशेषाधिकारों की भी आवश्यकता होगी।
निर्यातउपयोगकर्ता
उपयोगकर्ता जानकारी CSV प्रारूप में पथ द्वारा निर्दिष्ट स्थान पर डाउनलोड की जाएगी।
नमूना
curl -H "x-cam-apiToken:token******" -d "path=exportUsers.csv" ${serverURL}/exportUsersअपडेटयूजर्सCSV
CSV फ़ाइल से उपयोगकर्ता जानकारी को थोक में अपडेट करें. ※ संदर्भ सीएसवी प्रारूप
नमूना
curl -H "x-cam-apiToken:token******" -F "file=@updateUsers.csv" ${serverURL}/updateUsersCSVचैटरूम एपीआई
अपडेटचैटरूम
चैट रूम बनाएं/अपडेट करें
नमूना
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 |
|
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 | 管理者専用機能のため利用できない | この機能は管理者しか利用できません。 |
| 802 | API専用機能のため利用できない | この操作はAPIのみで利用可能です。 |
| 805 | APIトークン不正 | APIトークンが正しくありません。 |