แพลตฟอร์มสำหรับนักพัฒนา

สร้างต่อยอดจาก
แพลตฟอร์มการเชื่อมต่อ

API สองตัวที่มีประสิทธิภาพสูง ได้แก่ API เซิร์ฟเวอร์ RESTful สำหรับการจัดการอุปกรณ์และการประสานงานการสื่อสาร และโปรโตคอล CBBP ระดับต่ำสำหรับการควบคุมบัตรโดยตรง

เอกสารอ้างอิง REST APIโปรโตคอล CBBP
โอเพนเอพีไอ 3.0เจซอน / เรสท์บลูทูธ + ไวไฟการสนับสนุน Webhook
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

เรสต์ API

การจัดการวงจรชีวิตของอุปกรณ์อย่างครบวงจร — การจัดเตรียม การกำหนดค่า เฟิร์มแวร์ การสื่อสาร และการวิเคราะห์ — ผ่านโปรโตคอล HTTPS มาตรฐาน

สำรวจ REST API →

โปรโตคอล CBBP

โปรโตคอลพื้นฐานของ Com Badge — โปรโตคอลคำสั่ง JSON สำหรับควบคุมอุปกรณ์โดยตรงผ่าน Bluetooth (แอป), WiFi (พร็อกซีเซิร์ฟเวอร์) หรือการควบคุมภายในเครื่อง

สำรวจ CBBP →

เว็บฮุค

สมัครรับข้อมูลเหตุการณ์แบบเรียลไทม์จากอุปกรณ์ เช่น การสื่อสาร การเปลี่ยนแปลงสถานะ การอัปเดตตำแหน่ง โดยส่งข้อมูลผ่านโปรโตคอล HTTP POST ไปยังปลายทางของคุณ

สำรวจ Webhooks →

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.

เริ่มต้นใช้งาน

การตรวจสอบสิทธิ์

Connection API ใช้การตรวจสอบสิทธิ์ด้วย Bearer token คำขอทั้งหมดต้องมี JWT access token ที่ถูกต้องในส่วนหัว Authorization

รับโทเค็น

ส่งข้อมูลประจำตัวของคุณไปยังเอนด์พอยต์การตรวจสอบสิทธิ์ด้วยวิธีการ 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
  }
}
เรสต์ API

ภาพรวม REST API

Connection Server REST API ให้การเข้าถึงอุปกรณ์ โครงสร้างพื้นฐานการสื่อสาร และการวิเคราะห์ข้อมูลของคุณได้อย่างเต็มรูปแบบผ่านการเขียนโปรแกรม โดยปฏิบัติตามหลักการ RESTful ด้วยเนื้อหาคำขอ/การตอบกลับในรูปแบบ JSON

การตรวจสอบสิทธิ์ API
ผู้ใช้
อุปกรณ์
ช่องต่างๆ
การสื่อสาร
ออดิโอบริดจ์
การสนทนา
เนื้อหา
สถานที่ตั้ง
การแจ้งเตือนแบบพุช
พื้นที่จัดเก็บ
การดำเนินงานจำนวนมาก
วันที่และเวลา

การตรวจสอบสิทธิ์

การตรวจสอบสิทธิ์แบบใช้โทเค็น การเข้าสู่ระบบจะส่งคืนโทเค็นที่ต้องส่งเป็น Authorization: Token<token> สำหรับคำขอครั้งต่อๆ ไปทั้งหมด

POST/api/v1/loginยืนยันตัวตนผู้ใช้และรับโทเค็นการยืนยันตัวตน
POST/api/v1/login-deviceยืนยันตัวตนอุปกรณ์ด้วย UUID และที่อยู่ 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รับข้อมูล core dump จากอุปกรณ์
PATCH/api/v1/devices/crash/{uuid}อัปเดตบันทึกข้อผิดพลาด

ตัวแทน CBBP

ส่งคำสั่ง CBBP ใดๆ ไปยังอุปกรณ์ผ่านทางเซิร์ฟเวอร์ เซิร์ฟเวอร์จะส่งต่อคำสั่งผ่านการเชื่อมต่อ WiFi ของอุปกรณ์และส่งการตอบกลับไปยังอุปกรณ์ การตอบกลับคำสั่ง outgoing-make ยังฝังข้อความ CBBPMessage ที่อุปกรณ์จะดำเนินการทันที

