டெவலப்பர் தளம்


இணைப்பு தளம்

இரண்டு சக்திவாய்ந்த API-கள் — சாதன மேலாண்மை மற்றும் தகவல் தொடர்பு ஒருங்கிணைப்புக்கான ஒரு RESTful சர்வர் API, மற்றும் நேரடி பேட்ஜ் கட்டுப்பாட்டிற்கான ஒரு கீழ்நிலை CBBP நெறிமுறை.

OpenAPI 3.0JSON / RESTப்ளூடூத் + வைஃபைவெப்ஹூக் ஆதரவு
Connection Studio
Explorer
examples
send_command.http
response.json
list_devices.http
webhooks.http
src
docs
send_command.http
response.json
# Send a CBBP command via the server
POST /api/v1/devices/{uuid}/cbbp

{
  "command": "speak",
  "object": {
    "text": "Shift starts in 5 minutes",
    "volume": 85,
    "language": "en-US"
  }
}

# Response
{
  "result": 0,
  "detail": "ok"
}
main
HTTPUTF-8Ln 2, Col 1

REST API

சாதனத்தின் முழுமையான ஆயுள் சுழற்சி மேலாண்மை — வழங்குதல், உள்ளமைத்தல், நிலைபொருள், தகவல்தொடர்பு மற்றும் பகுப்பாய்வு — அனைத்தும் தரநிலையான HTTPS வழியாக.

REST API பற்றி அறிந்துகொள்ளுங்கள் →

CBBP நெறிமுறை

காம் பேட்ஜ் பேசிக் புரோட்டோகால் — புளூடூத் (செயலி), வைஃபை (சர்வர் ப்ராக்ஸி) அல்லது லோக்கல் டிஸ்பேட்ச் வழியாக சாதனத்தை நேரடியாகக் கட்டுப்படுத்துவதற்கான ஒரு JSON கட்டளை நெறிமுறை.

CBBP பற்றி ஆராயுங்கள் →

வலைக்கொக்கிகள்

தகவல்தொடர்புகள், நிலை மாற்றங்கள், இருப்பிடப் புதுப்பிப்புகள் போன்ற நிகழ்நேரச் சாதன நிகழ்வுகளை, உங்கள் முனையத்திற்கு HTTP POST பேலோடுகளாக அனுப்பப் பெற குழுசேரவும்.

வெப்ஹூக்குகளை ஆராயுங்கள் →

Early Access: The Connection API is currently available by special request to select partners. Contact us to apply for access.

Pro or Plus plan required: Badges must be on the Pro or Plus plan to be controlled via the API.

தொடங்குதல்

அங்கீகாரம்

இணைப்பு API, பியரர் டோக்கன் அங்கீகாரத்தைப் பயன்படுத்துகிறது. அனைத்து கோரிக்கைகளிலும், அங்கீகாரத் தலைப்பில் (Authorization header) ஒரு செல்லுபடியாகும் JWT அணுகல் டோக்கன் இடம்பெற்றிருக்க வேண்டும்.

ஒரு டோக்கனைப் பெறுங்கள்

