Developer API — Connection

ટોકન મેળવો

તમારા ઓળખપત્રોને પ્રમાણીકરણના અંતિમ બિંદુ પર પોસ્ટ કરો. તમને ટૂંકા ગાળા માટેનો access_token અને લાંબા ગાળા માટેનો refresh_token પ્રાપ્ત થશે.

ટોકનનો ઉપયોગ કરો

દરેક વિનંતીમાં ટોકન શામેલ કરો:

Authorization: Bearer <access_token>

POST/api/v1/auth/login

વિનંતી

{
  "email": "admin@yourorg.com",
  "password": "••••••••"
}

પ્રતિભાવ 200

{
  "access_token": "eyJhbG...",
  "refresh_token": "dGhpcw...",
  "expires_in": 3600,
  "token_type": "Bearer"
}

ક્લાઉડ-હોસ્ટેડ ડિપ્લોયમેન્ટ માટે, તમારી સંસ્થાને સોંપેલ પ્રાદેશિક એન્ડપોઇન્ટનો ઉપયોગ કરો. ઓન-પ્રિમાઇસિસ સર્વર ડિપ્લોયમેન્ટ માટે, તમારા સર્વરના હોસ્ટનામનો ઉપયોગ કરો.

પર્યાવરણ	મૂળ URL
ક્લાઉડ (યુએસ)	`https://beta.connection.app/api/v1`
ઓન-પ્રિમાઇસિસ	`https://<your-server>/api/v1`

સામગ્રી-પ્રકાર
બધી વિનંતી અને પ્રતિભાવ સંસ્થાઓ application/json નો ઉપયોગ કરે છે. બોડી સાથે વિનંતીઓમાં Content-Type: application/json નો સમાવેશ કરો.

સ્થિતિ	અર્થ
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 ઝાંખી

કનેક્શન સર્વર REST API તમારા ડિવાઇસ ફ્લીટ, કોમ્યુનિકેશન ઇન્ફ્રાસ્ટ્રક્ચર અને એનાલિટિક્સ માટે સંપૂર્ણ પ્રોગ્રામેટિક ઍક્સેસ પ્રદાન કરે છે. તે JSON વિનંતી/પ્રતિભાવ સંસ્થાઓ સાથે RESTful સંમેલનોને અનુસરે છે.

API પ્રમાણીકરણ

વપરાશકર્તાઓ

ઉપકરણો

ચેનલો

સંચાર

ઓડિયો બ્રિજ

વાતચીતો

સામગ્રી

સ્થાનો

પુશ સૂચનાઓ

સંગ્રહ

બલ્ક ઓપરેશન્સ

તારીખ સમય

POST/api/v1/loginવપરાશકર્તાને પ્રમાણિત કરો અને પ્રમાણીકરણ ટોકન મેળવો

POST/api/v1/login-deviceUUID અને MAC સરનામાં દ્વારા ઉપકરણને પ્રમાણિત કરો

POST/api/v1/logoutવર્તમાન સત્ર ટોકનને અમાન્ય કરો

GET/api/v1/users/userહાલમાં લોગ-ઇન કરેલ વપરાશકર્તા પ્રોફાઇલ મેળવો

POST/api/v1/users/userનવું વપરાશકર્તા ખાતું બનાવો

PATCH/api/v1/users/user/{uuid}વપરાશકર્તા પ્રોફાઇલ અપડેટ કરો (દા.ત. પ્રોફાઇલ છબી)

ઉપકરણો

ઉપકરણોની યાદી બનાવો અને તેનું નિરીક્ષણ કરો, વપરાશકર્તા-ઉપકરણ સંગઠનોનું સંચાલન કરો, ઉપકરણ દીઠ સેટિંગ્સ અને સ્થિતિ વાંચો અને લખો, ફર્મવેર અને સ્ટોરેજ છબીઓને હેન્ડલ કરો અને લોગ અને ક્રેશ રિપોર્ટ્સ પ્રાપ્ત કરો.

GET/api/v1/devices/deviceબધા ઉપકરણોની યાદી બનાવો