POST/api/v1/devices/device/{device_uuid}/cbbpส่งคำสั่ง CBBP ไปยังอุปกรณ์ผ่านทางเซิร์ฟเวอร์
GET/api/v1/devices/device/{device_uuid}/cbbp/{uuid}เรียกดูสถานะและผลตอบกลับของคำสั่ง CBBP ที่ส่งไปก่อนหน้านี้

เนื้อหาคำขอคือซองคำสั่ง CBBP อ็อบเจ็กต์ CBBPCommand ที่จัดเก็บไว้จะติดตามสถานะการส่ง: ไม่ได้ส่ง → ส่งแล้ว → ได้รับแล้ว หรือ หมดเวลา

ตรวจสอบโดยใช้คำสั่ง Poll GET /cbbp/ เพื่อตรวจสอบว่าอุปกรณ์ได้รับและตอบสนองต่อคำสั่งหรือไม่
คำขอ — ข้อความขาออก
{
  "outgoingMessage": {
    "command": "WiFiScan"
  }
}
การตอบสนอง — สถานะคำสั่ง CBBP
{
  "uuid": "a3f2...",
  "status": "SENT",
  "device": "d7f3a1b2-...",
  "dateSent": "2025-09-15T14:22:01Z",
  "outgoingMessage": { /* echoed */ },
  "incomingMessage": null
}

ช่องต่างๆ

ช่องทางการสื่อสาร (Channels) เป็นองค์ประกอบพื้นฐานในการสื่อสาร ประเภทของช่องทางการสื่อสาร ได้แก่ ChannelPeople, ChannelGroup, ChannelContact, ChannelContactNumber, ChannelExternalNumber, ChannelService และ ChannelRecorder

GET/api/v1/channels/channelแสดงรายการช่องทาง โดยสามารถกรองตามประเภทของวัตถุได้ (ถ้าต้องการ)
POST/api/v1/channels/channelสร้างช่องทาง (ChannelGroup, ChannelContact หรือ ChannelExternalNumber)
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ค้นหาช่องทางต่างๆ โดยใช้สตริงคำค้นหา และตัวกรองประเภทเพิ่มเติม (ถ้ามี)

การสื่อสาร

เริ่มต้นและจัดการเซสชันการสื่อสารที่ใช้งานอยู่ เช่น การโทรออก การประชุมทางวิดีโอ การบันทึก และการสตรีมเนื้อหา การตอบสนองการโทรออกจะรวมถึงข้อความ CBBPMessage ที่อุปกรณ์จะดำเนินการทันที

POST/api/v1/communicate/outgoing-makeเริ่มต้นช่องทางการสื่อสารขาออกไปยัง ChannelPeople, 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-deactivateปิดใช้งาน VCP แล้วกลับไปยังช่องสัญญาณก่อนหน้าใดๆ
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สร้างไฟล์เสียงสำหรับสรุปบทสนทนา

การสนทนา

การสนทนาที่ขับเคลื่อนด้วย AI โดยใช้ 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เพิ่มข้อความจากผู้ใช้และรับข้อความตอบกลับจาก AI

เนื้อหา

เรียกดูและเล่นเนื้อหาเสียงแบบสตรีมมิ่งบนอุปกรณ์ต่างๆ เนื้อหาจะถูกจัดเรียงเป็นหมวดหมู่ และสามารถกรองเนื้อหาที่ได้รับความนิยมตามเมือง ภูมิภาค หรือประเทศได้

GET/api/v1/content/categoriesรับโครงสร้างหมวดหมู่เนื้อหาแบบต้นไม้
GET/api/v1/content/contentแสดงรายการเนื้อหาที่มีอยู่ภายในหมวดหมู่
GET/api/v1/content/popularแสดงรายการเนื้อหาที่เป็นที่นิยมสำหรับเมือง ภูมิภาค หรือประเทศที่กำหนด

สถานที่ตั้ง

แปลงพิกัดทางภูมิศาสตร์ให้เป็นโครงสร้างข้อมูลเมือง ภูมิภาค และประเทศ ซึ่งอุปกรณ์ต่างๆ จะใช้เมื่อนำเข้าบริบท