உங்கள் சான்றுகளை அங்கீகார முனையத்திற்கு POST செய்யவும். நீங்கள் குறுகிய கால அணுகல் டோக்கன் (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 மற்றும் பதிப்பு

அனைத்து API எண்ட்பாயிண்ட்களும் /api/v1/ இன் கீழ் பதிப்பிடப்பட்டுள்ளன. அடிப்படை URL உங்கள் வரிசைப்படுத்தலைப் பொறுத்தது.

கிளவுடில் ஹோஸ்ட் செய்யப்பட்ட நிறுவல்களுக்கு, உங்கள் நிறுவனத்திற்கு ஒதுக்கப்பட்ட பிராந்திய எண்ட்பாயிண்ட்டைப் பயன்படுத்தவும். உள்ளக சர்வர் நிறுவல்களுக்கு, உங்கள் சர்வரின் ஹோஸ்ட்பெயரைப் பயன்படுத்தவும்.

சுற்றுச்சூழல்அடிப்படை URL
கிளவுட் (அமெரிக்கா)https://beta.connection.app/api/v1
வளாகத்தில்https://<your-server>/api/v1
உள்ளடக்க வகை
அனைத்து கோரிக்கை மற்றும் பதில் உள்ளடக்கங்களும் application/json-ஐப் பயன்படுத்துகின்றன. உள்ளடக்கத்தைக் கொண்ட கோரிக்கைகளில் Content-Type: application/json என்பதைச் சேர்க்கவும்.

பிழைகள் மற்றும் நிலைக் குறியீடுகள்

இந்த API, தரநிலையான 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 கண்ணோட்டம்

கனெக்ஷன் சர்வர் REST API ஆனது, உங்கள் சாதனத் தொகுப்பு, தகவல் தொடர்பு உள்கட்டமைப்பு மற்றும் பகுப்பாய்வுகளுக்கு முழுமையான நிரல்வழி அணுகலை வழங்குகிறது. இது JSON கோரிக்கை/பதில் உள்ளடக்கங்களுடன் RESTful மரபுகளைப் பின்பற்றுகிறது.

API அங்கீகாரம்
பயனர்கள்
சாதனங்கள்
சேனல்கள்
தொடர்பு
ஆடியோ பிரிட்ஜ்
உரையாடல்கள்
உள்ளடக்கம்
இடங்கள்
புஷ் அறிவிப்புகள்
சேமிப்பு
மொத்த செயல்பாடுகள்
தேதி மற்றும் நேரம்

அங்கீகாரம்

டோக்கன் அடிப்படையிலான அங்கீகாரம். உள்நுழைவு ஒரு டோக்கனை வழங்கும், அதை அங்கீகாரமாக அனுப்ப வேண்டும்: டோக்கன்.<token> அடுத்தடுத்த அனைத்து கோரிக்கைகளிலும்.

POST/api/v1/loginஒரு பயனரை அங்கீகரித்து, அங்கீகார டோக்கனைப் பெறுங்கள்.
POST/api/v1/login-deviceUUID மற்றும் MAC முகவரியைப் பயன்படுத்தி ஒரு சாதனத்தைச் சரிபார்க்கவும்.
POST/api/v1/logoutதற்போதைய அமர்வு டோக்கனை செல்லாததாக்கு

பயனர்கள்

பயனர் கணக்குகளை உருவாக்கி நிர்வகிக்கவும். GET /users/user எண்ட்பாயிண்ட், தற்போது அங்கீகரிக்கப்பட்ட பயனரை வழங்கும்.

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
}

சேனல்கள்

சேனல்கள் என்பவை தகவல்தொடர்பின் அடிப்படைக் கூறுகளாகும். அவற்றின் வகைகளில் ChannelPeople, ChannelGroup, ChannelContact, ChannelContactNumber, ChannelExternalNumber, ChannelService, மற்றும் ChannelRecorder ஆகியவை அடங்கும்.

GET/api/v1/channels/channelசேனல்களைப் பட்டியலிடுங்கள், விருப்பப்பட்டால் பொருள் வகையின் அடிப்படையில் வடிகட்டவும்.
POST/api/v1/channels/channelஒரு சேனலை உருவாக்கவும் (சேனல் குழு, சேனல் தொடர்பு அல்லது சேனல் வெளிப்புற எண்)
PATCH/api/v1/channels/channel/{uuid}ஒரு ChannelGroup அல்லது ChannelContact-ஐப் புதுப்பிக்கவும்
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வினவல் சரம் மற்றும் விருப்பத்தேர்வான வகை வடிகட்டி மூலம் சேனல்களைத் தேடுங்கள்.

தொடர்பு

செயலில் உள்ள தகவல் தொடர்பு அமர்வுகளைத் தொடங்கி நிர்வகிக்கவும் — வெளிச்செல்லும் அழைப்புகள், VCP, பதிவு செய்தல் மற்றும் உள்ளடக்க ஸ்ட்ரீமிங். வெளிச்செல்லும் அழைப்பிற்கான பதிலில் ஒரு CBBPMessage அடங்கியுள்ளது, அதன் மீது சாதனம் உடனடியாகச் செயல்படுகிறது.

POST/api/v1/communicate/outgoing-makeChannelPeople, ChannelGroup, ChannelContact, அல்லது ChannelContactNumber-க்கு ஒரு வெளிச்செல்லும் சேனலைத் தொடங்கவும்.
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 ஆடியோவை உருவாக்கவும், விருப்பப்பட்டால் அதை மொழிபெயர்க்கவும்.

ஆடியோ பிரிட்ஜ்

