प्रमाणीकरण
कनेक्शन एपीआई बियरर टोकन प्रमाणीकरण का उपयोग करता है। सभी अनुरोधों में ऑथराइजेशन हेडर में एक वैध JWT एक्सेस टोकन शामिल होना चाहिए।
एक टोकन प्राप्त करें
अपने क्रेडेंशियल को ऑथेंटिकेशन एंडपॉइंट पर POST करें। आपको एक अल्पकालिक एक्सेस_टोकन और एक दीर्घकालिक रिफ्रेश_टोकन प्राप्त होगा।
टोकन का उपयोग करें
प्रत्येक अनुरोध में टोकन शामिल करें:
{
"email": "admin@yourorg.com",
"password": "••••••••"
}{
"access_token": "eyJhbG...",
"refresh_token": "dGhpcw...",
"expires_in": 3600,
"token_type": "Bearer"
}बेस यूआरएल और वर्ज़निंग
सभी API एंडपॉइंट्स को /api/v1/ के अंतर्गत वर्शन किया जाता है। बेस URL आपके डिप्लॉयमेंट पर निर्भर करता है।
क्लाउड-होस्टेड डिप्लॉयमेंट के लिए, अपने संगठन को आवंटित क्षेत्रीय एंडपॉइंट का उपयोग करें। ऑन-प्रिमाइसेस सर्वर डिप्लॉयमेंट के लिए, अपने सर्वर के होस्टनेम का उपयोग करें।
| पर्यावरण | बेस यूआरएल |
|---|---|
| क्लाउड (यूएस) | https://beta.connection.app/api/v1 |
| -परिसर में | https://<your-server>/api/v1 |
सभी अनुरोध और प्रतिक्रिया निकायों में application/json का उपयोग किया जाता है। बॉडी वाले अनुरोधों में Content-Type: application/json शामिल करें।
त्रुटियाँ और स्थिति कोड
यह एपीआई मानक HTTP स्टेटस कोड का उपयोग करता है। त्रुटि प्रतिक्रियाओं में मशीन-पठनीय कोड और मानव-पठनीय संदेश शामिल होते हैं।
| स्थिति | अर्थ |
|---|---|
| 200 | सफलता |
| 201 | बनाया था |
| 400 | अनुरोध गलत है — अमान्य पैरामीटर |
| 401 | अनधिकृत — टोकन गुम या समाप्त हो चुका है |
| 403 | निषिद्ध — अपर्याप्त अनुमतियाँ |
| 404 | नहीं मिला |
| 500 | आंतरिक सर्वर त्रुटि |
{
"error": {
"code": "device_not_found",
"message": "No device with that UUID exists in your organization",
"status": 404
}
}REST API का अवलोकन
कनेक्शन सर्वर REST API आपके डिवाइस फ्लीट, संचार अवसंरचना और एनालिटिक्स तक पूर्ण प्रोग्रामेटिक पहुंच प्रदान करता है। यह JSON अनुरोध/प्रतिक्रिया निकायों के साथ RESTful नियमों का पालन करता है।
प्रमाणीकरण
टोकन-आधारित प्रमाणीकरण। लॉगिन करने पर एक टोकन प्राप्त होता है जिसे प्राधिकरण: टोकन के रूप में भेजा जाना चाहिए।<token> इसके बाद के सभी अनुरोधों पर।
उपयोगकर्ताओं
उपयोगकर्ता खाते बनाएं और प्रबंधित करें। GET /users/user एंडपॉइंट वर्तमान में प्रमाणित उपयोगकर्ता को लौटाता है।
उपकरण
डिवाइसों की सूची बनाएं और उनकी जांच करें, उपयोगकर्ता-डिवाइस संबंधों को प्रबंधित करें, प्रति-डिवाइस सेटिंग्स और स्थिति को पढ़ें और लिखें, फर्मवेयर और स्टोरेज इमेज को संभालें, और लॉग और क्रैश रिपोर्ट प्राप्त करें।
सीबीबीपी प्रॉक्सी
सर्वर के माध्यम से किसी भी डिवाइस को कोई भी CBBP कमांड भेजें। सर्वर कमांड को डिवाइस के वाईफाई कनेक्शन पर रिले करता है और डिवाइस से प्रतिक्रिया प्राप्त करता है। भेजी गई प्रतिक्रिया में एक CBBPMessage भी शामिल होता है जिसे डिवाइस तुरंत निष्पादित करता है।
अनुरोध निकाय एक CBBP कमांड लिफाफा है। संग्रहीत CBBPCommand ऑब्जेक्ट डिलीवरी स्थिति को ट्रैक करता है: UNSET → SENT → RECEIVED या TIMED_OUT।
{
"outgoingMessage": {
"command": "WiFiScan"
}
}{
"uuid": "a3f2...",
"status": "SENT",
"device": "d7f3a1b2-...",
"dateSent": "2025-09-15T14:22:01Z",
"outgoingMessage": { /* echoed */ },
"incomingMessage": null
}चैनल
चैनल संचार के मूल तत्व हैं। इनमें ChannelPeople, ChannelGroup, ChannelContact, ChannelContactNumber, ChannelExternalNumber, ChannelService और ChannelRecorder शामिल हैं।
संचार
सक्रिय संचार सत्रों को प्रारंभ और प्रबंधित करें — आउटगोइंग कॉल, वीसीपी, रिकॉर्डिंग और कंटेंट स्ट्रीमिंग। आउटगोइंग कॉल के जवाब में एक सीबीबीपी संदेश शामिल होता है जिस पर डिवाइस तुरंत कार्रवाई करता है।
ऑडियो ब्रिज
पूर्ण ट्रांसक्रिप्ट, प्रतिभागियों की सूची और AI द्वारा तैयार किए गए सारांश सहित रिकॉर्ड की गई ब्रिज वार्ताओं तक पहुंच प्राप्त करें। यह कई सारांश टेम्पलेट्स (मीटिंग नोट्स, क्लास नोट्स, स्वास्थ्य सेवा आदि) और सारांशों के लिए TTS ऑडियो जनरेशन का समर्थन करता है।
बात चिट
ChatGPT, Gemini या नेटिव इंजन का उपयोग करके AI-संचालित वार्तालाप सत्र। कई प्रकार के व्यक्तित्वों (डॉक्टर, ट्यूटर, मैकेनिक, आदि) और पृष्ठबद्ध संदेश इतिहास का समर्थन करता है।
सामग्री
डिवाइस पर स्ट्रीमिंग ऑडियो कंटेंट ब्राउज़ करें और चलाएं। कंटेंट को श्रेणी ट्री में व्यवस्थित किया गया है; लोकप्रिय कंटेंट को शहर, क्षेत्र या देश के अनुसार फ़िल्टर किया जा सकता है।
स्थानों
भौगोलिक निर्देशांकों को संरचित शहर, क्षेत्र और देश ऑब्जेक्ट में परिवर्तित करें। संदर्भ को ग्रहण करते समय उपकरणों द्वारा इसका उपयोग किया जाता है।
सूचनाएं धक्का
FCM पुश नोटिफिकेशन प्राप्त करने के लिए एक मोबाइल ऐप रजिस्टर करें। यह iOS, Android और वेब प्लेटफॉर्म को सपोर्ट करता है।
भंडारण
मॉडल ऑब्जेक्ट पर संग्रहीत फ़ाइलों को डाउनलोड करें, और छवि पृष्ठभूमि हटाने की प्रक्रिया चलाएं (यह बेस64-एन्कोडेड परिणाम लौटाता है)।
थोक संचालन
एक ही HTTP अनुरोध में कई API ऑपरेशन निष्पादित करें। सभी ऑपरेशनों को एक ही एटॉमिक ट्रांज़ैक्शन में शामिल करने के लिए single_transaction=true पास करें — किसी भी आइटम में विफलता होने पर पूरा बैच रोलबैक हो जाएगा।
दिनांक समय
यह सर्वर की वर्तमान तिथि और समय को GMT+0 प्रारूप में लौटाता है। इसके लिए प्रमाणीकरण की आवश्यकता नहीं है। इसका उपयोग उपकरणों द्वारा अपनी आंतरिक घड़ी को सिंक्रनाइज़ करने के लिए किया जाता है।
कॉम बैज बेसिक प्रोटोकॉल
CBBP एक हल्का JSON कमांड प्रोटोकॉल है जो कनेक्शन बैज के साथ सीधे इंटरैक्ट करने की सुविधा देता है। यह आपको डिवाइस पर मौजूद हर हार्डवेयर और सॉफ्टवेयर फ़ंक्शन पर पूरा नियंत्रण प्रदान करता है।
संदेश प्रारूप
प्रत्येक सीबीबीपी इंटरैक्शन में डिवाइस को भेजा गया एक कमांड संदेश और डिवाइस द्वारा लौटाया गया एक परिणाम संदेश शामिल होता है।
अनुरोध और प्रतिक्रिया दोनों में ऑब्जेक्ट फ़ील्ड कमांड-विशिष्ट डेटा रखता है और आवश्यकता न होने पर इसे छोड़ा जा सकता है।
{
"command": "command_name",
"object": {
// optional command parameters
}
}{
"result": 0, // 0 = success, -1 = error
"detail": "ok", // human-readable status
"object": { // optional response data
// command-specific fields
}
}परिवहन
आपके एकीकरण आर्किटेक्चर के आधार पर, CBBP संदेशों को तीन अलग-अलग ट्रांसपोर्ट के माध्यम से बैज तक पहुंचाया जा सकता है।
ब्लूटूथ (ऐप)
मोबाइल ऐप से सीधे BLE के माध्यम से CBBP कमांड भेजें। इसके लिए डिवाइस का पेयर होना और रेंज में होना आवश्यक है।
मोबाइल एसडीकेसर्वर के माध्यम से वाईफाई या ब्लूटूथ
REST API के माध्यम से प्रॉक्सी CBBP — POST /devices//cbbp। सर्वर स्वचालित रूप से डिवाइस से वाई-फाई या ब्लूटूथ के माध्यम से कनेक्ट हो जाता है, यह इस बात पर निर्भर करता है कि बैज कैसे कनेक्ट है। यह बैकएंड इंटीग्रेशन के लिए सबसे आम तरीका है।
रेस्ट एपीआईआंतरिक प्रेषण
ऑन-डिवाइस या इंटर-प्रोसेस सीबीबीपी डिस्पैच। इसका उपयोग बैज फर्मवेयर द्वारा आंतरिक सबसिस्टमों के बीच कमांड को रूट करने के लिए किया जाता है।
केवल फ़र्मवेयरशक्ति आदेश
डिवाइस की पावर स्थिति को नियंत्रित करें — स्लीप, वेक, रीबूट और फ़ैक्टरी रीसेट।
वाईफाई कमांड
वायरलेस नेटवर्क को कॉन्फ़िगर करें, एपी के लिए स्कैन करें, कनेक्शन की स्थिति जांचें और सहेजे गए क्रेडेंशियल प्रबंधित करें।
ब्लूटूथ कमांड
BLE विज्ञापन, पेयरिंग और बैज-टू-बैज संचार को नियंत्रित करें।
सेटिंग्स कमांड
डिवाइस कॉन्फ़िगरेशन को पढ़ें और लिखें — डिस्प्ले नाम, समय क्षेत्र, भाषा और फ़ीचर फ़्लैग।
फ़र्मवेयर कमांड
OTA फर्मवेयर अपडेट शुरू करें, अपडेट की स्थिति जांचें और डिवाइस पर वर्तमान फर्मवेयर संस्करण की जानकारी प्राप्त करें।
डिवाइस कमांड
डिवाइस का जीवनचक्र, प्रमाणीकरण, कॉन्फ़िगरेशन, लॉगिंग, स्थिति और हार्डवेयर नियंत्रण।
संचार आदेश
कॉल शुरू करें, संदेश भेजें, सक्रिय संचार सत्रों का प्रबंधन करें और रिकॉर्डिंग को नियंत्रित करें।
ऑडियो कमांड
स्पीकर की आवाज़, माइक्रोफोन की गेन, ऑडियो प्रोफाइल और टेक्स्ट-टू-स्पीच प्लेबैक को नियंत्रित करें।
एलईडी कमांड
बैज इंडिकेटर लाइट पर एलईडी का रंग, चमक और एनिमेशन पैटर्न सेट करें।
आंतरिक आदेश
संदर्भ वितरण, चैनल इतिहास, स्वर-उच्चारण और ऑडियो डिकोडिंग के लिए उपयोग किए जाने वाले आंतरिक प्रेषण कमांड।
मोबाइल कमांड
बैज को संबंधित मोबाइल ऐप के साथ समन्वयित करने के लिए कमांड — पुश नोटिफिकेशन, ऐप स्टेट सिंक और डीप लिंकिंग।