POST/api/v1/location/determineแปลงค่าละติจูด/ลองจิจูดให้เป็นเมือง ภูมิภาค และประเทศ

การแจ้งเตือนแบบพุช

ลงทะเบียนแอปพลิเคชันบนมือถือเพื่อรับการแจ้งเตือนแบบพุชจาก FCM รองรับระบบ iOS, Android และเว็บไซต์

POST/api/v1/push-notifications/pushลงทะเบียนแอปพลิเคชันบนมือถือเพื่อรับการแจ้งเตือนแบบพุชจาก FCM (iOS, Android, เว็บ)

พื้นที่จัดเก็บ

ดาวน์โหลดไฟล์ที่จัดเก็บไว้ในวัตถุโมเดล และเรียกใช้ฟังก์ชันลบพื้นหลังรูปภาพ (จะได้ผลลัพธ์ในรูปแบบเข้ารหัส base64)

GET/api/v1/storage/retrieve/{path}ดาวน์โหลดไฟล์ที่จัดเก็บไว้ตามเส้นทาง
POST/api/v1/storage/remove-backgroundลบพื้นหลังออกจากรูปภาพ (ส่งค่ากลับเป็น base64)

การดำเนินงานจำนวนมาก

เรียกใช้งาน API หลายรายการในคำขอ HTTP เดียว ส่งค่า single_transaction=true เพื่อรวมการดำเนินการทั้งหมดไว้ในธุรกรรมเดียว หากเกิดข้อผิดพลาดกับรายการใดรายการหนึ่ง การดำเนินการทั้งหมดจะถูกยกเลิก

POST/api/v1/bulkเรียกใช้งานการดำเนินการ API หลายรายการในคำขอเดียว โดยสามารถเลือกที่จะทำเป็นธุรกรรมอะตอมิกเดียวได้

วันที่และเวลา

ส่งคืนวันที่และเวลาปัจจุบันของเซิร์ฟเวอร์ในรูปแบบ GMT+0 ไม่จำเป็นต้องมีการตรวจสอบสิทธิ์ อุปกรณ์ต่างๆ ใช้ฟังก์ชันนี้เพื่อซิงค์นาฬิกาภายในของตนเอง

GET/api/v1/current-datetimeส่งคืนวันที่และเวลาปัจจุบันในรูปแบบ GMT+0
โปรโตคอล CBBP

โปรโตคอลพื้นฐานของตราสัญลักษณ์ Com

CBBP เป็นโปรโตคอลคำสั่ง JSON น้ำหนักเบาสำหรับการโต้ตอบโดยตรงกับอุปกรณ์ Connection badge ช่วยให้คุณควบคุมฟังก์ชันฮาร์ดแวร์และซอฟต์แวร์ทั้งหมดบนอุปกรณ์ได้อย่างเต็มที่

รูปแบบข้อความ

การสื่อสารแต่ละครั้งระหว่างอุปกรณ์กับ CBBP ประกอบด้วยข้อความคำสั่งที่ส่งไปยังอุปกรณ์ และข้อความผลลัพธ์ที่อุปกรณ์ส่งกลับมา

ฟิลด์ object ในทั้งคำขอและการตอบกลับจะบรรจุข้อมูลเฉพาะคำสั่ง และอาจถูกละเว้นได้หากไม่จำเป็น

เอกสารขั้นตอนการดำเนินงานฉบับเต็มมีให้สำหรับพันธมิตรที่ลงทะเบียนแล้ว ติดต่อตัวแทนธุรกิจ Connection ของคุณ หรือติดต่อเราได้ที่ 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 สามารถส่งไปยังบัตรประจำตัวได้ผ่านช่องทางการส่งสามแบบที่แตกต่างกัน ขึ้นอยู่กับสถาปัตยกรรมการผสานรวมของคุณ

บลูทูธ (แอป)

ส่งคำสั่ง CBBP โดยตรงจากแอปบนมือถือผ่าน BLE ต้องจับคู่กับอุปกรณ์และอยู่ในระยะที่กำหนด

SDK สำหรับมือถือ

WiFi หรือ Bluetooth ผ่านเซิร์ฟเวอร์