முழுமையான எழுத்துப்படிவங்கள், பங்கேற்பாளர் பட்டியல்கள் மற்றும் செயற்கை நுண்ணறிவால் உருவாக்கப்பட்ட சுருக்கங்கள் உள்ளிட்ட பதிவுசெய்யப்பட்ட இணைப்பு உரையாடல்களை அணுகவும். பல சுருக்க வார்ப்புருக்களையும் (கூட்டக் குறிப்புகள், வகுப்புக் குறிப்புகள், சுகாதாரப் பராமரிப்பு போன்றவை) மற்றும் சுருக்கங்களுக்கான 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உரையாடல் சுருக்கத்திற்கான ஆடியோவை உருவாக்கவும்

உரையாடல்கள்

ChatGPT, Gemini அல்லது நேட்டிவ் இன்ஜினைப் பயன்படுத்தி செயற்கை நுண்ணறிவால் இயங்கும் உரையாடல் அமர்வுகள். மருத்துவர், பயிற்றுநர், மெக்கானிக் போன்ற பல ஆளுமைகளையும், பக்கப்படுத்தப்பட்ட செய்தி வரலாற்றையும் ஆதரிக்கிறது.

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பயனர் செய்தியைச் சேர்த்து, செயற்கை நுண்ணறிவு பதிலைப் பெறுங்கள்.

உள்ளடக்கம்

சாதனங்களில் ஸ்ட்ரீமிங் ஆடியோ உள்ளடக்கத்தை உலாவவும் இயக்கவும். உள்ளடக்கம் ஒரு வகை மர அமைப்பில் ஒழுங்கமைக்கப்பட்டுள்ளது; பிரபலமான உள்ளடக்கத்தை நகரம், பிராந்தியம் அல்லது நாடு வாரியாக வடிகட்டலாம்.

GET/api/v1/content/categoriesஉள்ளடக்க வகைகளின் மரத்தைப் பெறுங்கள்
GET/api/v1/content/contentஒரு பிரிவில் கிடைக்கும் உள்ளடக்கங்களைப் பட்டியலிடுங்கள்
GET/api/v1/content/popularஒரு குறிப்பிட்ட நகரம், பிராந்தியம் அல்லது நாட்டிற்கான பிரபலமான உள்ளடக்கங்களைப் பட்டியலிடுக.

இடங்கள்

புவியியல் ஆயங்களை ஒரு கட்டமைக்கப்பட்ட நகரம், பிராந்தியம் மற்றும் நாடு சார்ந்த பொருளாக மாற்றுகிறது. சூழலை உள்ளீடாகப் பெறும்போது சாதனங்களால் இது பயன்படுத்தப்படுகிறது.

POST/api/v1/location/determineஒரு அட்சரேகை/தீர்க்கரேகையை நகரம், பிராந்தியம் மற்றும் நாடாக மாற்றவும்

புஷ் அறிவிப்புகள்

FCM புஷ் அறிவிப்புகளைப் பெற ஒரு மொபைல் செயலியைப் பதிவு செய்யவும். iOS, ஆண்ட்ராய்டு மற்றும் இணையச் செயலிகளை ஆதரிக்கிறது.

POST/api/v1/push-notifications/pushFCM புஷ் அறிவிப்புகளுக்கான மொபைல் செயலியைப் பதிவு செய்யவும் (iOS, Android, web)

சேமிப்பு

மாதிரிப் பொருட்களில் சேமிக்கப்பட்டுள்ள கோப்புகளைப் பதிவிறக்கம் செய்து, படப் பின்னணி நீக்கத்தைச் செயல்படுத்தவும் (இது base64-குறியாக்கப்பட்ட முடிவைத் தரும்).

GET/api/v1/storage/retrieve/{path}சேமிக்கப்பட்ட கோப்பை அதன் பாதை வழியாகப் பதிவிறக்கவும்
POST/api/v1/storage/remove-backgroundஒரு படத்திலிருந்து பின்னணியை நீக்குதல் (base64 மதிப்பை வழங்கும்)

மொத்த செயல்பாடுகள்

ஒரே HTTP கோரிக்கையில் பல API செயல்பாடுகளைச் செயல்படுத்தவும். அனைத்து செயல்பாடுகளையும் ஒரே அணுநிலை பரிவர்த்தனையில் இணைக்க, single_transaction=true என்பதை அனுப்பவும் — இதில் ஏதேனும் ஒரு செயல்பாடு தோல்வியுற்றால், முழுத் தொகுப்பும் திரும்பப் பெறப்படும்.