GET/api/v1/devices/device/{uuid}ફર્મવેર અને સેટિંગ્સ સહિત વિગતવાર ઉપકરણ માહિતી મેળવો

PUT/api/v1/devices/association/{uuid}વપરાશકર્તા અને ઉપકરણ વચ્ચેના જોડાણને અપડેટ કરો

DELETE/api/v1/devices/association/{uuid}વપરાશકર્તા-ઉપકરણ જોડાણ અને સંગ્રહિત સેટિંગ્સ દૂર કરો

GET/api/v1/devices/device/{device_uuid}/settingsઉપકરણ માટે સંગ્રહિત સેટિંગ્સની સૂચિ બનાવો

POST/api/v1/devices/device/{device_uuid}/settingsઉપકરણ-વિશિષ્ટ સેટિંગ્સ સાચવો

GET/api/v1/devices/device/{device_uuid}/statusઉપકરણ સ્થિતિ (કનેક્ટિવિટી, બેટરી, સેન્સર, ઑડિઓ સ્થિતિ) મેળવો

POST/api/v1/devices/device/{device_uuid}/statusડિવાઇસમાંથી ડિવાઇસ સ્ટેટસ પોસ્ટ કરો

GET/api/v1/devices/device/{device_uuid}/contextઉપકરણ માટે સંગ્રહિત સંદર્ભ મૂલ્યોની યાદી બનાવો

POST/api/v1/devices/device/{device_uuid}/ingest-contextઉપકરણમાંથી GPS + WiFi સંદર્ભ મેળવો

GET/api/v1/devices/firmwareઆપેલ હાર્ડવેર/સોફ્ટવેર સંસ્કરણ સાથે સુસંગત ફર્મવેર પ્રકાશનોની યાદી બનાવો.

GET/api/v1/devices/firmware/{uuid}/{image_type}/fetchફર્મવેર છબીને ટુકડાઓમાં મેળવો

GET/api/v1/devices/languageસમર્થિત ઉપકરણ ભાષાઓ અને અવાજોની યાદી બનાવો

GET/api/v1/devices/storage_imageલોકેલ માટે કસ્ટમાઇઝ કરેલ ડિવાઇસ સ્ટોરેજ છબી ડાઉનલોડ કરો

POST/api/v1/devices/logઉપકરણમાંથી લોગ ફાઇલ મેળવો

POST/api/v1/devices/crashઉપકરણમાંથી કોર ડમ્પ મેળવો

PATCH/api/v1/devices/crash/{uuid}ક્રેશ રેકોર્ડ અપડેટ કરો

CBBP પ્રોક્સી

સર્વર દ્વારા કોઈપણ CBBP આદેશ ઉપકરણ પર મોકલો. સર્વર ઉપકરણના WiFi કનેક્શન પર આદેશને રિલે કરે છે અને ઉપકરણ પ્રતિભાવ પરત કરે છે. આઉટગોઇંગ-મેક પ્રતિભાવમાં CBBPMessage પણ શામેલ હોય છે જેને ઉપકરણ તરત જ એક્ઝિક્યુટ કરે છે.

POST/api/v1/devices/device/{device_uuid}/cbbpસર્વર દ્વારા ઉપકરણ પર CBBP આદેશ મોકલો

GET/api/v1/devices/device/{device_uuid}/cbbp/{uuid}અગાઉ મોકલેલા CBBP આદેશની સ્થિતિ અને પ્રતિભાવ મેળવો

વિનંતીનો મુખ્ય ભાગ એક CBBP કમાન્ડ પરબિડીયું છે. સંગ્રહિત CBBPCommand ઑબ્જેક્ટ ડિલિવરી સ્થિતિને ટ્રેક કરે છે: UNSET → SENT → RECEIVED અથવા TIMED_OUT.

ઉપકરણે આદેશ પ્રાપ્ત કર્યો અને તેનો જવાબ આપ્યો કે નહીં તે ચકાસવા માટે GET /cbbp/ પોલ કરો.