เรียกใช้ CBBP ผ่าน REST API โดยใช้คำสั่ง POST /devices//cbbp เซิร์ฟเวอร์จะทำการส่งต่อไปยังอุปกรณ์โดยอัตโนมัติผ่าน Wi-Fi หรือ Bluetooth ขึ้นอยู่กับวิธีการเชื่อมต่อของป้าย วิธีนี้มักใช้สำหรับการผสานรวมในระบบแบ็กเอนด์

เรสต์ API

การจัดส่งภายใน

การส่งคำสั่ง CBBP ภายในอุปกรณ์หรือระหว่างกระบวนการ ใช้โดยเฟิร์มแวร์ของบัตรเพื่อกำหนดเส้นทางคำสั่งระหว่างระบบย่อยภายใน

เฉพาะเฟิร์มแวร์

คำสั่งพลังงาน

ควบคุมสถานะพลังงานของอุปกรณ์ — โหมดพักเครื่อง โหมดปลุกเครื่อง โหมดรีบูต และโหมดรีเซ็ตเป็นค่าจากโรงงาน

PowerRebootโปรดรีบูตอุปกรณ์ทันที
PowerDeepsleepเข้าสู่โหมดประหยัดพลังงาน (โหมดประหยัดพลังงานขั้นสูง)
FactoryResetลบการตั้งค่าทั้งหมดและรีเซ็ตเป็นการตั้งค่าเริ่มต้นจากโรงงาน

คำสั่ง WiFi

ตั้งค่าเครือข่ายไร้สาย สแกนหา AP ตรวจสอบสถานะการเชื่อมต่อ และจัดการข้อมูลประจำตัวที่บันทึกไว้

WiFiScanสแกนหาจุดเชื่อมต่อ WiFi ที่ใช้งานได้
WiFiAPTestทดสอบการเชื่อมต่อกับจุดเชื่อมต่อ WiFi ที่กำหนด
WiFiAPJoinเชื่อมต่อกับจุดเชื่อมต่อ WiFi โดยใช้ข้อมูลประจำตัวที่ให้ไว้

คำสั่งบลูทูธ

ควบคุมการโฆษณา BLE การจับคู่ และการสื่อสารระหว่างอุปกรณ์

BTScanBTค้นหาอุปกรณ์บลูทูธแบบคลาสสิก
BTScanBLEสแกนหาอุปกรณ์ BLE
DeviceBLEServiceAvailableทำเครื่องหมายว่าบริการ BLE พร้อมใช้งานแล้ว
DeviceBLEServiceUnavailableระบุว่าบริการ BLE ไม่พร้อมใช้งาน
DeviceBLEActiveตั้งค่าวิทยุ BLE ให้อยู่ในสถานะใช้งาน
DeviceBLEIdleตั้งค่าวิทยุ BLE ให้อยู่ในสถานะไม่ได้ใช้งาน
DeviceBLEAdvChannelAddเพิ่มช่องสัญญาณลงในเพย์โหลดการโฆษณา BLE
DeviceBTScanเริ่มการสแกนอุปกรณ์บลูทูธ
DeviceBTA2DStartเริ่มการสตรีมเสียง A2DP ผ่านบลูทูธ
DeviceBTA2DEndสิ้นสุดการสตรีมเสียง Bluetooth A2DP
DeviceBTNativeAssistStartเริ่มใช้งานผู้ช่วยเสียงบลูทูธในตัว
DeviceBTNativeAssistEndปิดระบบผู้ช่วยเสียงบลูทูธดั้งเดิม

คำสั่งการตั้งค่า

อ่านและเขียนข้อมูลการตั้งค่าอุปกรณ์ — ชื่อที่แสดง, เขตเวลา, ภาษา และแฟล็กคุณสมบัติ

SettingsListGetดึงข้อมูลการตั้งค่าทั้งหมดในรูปแบบรายการคู่คีย์-ค่า
SettingsListSetเขียนค่าการตั้งค่าหลายค่าพร้อมกัน
SettingsGetดึงค่าของการตั้งค่าเดียวโดยใช้คีย์
SettingsSetกำหนดค่าของการตั้งค่าเพียงรายการเดียว
SettingsSendส่งการตั้งค่าปัจจุบันไปยังเซิร์ฟเวอร์
SettingsClearล้างค่าการตั้งค่าเฉพาะให้ชัดเจน
SettingsEraseลบการตั้งค่าที่บันทึกไว้ทั้งหมด