POST/api/v1/bulkபல API செயல்பாடுகளை ஒரே கோரிக்கையில், விருப்பப்பட்டால் ஒரே அணுநிலை பரிவர்த்தனையாகச் செயல்படுத்தவும்.

தேதி மற்றும் நேரம்

தற்போதைய சேவையகத்தின் தேதி மற்றும் நேரத்தை GMT+0 அளவில் வழங்கும். இதற்கு அங்கீகாரம் தேவையில்லை. சாதனங்கள் தங்களின் உள்ளகக் கடிகாரத்தை ஒத்திசைக்க இதைப் பயன்படுத்துகின்றன.

GET/api/v1/current-datetimeதற்போதைய தேதி மற்றும் நேரத்தை GMT+0 இல் தெரிவிக்கவும்.
CBBP நெறிமுறை

காம் பேட்ஜ் அடிப்படை நெறிமுறை

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

போக்குவரத்து

உங்கள் ஒருங்கிணைப்புக் கட்டமைப்பைப் பொறுத்து, CBBP செய்திகளை மூன்று வெவ்வேறு போக்குவரத்து வழிகள் மூலம் ஒரு பேட்ஜுக்கு அனுப்ப முடியும்.

புளூடூத் (செயலி)

மொபைல் செயலியிலிருந்து BLE வழியாக நேரடியாக CBBP கட்டளைகளை அனுப்பலாம். இதற்கு, சாதனம் இணைக்கப்பட்டு, வரம்பிற்குள் இருக்க வேண்டும்.

மொபைல் SDK

சர்வர் வழியாக வைஃபை அல்லது புளூடூத்

REST API வழியாக CBBP-ஐ ப்ராக்ஸி செய்யவும் — POST /devices//cbbp. பேட்ஜ் எவ்வாறு இணைக்கப்பட்டுள்ளது என்பதைப் பொறுத்து, சர்வர் தானாகவே WiFi அல்லது Bluetooth வழியாக சாதனத்திற்கு வழிநடத்துகிறது. இது பேக்கெண்ட் ஒருங்கிணைப்புகளுக்கு மிகவும் பொதுவானது.

REST API

உள் அனுப்பீடு

சாதனத்தினுள் அல்லது செயல்முறைகளுக்கு இடையேயான CBBP அனுப்பீடு. உள்ளகத் துணை அமைப்புகளுக்கு இடையில் கட்டளைகளை வழிநடத்த, பேட்ஜ் ஃபார்ம்வேரால் இது பயன்படுத்தப்படுகிறது.

ஃபார்ம்வேர் மட்டும்

சக்தி கட்டளைகள்

சாதனத்தின் ஆற்றல் நிலையைக் கட்டுப்படுத்துதல் — உறக்கம், விழிப்பு, மறுதொடக்கம் மற்றும் தொழிற்சாலை மீட்டமைப்பு.

PowerRebootசாதனத்தை உடனடியாக மறுதொடக்கம் செய்யவும்.
PowerDeepsleepஆழ்ந்த உறக்க (குறைந்த ஆற்றல்) பயன்முறைக்குள் நுழையவும்.
FactoryResetஅனைத்து உள்ளமைவுகளையும் அழித்து, தொழிற்சாலை இயல்புநிலைகளுக்கு மீட்டமைக்கவும்.

வைஃபை கட்டளைகள்

கம்பியில்லா வலையமைப்புகளை உள்ளமைக்கவும், AP-களைத் தேடவும், இணைப்பு நிலையைச் சரிபார்க்கவும், மற்றும் சேமிக்கப்பட்ட நற்சான்றுகளை நிர்வகிக்கவும்.

WiFiScanகிடைக்கக்கூடிய WiFi அணுகல் புள்ளிகளைத் தேடவும்.
WiFiAPTestஒரு குறிப்பிட்ட WiFi அணுகல் புள்ளிக்கான இணைப்பைச் சோதிக்கவும்.
WiFiAPJoinவழங்கப்பட்ட சான்றுகளைப் பயன்படுத்தி வைஃபை அணுகல் புள்ளியில் இணையுங்கள்.

புளூடூத் கட்டளைகள்