વિનંતી — આઉટગોઇંગમેસેજ

{
  "outgoingMessage": {
    "command": "WiFiScan"
  }
}

પ્રતિભાવ — CBBPકમાન્ડ સ્થિતિ

{
  "uuid": "a3f2...",
  "status": "SENT",
  "device": "d7f3a1b2-...",
  "dateSent": "2025-09-15T14:22:01Z",
  "outgoingMessage": { /* echoed */ },
  "incomingMessage": null
}

GET/api/v1/channels/channelચેનલોની યાદી આપો, વૈકલ્પિક રીતે object_type દ્વારા ફિલ્ટર કરેલ

POST/api/v1/channels/channelચેનલ બનાવો (ચેનલગ્રુપ, ચેનલકોન્ટેક્ટ, અથવા ચેનલએક્સટર્નલમ્બર)

PATCH/api/v1/channels/channel/{uuid}ચેનલગ્રુપ અથવા ચેનલકોન્ટેક્ટ અપડેટ કરો

DELETE/api/v1/channels/channel/{uuid}ચેનલ કાઢી નાખો

DELETE/api/v1/channels/{uuid}ચેનલગ્રુપ કાઢી નાખો

DELETE/api/v1/channels/by-type/{channelType}આપેલ પ્રકારની બધી ચેનલો કાઢી નાખો (હાલમાં ChannelContact)

GET/api/v1/channels/associationવર્તમાન વપરાશકર્તા માટે ચેનલ એસોસિએશનની યાદી બનાવો

POST/api/v1/channels/associationચેનલ સાથે જોડાણની વિનંતી કરો

PATCH/api/v1/channels/association/{uuid}એસોસિએશન સેટિંગ્સ સ્વીકારો, નકારો અથવા અપડેટ કરો

DELETE/api/v1/channels/association/{uuid}ચેનલ સાથેનું જોડાણ દૂર કરો

GET/api/v1/channels/historyવર્તમાન વપરાશકર્તા માટે પૃષ્ઠ ક્રમાંકિત ચેનલ ઍક્સેસ ઇતિહાસ મેળવો

POST/api/v1/channels/historyચૅનલ ઇતિહાસ એન્ટ્રી બનાવો

GET/api/v1/channels/searchક્વેરી સ્ટ્રિંગ અને વૈકલ્પિક પ્રકારના ફિલ્ટર દ્વારા ચેનલો શોધો

POST/api/v1/communicate/outgoing-makeચેનલપીપલ, ચેનલગ્રુપ, ચેનલકોન્ટેક્ટ અથવા ચેનલકોન્ટેક્ટનમ્બર પર આઉટગોઇંગ ચેનલ શરૂ કરો

POST/api/v1/communicate/incoming-acceptanceઆવનારી ચેનલ જોડાવાની વિનંતી સ્વીકારો અથવા નકારો

POST/api/v1/communicate/closeઉપકરણ પર વર્તમાન સક્રિય સંચાર ચેનલ બંધ કરો

POST/api/v1/communicate/vcp-activateસર્વર અને ડિવાઇસ પર વૉઇસ કોમ્યુનિકેશન પ્રોટોકોલ (VCP) શરૂ કરો

POST/api/v1/communicate/vcp-deactivateVCP ને નિષ્ક્રિય કરો, કોઈપણ પાછલી ચેનલ પર પાછા ફરો

POST/api/v1/communicate/recording-activateસર્વર અને ઉપકરણ પર રેકોર્ડિંગ મોડ સક્રિય કરો

POST/api/v1/communicate/content-startઑડિઓ સામગ્રી માટે સ્ટ્રીમિંગ ચેનલ ખોલો

POST/api/v1/communicate/request-vocalizationઆપેલ ટેક્સ્ટ માટે TTS ઑડિઓ જનરેટ કરો, વૈકલ્પિક રીતે તેનો અનુવાદ કરો

ઓડિયો બ્રિજ