คำสั่งเฟิร์มแวร์

สั่งการอัปเดตเฟิร์มแวร์แบบ OTA ตรวจสอบสถานะการอัปเดต และสอบถามเวอร์ชันเฟิร์มแวร์ปัจจุบันบนอุปกรณ์

FirmwareCheckตรวจสอบว่ามีการอัปเดตเฟิร์มแวร์หรือไม่
FirmwareUpdateเริ่มการอัปเดตเฟิร์มแวร์แบบ OTA
FirmwareValidateตรวจสอบความถูกต้องของไฟล์เฟิร์มแวร์ที่ดาวน์โหลดมา

คำสั่งอุปกรณ์

วงจรชีวิตของอุปกรณ์ การตรวจสอบสิทธิ์ การกำหนดค่า การบันทึกข้อมูล สถานะ และการควบคุมฮาร์ดแวร์

NoOpไม่มีการดำเนินการ / รักษาการทำงานไว้
Testการทดสอบการเชื่อมต่อขั้นพื้นฐาน
DeviceDateTimeตรวจสอบหรือตั้งค่าวันที่และเวลาของอุปกรณ์
DeviceAuthenticateยืนยันตัวตนอุปกรณ์กับเซิร์ฟเวอร์
DeviceConfigureใส่ข้อมูลการกำหนดค่าลงในอุปกรณ์
DevicePostConnectionTasksเรียกใช้งานกระบวนการเริ่มต้นหลังการเชื่อมต่อ
DeviceStorageLoadโหลดข้อมูลจากหน่วยความจำภายในอุปกรณ์
DeviceLoadCustomAudioโหลดไฟล์เสียงที่กำหนดเองลงในอุปกรณ์
DeviceCoredumpSendอัปโหลดไฟล์ดัมพ์คอร์ที่เกิดข้อผิดพลาดไปยังเซิร์ฟเวอร์
DeviceAttachเชื่อมต่ออุปกรณ์เข้ากับเซสชันเซิร์ฟเวอร์
DeviceDetachถอดอุปกรณ์ออกจากเซสชันเซิร์ฟเวอร์
DeviceLogSendอัปโหลดบันทึกข้อมูลอุปกรณ์ไปยังเซิร์ฟเวอร์
DeviceConnectionTestทดสอบการเชื่อมต่อเซิร์ฟเวอร์
DeviceStatusSendส่งสถานะอุปกรณ์ไปยังเซิร์ฟเวอร์
DeviceStatusGetตรวจสอบสถานะปัจจุบันของอุปกรณ์
DeviceInteractionกระตุ้นเหตุการณ์การโต้ตอบกับอุปกรณ์
DeviceSetAPIHostตั้งค่าโฮสต์เซิร์ฟเวอร์ API
DeviceTestMicsทำการทดสอบไมโครโฟนด้วยตนเอง
HardwareI2CCommandส่งคำสั่ง I2C ดิบไปยังอุปกรณ์ต่อพ่วงฮาร์ดแวร์

คำสั่งการสื่อสาร

โทรออก ส่งข้อความ จัดการเซสชันการสื่อสารที่กำลังดำเนินอยู่ และควบคุมการบันทึก

CommunicateChannelJoinเข้าร่วมช่องทางการสื่อสาร
CommunicateChannelLeaveปิดช่องทางการติดต่อสื่อสาร
CommunicateChannelChangeเปลี่ยนไปดูช่องอื่น
CommunicateChannelCloseปิดช่องทางการสื่อสาร
CommunicateReceiveIncomingแจ้งให้อุปกรณ์ทราบเมื่อมีสายเรียกเข้า
CommunicateRequestOutgoingขอทำการติดต่อสื่อสารออกไปภายนอก
CommunicateVCPActivateเปิดใช้งานเซสชันโปรโตคอลการสื่อสารด้วยเสียง
CommunicateVCPDeactivateปิดใช้งานเซสชัน VCP
CommunicateRecordingActivateเริ่มบันทึกการสื่อสารที่เกิดขึ้นจริง
CommunicateIncomingAcceptรับสายเรียกเข้า
CommunicateIncomingRejectปฏิเสธสายเรียกเข้า
CommunicateHFPCallStartเริ่มการโทรผ่าน Bluetooth HFP
CommunicateHFPCallEndสิ้นสุดการสนทนาทางโทรศัพท์ HFP ผ่านบลูทูธ
CommunicateContentStartเริ่มสตรีมเนื้อหาเสียงไปยังอุปกรณ์
CommunicateContentStopหยุดการสตรีมเนื้อหาเสียง
SocketReceiveStatusรับการอัปเดตสถานะ WebSocket