BLE விளம்பரம், இணைத்தல் மற்றும் பேட்ஜ்களுக்கு இடையேயான தகவல் தொடர்பு ஆகியவற்றைக் கட்டுப்படுத்தவும்.

BTScanBTவழக்கமான புளூடூத் சாதனங்களைத் தேடவும்.
BTScanBLEBLE சாதனங்களைத் தேடவும்.
DeviceBLEServiceAvailableBLE சேவை பயன்பாட்டில் உள்ளது எனக் குறிக்கவும்.
DeviceBLEServiceUnavailableBLE சேவையை கிடைக்கவில்லை எனக் குறிக்கவும்.
DeviceBLEActiveBLE ரேடியோவை இயக்க நிலைக்கு அமைக்கவும்.
DeviceBLEIdleBLE ரேடியோவை செயலற்ற நிலைக்கு அமைக்கவும்.
DeviceBLEAdvChannelAddBLE விளம்பர பேலோடில் ஒரு சேனலைச் சேர்க்கவும்.
DeviceBTScanபுளூடூத் சாதன ஸ்கேனைத் தொடங்கவும்.
DeviceBTA2DStartபுளூடூத் A2DP ஆடியோ ஸ்ட்ரீமிங்கைத் தொடங்கவும்.
DeviceBTA2DEndபுளூடூத் A2DP ஆடியோ ஸ்ட்ரீமிங்கை நிறுத்தவும்.
DeviceBTNativeAssistStartஉள்ளமைந்த புளூடூத் குரல் உதவியாளரைத் தொடங்கவும்.
DeviceBTNativeAssistEndஉள்ளமைந்த புளூடூத் குரல் உதவியாளரை நிறுத்தவும்.

அமைப்புகள் கட்டளைகள்

சாதன உள்ளமைவைப் படிக்கவும் எழுதவும் — காட்சிப் பெயர், நேர மண்டலம், மொழி மற்றும் அம்சக் குறியீடுகள்.

SettingsListGetஅனைத்து அமைப்புகளையும் திறவுகோல்-மதிப்புப் பட்டியலாக மீட்டெடுக்கவும்.
SettingsListSetபல அமைப்புகளின் மதிப்புகளை ஒரே நேரத்தில் எழுதவும்.
SettingsGetசாவி மூலம் ஒரு அமைப்பின் மதிப்பைப் பெறுங்கள்.
SettingsSetஒற்றை அமைப்பின் மதிப்பை அமைக்கவும்.
SettingsSendதற்போதைய அமைப்புகளை சேவையகத்திற்கு அனுப்பவும்.
SettingsClearகுறிப்பிட்ட அமைவு மதிப்புகளை அழிக்கவும்.
SettingsEraseசேமிக்கப்பட்ட அனைத்து அமைப்புகளையும் அழிக்கவும்.

நிலைபொருள் கட்டளைகள்

OTA ஃபர்ம்வேர் புதுப்பிப்புகளைத் தொடங்கவும், புதுப்பிப்பு நிலையைச் சரிபார்க்கவும், மற்றும் சாதனத்தில் உள்ள தற்போதைய ஃபர்ம்வேர் பதிப்பைக் கண்டறியவும்.

FirmwareCheckஃபார்ம்வேர் புதுப்பிப்பு உள்ளதா எனச் சரிபார்க்கவும்.
FirmwareUpdateOTA ஃபார்ம்வேர் புதுப்பிப்பைத் தொடங்கவும்.
FirmwareValidateபதிவிறக்கம் செய்யப்பட்ட ஃபார்ம்வேர் படிமத்தின் நம்பகத்தன்மையைச் சரிபார்க்கவும்.

சாதனக் கட்டளைகள்

சாதனத்தின் ஆயுட்காலம், அங்கீகாரம், உள்ளமைவு, பதிவேடு, நிலை மற்றும் வன்பொருள் கட்டுப்பாடு.