સંપૂર્ણ ટ્રાન્સક્રિપ્ટ્સ, સહભાગીઓની યાદીઓ અને AI-જનરેટેડ સારાંશ સહિત રેકોર્ડ કરેલા બ્રિજ વાર્તાલાપને ઍક્સેસ કરો. સારાંશ માટે બહુવિધ સારાંશ નમૂનાઓ (મીટિંગ નોંધો, વર્ગ નોંધો, આરોગ્યસંભાળ, વગેરે) અને TTS ઑડિઓ જનરેશનને સપોર્ટ કરે છે.

GET/api/v1/bridge/conversationsબધી બ્રિજ વાતચીતોની યાદી બનાવો

GET/api/v1/bridge/conversations/{uuid}ટ્રાન્સક્રિપ્ટ, સહભાગીઓ અને સારાંશ સહિત વિગતવાર વાતચીત મેળવો

POST/api/v1/bridge/conversations/{conversation_uuid}/summaryવાતચીત માટે AI સારાંશ બનાવો

POST/api/v1/bridge/conversations/{conversation_uuid}/summary/{summary_uuid}/audioવાતચીતના સારાંશ માટે ઑડિઓ જનરેટ કરો

GET/api/v1/conversations/conversationવ્યક્તિત્વ અને સાધન દ્વારા ફિલ્ટર કરી શકાય તેવા AI જનરેટર સત્રોની યાદી બનાવો

POST/api/v1/conversations/conversationએક નવું AI વાતચીત સત્ર બનાવો

GET/api/v1/conversations/conversation/{uuid}વૈકલ્પિક સારાંશ/અવે અપડેટ સાથે વાતચીત સત્ર મેળવો

DELETE/api/v1/conversations/conversation/{uuid}વાતચીત સત્ર કાઢી નાખો

GET/api/v1/conversations/conversation/{uuid}/messagesવાતચીતમાં સંદેશાઓની યાદી બનાવો

POST/api/v1/conversations/conversation/{uuid}/messagesવપરાશકર્તા સંદેશ ઉમેરો અને AI જવાબ મેળવો

GET/api/v1/content/categoriesસામગ્રી શ્રેણીઓનું એક વૃક્ષ મેળવો

GET/api/v1/content/contentશ્રેણીમાં ઉપલબ્ધ સામગ્રીની યાદી બનાવો

GET/api/v1/content/popularઆપેલ શહેર, પ્રદેશ અથવા દેશ માટે લોકપ્રિય સામગ્રીની સૂચિ બનાવો

POST/api/v1/location/determineશહેર, પ્રદેશ અને દેશ માટે અક્ષાંશ/રેખાંશ ઉકેલો

POST/api/v1/push-notifications/pushFCM પુશ સૂચનાઓ (iOS, Android, વેબ) માટે મોબાઇલ એપ્લિકેશન નોંધણી કરો.

GET/api/v1/storage/retrieve/{path}પાથ દ્વારા સંગ્રહિત ફાઇલ ડાઉનલોડ કરો

POST/api/v1/storage/remove-backgroundછબીમાંથી પૃષ્ઠભૂમિ દૂર કરો (base64 પરત કરે છે)

POST/api/v1/bulkએક જ વિનંતીમાં બહુવિધ API કામગીરી ચલાવો, વૈકલ્પિક રીતે એક જ અણુ વ્યવહાર તરીકે

GET/api/v1/current-datetimeવર્તમાન તારીખ અને સમય GMT+0 માં પરત કરો.

સીબીબીપી પ્રોટોકોલ

કોમ બેજ બેઝિક પ્રોટોકોલ

CBBP એ કનેક્શન બેજેસ સાથે સીધી ક્રિયાપ્રતિક્રિયા માટે એક હળવો JSON કમાન્ડ પ્રોટોકોલ છે. તે તમને ઉપકરણ પરના દરેક હાર્ડવેર અને સોફ્ટવેર કાર્ય પર સંપૂર્ણ નિયંત્રણ આપે છે.

સંદેશ ફોર્મેટ

