Hitelesítés
A Connection API Bearer token hitelesítést használ. Minden kérésnek tartalmaznia kell egy érvényes JWT hozzáférési tokent az Authorization fejlécben.
Token beszerzése
Küldd el a hitelesítő adataidat az auth végpontra. Kapsz egy rövid életű access_token-t és egy hosszabb életű refresh_token-t.
Használja a tokent
Minden kérésbe foglald bele a tokent:
{
"email": "admin@yourorg.com",
"password": "••••••••"
}{
"access_token": "eyJhbG...",
"refresh_token": "dGhpcw...",
"expires_in": 3600,
"token_type": "Bearer"
}Alap URL és verziókezelés
Minden API-végpont az /api/v1/ könyvtárban található. Az alap URL a telepítéstől függ.
Felhőalapú telepítések esetén használja a szervezetéhez rendelt regionális végpontot. Helyi szervertelepítések esetén használja a szerver állomásnevét.
| Környezet | Alap URL |
|---|---|
| Felhő (USA) | https://beta.connection.app/api/v1 |
| Helyszíni | https://<your-server>/api/v1 |
Minden kérés és válasz törzse application/json típust használ. A törzset tartalmazó kérések esetén szerepeljen a Content-Type: application/json.
Hibák és állapotkódok
Az API szabványos HTTP állapotkódokat használ. A hibaüzenetek egy géppel olvasható kódot és egy ember által olvasható üzenetet tartalmaznak.
| Állapot | Jelentés |
|---|---|
| 200 | Siker |
| 201 | Létrehozva |
| 400 | Hibás kérés – érvénytelen paraméterek |
| 401 | Jogosulatlan – hiányzó vagy lejárt token |
| 403 | Tiltott – nincs elegendő jogosultság |
| 404 | Nem található |
| 500 | Belső szerverhiba |
{
"error": {
"code": "device_not_found",
"message": "No device with that UUID exists in your organization",
"status": 404
}
}REST API áttekintés
A Connection Server REST API teljes körű programozott hozzáférést biztosít eszközparkjához, kommunikációs infrastruktúrájához és elemzéseihez. A JSON kérés/válasz törzseket használó RESTful konvenciókat követ.
Hitelesítés
Token alapú hitelesítés. A bejelentkezés egy tokent ad vissza, amelyet a következőképpen kell elküldeni: Engedélyezés: Token.<token> minden későbbi kérésnél.
Felhasználók
Felhasználói fiókok létrehozása és kezelése. A GET /users/user végpont visszaadja a jelenleg hitelesített felhasználót.
Eszközök
Eszközök listázása és vizsgálata, felhasználó-eszköz kapcsolatok kezelése, eszközönkénti beállítások és állapotok olvasása és írása, firmware és tárolóképek kezelése, valamint naplók és hibajelentések fogadása.
CBBP-megbízó
Küldjön bármilyen CBBP parancsot egy eszközre a szerveren keresztül. A szerver továbbítja a parancsot az eszköz WiFi-kapcsolatán keresztül, és visszaadja az eszköz válaszát. A kimenő make válasz egy CBBPMessage üzenetet is beágyaz, amelyet az eszköz azonnal végrehajt.
A kérés törzse egy CBBP parancsboríték. A tárolt CBBPCommand objektum nyomon követi a kézbesítés állapotát: UNSET → SENT → RECEIVED vagy TIMED_OUT.
{
"outgoingMessage": {
"command": "WiFiScan"
}
}{
"uuid": "a3f2...",
"status": "SENT",
"device": "d7f3a1b2-...",
"dateSent": "2025-09-15T14:22:01Z",
"outgoingMessage": { /* echoed */ },
"incomingMessage": null
}Csatornák
A csatornák a kommunikáció alapvető elemei. Típusaik közé tartozik a ChannelPeople, ChannelGroup, ChannelContact, ChannelContactNumber, ChannelExternalNumber, ChannelService és ChannelRecorder.
Kommunikáció
Aktív kommunikációs munkamenetek – kimenő hívások, VCP, felvétel és tartalomstreamelés – indítása és kezelése. A kimenő hívásra adott válasz egy CBBPMessage üzenetet tartalmaz, amelyre az eszköz azonnal reagál.
Audio híd
Hozzáférés rögzített hídbeszélgetésekhez, beleértve a teljes átiratokat, a résztvevői listákat és a mesterséges intelligencia által generált összefoglalókat. Több összefoglaló sablont támogat (megbeszélésjegyzetek, órajegyzetek, egészségügyi információk stb.) és TTS hanggenerálást az összefoglalókhoz.
Beszélgetések
Mesterséges intelligencia által vezérelt beszélgetési munkamenetek a ChatGPT, a Gemini vagy a natív motor használatával. Több személyiség (orvos, oktató, szerelő stb.) és lapozott üzenetelőzmények támogatása.
Tartalom
Böngésszen és játsszon le streamelt hanganyagokat az eszközökön. A tartalom kategóriafában van rendezve; a népszerű tartalmak város, régió vagy ország szerint szűrhetők.
Helyszínek
Földrajzi koordináták feloldása strukturált város-, régió- és országobjektummá. Az eszközök a kontextus betöltésekor használják.
Push értesítések
Regisztrálj egy mobilalkalmazást az FCM push értesítések fogadásához. Támogatja az iOS, Android és webes célpontokat.
Tárolás
Töltse le a modellobjektumokon tárolt fájlokat, és futtassa a képháttér eltávolítását (base64 kódolású eredményt ad vissza).
Tömeges műveletek
Több API-művelet végrehajtása egyetlen HTTP-kérelemben. Adja meg a single_transaction=true paramétert, hogy az összes műveletet egyetlen atomi tranzakcióba foglalja – bármely elem hibája esetén a teljes köteg visszagörgetésre kerül.
Dátum és idő
Visszaadja az aktuális szerverdátumot és -időt GMT+0 időzónában. Nem igényel hitelesítést. Az eszközök használják a belső órájuk szinkronizálására.
Com Badge alapprotokoll
A CBBP egy könnyűsúlyú JSON parancsprotokoll a csatlakozási jelvényekkel való közvetlen interakcióhoz. Teljes körű kontrollt biztosít az eszköz összes hardver- és szoftverfunkciója felett.
Üzenetformátum
Minden CBBP interakció egy, az eszköznek küldött parancsüzenetből és az eszköz által visszaadott eredményüzenetből áll.
A kérésben és a válaszban is található objektummező parancsspecifikus adatokat tartalmaz, és szükség esetén elhagyható.
{
"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
}
}Szállítás
A CBBP üzenetek három különböző átviteli módon kézbesíthetők egy jelvényre az integrációs architektúrától függően.
Bluetooth (alkalmazás)
Küldjön CBBP parancsokat közvetlenül egy mobilalkalmazásból BLE-n keresztül. Ehhez az eszköznek párosítva kell lennie és hatótávolságon belül kell lennie.
Mobil SDKWiFi vagy Bluetooth szerveren keresztül
CBBP proxy REST API-n keresztül — POST /devices//cbbp. A szerver automatikusan Wi-Fi-n vagy Bluetooth-on keresztül irányítja az eszközt, attól függően, hogyan csatlakozik a jelvény. Leggyakoribb a háttérintegrációknál.
REST APIBelső diszpécser
Eszközön belüli vagy folyamatok közötti CBBP-továbbítás. A jelvény firmware-je használja a parancsok belső alrendszerek közötti továbbítására.
Csak firmwareTeljesítményparancsok
Eszköz energiaállapotának vezérlése – alvás, felébresztés, újraindítás és gyári beállítások visszaállítása.
WiFi parancsok
Vezeték nélküli hálózatok konfigurálása, hozzáférési pontok keresése, kapcsolat állapotának ellenőrzése és mentett hitelesítő adatok kezelése.
Bluetooth parancsok
Irányítsd a BLE hirdetéseket, a párosítást és a jelvények közötti kommunikációt.
Beállítások parancsai
Eszközkonfiguráció olvasása és írása — megjelenítendő név, időzóna, nyelv és funkciójelzők.
Firmware parancsok
OTA firmware frissítések indítása, frissítési állapot ellenőrzése és az eszközön lévő aktuális firmware verzió lekérdezése.
Eszközparancsok
Eszköz életciklusa, hitelesítés, konfiguráció, naplózás, állapot és hardvervezérlés.
Kommunikációs parancsok
Hívások kezdeményezése, üzenetek küldése, aktív kommunikációs munkamenetek kezelése és a felvétel vezérlése.
Hangparancsok
Szabályozza a hangszóró hangerejét, a mikrofon erősítését, a hangprofilokat és a szövegfelolvasó lejátszását.
LED parancsok
Állítsa be a LED színét, fényerejét és animációs mintáit a jelvény jelzőfényén.
Belső parancsok
Belső diszpécserparancsok, amelyeket a kontextus kézbesítéséhez, a csatorna előzményeihez, a vokalizációhoz és a hangdekódoláshoz használnak.
Mobil parancsok
Parancsok a jelvény és a párosított mobilalkalmazás összehangolására — push értesítések, alkalmazásállapot-szinkronizálás és mélyhivatkozások.