NoOpஅறுவை சிகிச்சை இல்லை / உயிருடன் வைத்திருத்தல்.
Testஅடிப்படை இணைப்புச் சோதனை.
DeviceDateTimeசாதனத்தின் தேதி மற்றும் நேரத்தைப் பெறுங்கள் அல்லது அமைக்கவும்.
DeviceAuthenticateசாதனத்தை சேவையகத்துடன் அங்கீகரிக்கவும்.
DeviceConfigureசாதனத்தில் ஒரு உள்ளமைவு பேலோடைப் பயன்படுத்துங்கள்.
DevicePostConnectionTasksஇணைப்புக்குப் பிந்தைய துவக்கப் பணிகளை இயக்கவும்.
DeviceStorageLoadசாதனத்தில் உள்ள சேமிப்பகத்திலிருந்து தரவை ஏற்றவும்.
DeviceLoadCustomAudioதனிப்பயன் ஆடியோ கோப்புகளை சாதனத்தில் ஏற்றவும்.
DeviceCoredumpSendசெயலிழப்பு கோர் டம்ப்பை சர்வரில் பதிவேற்றவும்.
DeviceAttachசாதனத்தை ஒரு சேவையக அமர்வுடன் இணைக்கவும்.
DeviceDetachசேவையக அமர்விலிருந்து சாதனத்தைத் துண்டிக்கவும்.
DeviceLogSendசாதனப் பதிவுகளை சர்வரில் பதிவேற்றவும்.
DeviceConnectionTestசேவையக இணைப்புத்தன்மையைச் சோதிக்கவும்.
DeviceStatusSendசாதனத்தின் நிலையை சேவையகத்திற்கு அனுப்பவும்.
DeviceStatusGetசாதனத்தின் தற்போதைய நிலையைப் பெறுங்கள்.
DeviceInteractionஒரு சாதன ஊடாடல் நிகழ்வைத் தூண்டவும்.
DeviceSetAPIHostAPI சேவையக ஹோஸ்டை அமைக்கவும்.
DeviceTestMicsமைக்ரோஃபோன் சுய சோதனையை இயக்கவும்.
HardwareI2CCommandஒரு வன்பொருள் புறக்கருவிக்கு மூல I2C கட்டளையை அனுப்பவும்.

தொடர்பு கட்டளைகள்

அழைப்புகளைத் தொடங்குதல், செய்திகளை அனுப்புதல், செயலில் உள்ள தகவல் தொடர்பு அமர்வுகளை நிர்வகித்தல் மற்றும் பதிவைக் கட்டுப்படுத்துதல்.

CommunicateChannelJoinஒரு தகவல் தொடர்பு சேனலில் இணையுங்கள்.
CommunicateChannelLeaveஒரு தகவல் தொடர்பு வழியை விட்டுச் செல்லுங்கள்.
CommunicateChannelChangeவேறு சேனலுக்கு மாற்றவும்.
CommunicateChannelCloseஒரு தகவல் தொடர்பு வழியை மூடு.
CommunicateReceiveIncomingஉள்வரும் தகவல் தொடர்பு குறித்து சாதனத்திற்குத் தெரிவிக்கவும்.
CommunicateRequestOutgoingவெளிச்செல்லும் தகவல்தொடர்பு ஒன்றைக் கோருங்கள்.
CommunicateVCPActivateகுரல் தொடர்பு நெறிமுறை அமர்வைச் செயல்படுத்தவும்.
CommunicateVCPDeactivateVCP அமர்வைச் செயலிழக்கச் செய்யவும்.
CommunicateRecordingActivateசெயலில் உள்ள தகவல்தொடர்பைப் பதிவு செய்யத் தொடங்குங்கள்.
CommunicateIncomingAcceptஉள்வரும் அழைப்பை ஏற்கவும்.
CommunicateIncomingRejectஉள்வரும் அழைப்பை நிராகரிக்கவும்.
CommunicateHFPCallStartபுளூடூத் HFP தொலைபேசி அழைப்பைத் தொடங்கவும்.
CommunicateHFPCallEndபுளூடூத் HFP தொலைபேசி அழைப்பை முடிக்கவும்.
CommunicateContentStartசாதனத்திற்கு ஒலி உள்ளடக்கத்தை அனுப்பத் தொடங்குங்கள்.
CommunicateContentStopஆடியோ உள்ளடக்கத்தை ஸ்ட்ரீம் செய்வதை நிறுத்துங்கள்.
SocketReceiveStatusவெப் சாக்கெட் நிலை குறித்த புதுப்பிப்பைப் பெறுங்கள்.

ஆடியோ கட்டளைகள்

ஸ்பீக்கர் ஒலியளவு, மைக்ரோஃபோன் கெயின், ஆடியோ புரொஃபைல்கள் மற்றும் உரையை பேச்சாக மாற்றும் வசதி ஆகியவற்றைக் கட்டுப்படுத்தலாம்.