คำสั่งเสียง

ควบคุมระดับเสียงลำโพง, อัตราขยายไมโครโฟน, โปรไฟล์เสียง และการเล่นเสียงพูดจากข้อความ

AudioPlayStorageเล่นไฟล์เสียงจากหน่วยความจำภายในเครื่อง
AudioPlayContentเล่นเนื้อหาเสียงแบบสตรีมมิ่ง
AudioSetVolumeตั้งค่าระดับเสียงเอาต์พุตของลำโพง

คำสั่ง LED

ตั้งค่าสี LED ความสว่าง และรูปแบบแอนิเมชั่นบนไฟแสดงสถานะของป้ายชื่อ

DeviceIlluminationSetตั้งค่าสี LED และรูปแบบการส่องสว่าง

คำสั่งภายใน

คำสั่งส่งภายในที่ใช้สำหรับการส่งข้อมูลตามบริบท ประวัติช่องสัญญาณ การเปล่งเสียง และการถอดรหัสเสียง

InternalSendContextส่งข้อมูลบริบทไปยังตัวจัดการบริบทภายใน
InternalSendChannelHistoryส่งประวัติช่องสัญญาณไปยังตัวจัดการภายใน
InternalRequestVocalizationร้องขอการแปลงข้อความเป็นเสียงพูดภายในระบบ
InternalHandleVocalizationRTPจัดการสตรีมเสียง RTP ที่เข้ามา
InternalDecodeAudioถอดรหัสสัญญาณเสียงขาเข้า

คำสั่งเคลื่อนที่

คำสั่งสำหรับการประสานงานระหว่างป้ายกับแอปมือถือที่จับคู่ไว้ ได้แก่ การแจ้งเตือนแบบพุช การซิงค์สถานะแอป และการเชื่อมโยงโดยตรง

MobileServiceStatusรายงานสถานะสัญญาณโทรศัพท์มือถือไปยังอุปกรณ์ (มือถือ → อุปกรณ์)
MobileSocketOpenสั่งให้แอปบนมือถือเปิดการเชื่อมต่อ WebSocket (อุปกรณ์ → มือถือ)
MobileSocketCloseสั่งให้แอปบนมือถือปิดการเชื่อมต่อ WebSocket (อุปกรณ์ → มือถือ)
MobileSocketStatusรายงานสถานะ WebSocket ไปยังแอปบนมือถือ (อุปกรณ์ → มือถือ)
MobileReceiveStatusรายงานสถานะการรับสินค้าไปยังแอปพลิเคชันบนมือถือ (อุปกรณ์ → มือถือ)
MobileSocketUpdateส่งข้อมูลอัปเดตผ่าน WebSocket ไปยังแอปพลิเคชันบนมือถือ (อุปกรณ์ → มือถือ)
MobilePTTStartแจ้งแอปพลิเคชันบนมือถือว่าการส่งสัญญาณ PTT ได้เริ่มต้นขึ้นแล้ว (อุปกรณ์ → มือถือ)
MobilePTTStopแจ้งแอปพลิเคชันบนมือถือว่าการส่งสัญญาณ PTT สิ้นสุดลงแล้ว (อุปกรณ์ → มือถือ)
MobileContextSetตั้งค่าข้อมูลบริบทในแอปมือถือ (อุปกรณ์ → มือถือ)
MobileEchoคำสั่ง Echo สำหรับทดสอบการเชื่อมต่อมือถือ (อุปกรณ์ → มือถือ)

พร้อมสร้างแล้วหรือยัง?

เข้าร่วมชุมชนนักพัฒนา Connection และรับสิทธิ์เข้าถึงอุปกรณ์ทดสอบ (sandbox devices), SDK และการสนับสนุนเฉพาะทาง

ติดต่อเรา