દરેક CBBP ક્રિયાપ્રતિક્રિયામાં ઉપકરણને મોકલવામાં આવેલ આદેશ સંદેશ અને ઉપકરણ દ્વારા પરત કરાયેલ પરિણામ સંદેશનો સમાવેશ થાય છે.

વિનંતી અને પ્રતિભાવ બંનેમાં ઑબ્જેક્ટ ફીલ્ડ આદેશ-વિશિષ્ટ ડેટા ધરાવે છે અને જ્યારે જરૂર ન હોય ત્યારે તેને છોડી શકાય છે.

નોંધાયેલા ભાગીદારો માટે સંપૂર્ણ પ્રોટોકોલ દસ્તાવેજીકરણ ઉપલબ્ધ છે. તમારા કનેક્શન વ્યવસાય પ્રતિનિધિનો સંપર્ક કરો અથવા સંપર્ક કરો developer@connectionbadge.com સંપૂર્ણ વિનંતી/પ્રતિભાવ સ્કીમા, ભૂલ કોડ અને એકીકરણ માર્ગદર્શિકાઓ સહિત સંપૂર્ણ CBBP આદેશ સંદર્ભની ઍક્સેસની વિનંતી કરવા માટે.

આદેશ સંદેશ

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

બ્લૂટૂથ (એપ્લિકેશન)

BLE પર મોબાઇલ એપ્લિકેશનથી સીધા CBBP આદેશો મોકલો. ઉપકરણને જોડી અને રેન્જમાં હોવું જરૂરી છે.

મોબાઇલ SDK

સર્વર દ્વારા વાઇફાઇ અથવા બ્લૂટૂથ

REST API — POST /devices//cbbp દ્વારા પ્રોક્સી CBBP. બેજ કેવી રીતે જોડાયેલ છે તેના આધારે સર્વર આપમેળે WiFi અથવા Bluetooth દ્વારા ઉપકરણ પર રૂટ કરે છે. બેકએન્ડ ઇન્ટિગ્રેશન માટે સૌથી સામાન્ય.

REST API

આંતરિક રવાનગી

ઓન-ડિવાઇસ અથવા ઇન્ટર-પ્રોસેસ CBBP ડિસ્પેચ. બેજ ફર્મવેર દ્વારા આંતરિક સબસિસ્ટમ્સ વચ્ચે આદેશોને રૂટ કરવા માટે વપરાય છે.

ફક્ત ફર્મવેર

પર બનાવોકનેક્શન પ્લેટફોર્મ

REST API

સીબીબીપી પ્રોટોકોલ

વેબહુક્સ

પ્રમાણીકરણ

ટોકન મેળવો

ટોકનનો ઉપયોગ કરો

બેઝ URL અને વર્ઝનિંગ

ભૂલો અને સ્થિતિ કોડ્સ

REST API ઝાંખી

પ્રમાણીકરણ

વપરાશકર્તાઓ

ઉપકરણો

CBBP પ્રોક્સી

ચેનલો

સંચાર

ઓડિયો બ્રિજ

વાતચીતો

સામગ્રી

સ્થાનો

પુશ સૂચનાઓ

સંગ્રહ

બલ્ક ઓપરેશન્સ

તારીખ સમય

કોમ બેજ બેઝિક પ્રોટોકોલ

સંદેશ ફોર્મેટ

પરિવહન

બ્લૂટૂથ (એપ્લિકેશન)

સર્વર દ્વારા વાઇફાઇ અથવા બ્લૂટૂથ

આંતરિક રવાનગી

પાવર કમાન્ડ્સ

વાઇફાઇ આદેશો

બ્લૂટૂથ આદેશો

સેટિંગ્સ આદેશો

ફર્મવેર આદેશો

ઉપકરણ આદેશો

સંદેશાવ્યવહાર આદેશો

ઑડિઓ આદેશો

એલઇડી આદેશો

આંતરિક આદેશો

મોબાઇલ કમાન્ડ્સ

બનાવવા માટે તૈયાર છો?

પર બનાવો
કનેક્શન પ્લેટફોર્મ