AudioPlayStorageசாதனத்தில் உள்ள சேமிப்பகத்திலிருந்து ஒரு ஆடியோ கோப்பை இயக்கவும்.
AudioPlayContentஸ்ட்ரீம் செய்யப்பட்ட ஆடியோ உள்ளடக்கத்தை இயக்கவும்.
AudioSetVolumeஸ்பீக்கர் வெளியீட்டு ஒலியளவை அமைக்கவும்.

LED கட்டளைகள்

பேட்ஜ் இண்டிகேட்டர் விளக்கில் LED நிறம், பிரகாசம் மற்றும் அனிமேஷன் வடிவங்களை அமைக்கவும்.

DeviceIlluminationSetLED-யின் நிறத்தையும் ஒளிரும் முறையையும் அமைக்கவும்.

உள் கட்டளைகள்

சூழல் வழங்கல், சேனல் வரலாறு, குரல் பதிவு மற்றும் ஆடியோ டிகோடிங் ஆகியவற்றிற்காகப் பயன்படுத்தப்படும் உள்ளக அனுப்பீட்டுக் கட்டளைகள்.

InternalSendContextசூழல் தரவை உள்ளக சூழல் கையாளிக்கு அனுப்பவும்.
InternalSendChannelHistoryசேனல் வரலாற்றை உள் கையாளுநருக்கு அனுப்பவும்.
InternalRequestVocalizationஉரையை பேச்சாக மாற்றும் குரல் செயலாக்கத்தை உள்ளகமாகக் கோருங்கள்.
InternalHandleVocalizationRTPஉள்வரும் குரல் பதிவு RTP ஸ்ட்ரீமைக் கையாளவும்.
InternalDecodeAudioஉள்வரும் ஒலி ஓடையை டிகோட் செய்யவும்.

மொபைல் கட்டளைகள்

இணைக்கப்பட்ட மொபைல் செயலியுடன் பேட்ஜை ஒருங்கிணைப்பதற்கான கட்டளைகள் — புஷ் அறிவிப்புகள், செயலி நிலை ஒத்திசைவு மற்றும் டீப் லிங்கிங்.

MobileServiceStatusமொபைல் சேவையின் நிலையைச் சாதனத்திற்குத் தெரிவிக்கவும். (மொபைல் → சாதனம்)
MobileSocketOpenவெப் சாக்கெட் இணைப்பைத் திறக்குமாறு மொபைல் செயலிக்கு அறிவுறுத்துங்கள். (சாதனம் → மொபைல்)
MobileSocketCloseவெப் சாக்கெட் இணைப்பை மூடுமாறு மொபைல் செயலிக்கு அறிவுறுத்துங்கள். (சாதனம் → மொபைல்)
MobileSocketStatusவெப் சாக்கெட்டின் நிலையை மொபைல் செயலிக்குத் தெரிவிக்கவும். (சாதனம் → மொபைல்)
MobileReceiveStatusபெறப்பட்ட நிலையை மொபைல் செயலிக்கு தெரிவிக்கவும். (சாதனம் → மொபைல்)
MobileSocketUpdateமொபைல் செயலிக்கு ஒரு வெப்சாக்கெட் தரவுப் புதுப்பிப்பை அனுப்பவும். (சாதனம் → மொபைல்)
MobilePTTStartPTT பரிமாற்றம் தொடங்கிவிட்டது என்பதை மொபைல் செயலிக்குத் தெரிவிக்கவும். (சாதனம் → மொபைல்)
MobilePTTStopPTT பரிமாற்றம் முடிவடைந்ததை மொபைல் செயலிக்குத் தெரிவிக்கவும். (சாதனம் → மொபைல்)
MobileContextSetமொபைல் செயலியில் சூழல் தரவை அமைக்கவும். (சாதனம் → மொபைல்)
MobileEchoமொபைல் இணைப்புத்திறனைச் சோதிப்பதற்கான எக்கோ கட்டளை. (சாதனம் → மொபைல்)

கட்டுவதற்குத் தயாரா?

கனெக்ஷன் டெவலப்பர் சமூகத்தில் இணைந்து, சாண்ட்பாக்ஸ் சாதனங்கள், SDK-கள் மற்றும் பிரத்யேக ஆதரவுக்கான அணுகலைப் பெறுங்கள்.