Xác thực
API Kết nối sử dụng xác thực bằng mã thông báo Bearer. Tất cả các yêu cầu phải bao gồm mã thông báo truy cập JWT hợp lệ trong tiêu đề Authorization.
Nhận mã thông báo
Gửi thông tin đăng nhập của bạn đến điểm cuối xác thực bằng phương thức POST. Bạn sẽ nhận được một access_token có thời hạn ngắn và một refresh_token có thời hạn dài hơn.
Sử dụng mã thông báo
Bao gồm mã thông báo trong mỗi yêu cầu:
{
"email": "admin@yourorg.com",
"password": "••••••••"
}{
"access_token": "eyJhbG...",
"refresh_token": "dGhpcw...",
"expires_in": 3600,
"token_type": "Bearer"
}URL cơ sở và phiên bản
Tất cả các điểm cuối API đều được đánh số phiên bản tại /api/v1/. URL cơ sở phụ thuộc vào cấu hình triển khai của bạn.
Đối với các triển khai trên nền tảng đám mây, hãy sử dụng điểm cuối khu vực được chỉ định cho tổ chức của bạn. Đối với các triển khai máy chủ tại chỗ, hãy sử dụng tên máy chủ của bạn.
| Môi trường | URL cơ sở |
|---|---|
| Đám mây (Mỹ) | https://beta.connection.app/api/v1 |
| Tại chỗ | https://<your-server>/api/v1 |
Tất cả nội dung yêu cầu và phản hồi đều sử dụng application/json. Hãy thêm Content-Type: application/json vào các yêu cầu có nội dung.
Lỗi & Mã trạng thái
API sử dụng các mã trạng thái HTTP tiêu chuẩn. Phản hồi lỗi bao gồm mã mà máy tính có thể đọc được và thông báo mà con người có thể đọc được.
| Trạng thái | Nghĩa |
|---|---|
| 200 | Thành công |
| 201 | Tạo |
| 400 | Yêu cầu không hợp lệ — tham số không hợp lệ |
| 401 | Không được phép — mã thông báo bị thiếu hoặc hết hạn |
| 403 | Bị cấm — không đủ quyền |
| 404 | Không tìm thấy |
| 500 | Lỗi máy chủ nội bộ |
{
"error": {
"code": "device_not_found",
"message": "No device with that UUID exists in your organization",
"status": 404
}
}Tổng quan về API REST
API REST của Connection Server cung cấp quyền truy cập lập trình đầy đủ vào hệ thống thiết bị, cơ sở hạ tầng truyền thông và phân tích của bạn. Nó tuân theo các quy ước RESTful với phần thân yêu cầu/phản hồi dạng JSON.
Xác thực
Xác thực dựa trên mã thông báo. Hàm Login trả về một mã thông báo cần được gửi dưới dạng Authorization: Token.<token> đối với tất cả các yêu cầu tiếp theo.
Người dùng
Tạo và quản lý tài khoản người dùng. Điểm cuối GET /users/user trả về người dùng hiện đang được xác thực.
Thiết bị
Liệt kê và kiểm tra thiết bị, quản lý liên kết người dùng-thiết bị, đọc và ghi cài đặt và trạng thái cho từng thiết bị, xử lý ảnh firmware và ảnh lưu trữ, và nhận nhật ký và báo cáo sự cố.
CBBP Proxy
Gửi bất kỳ lệnh CBBP nào đến thiết bị thông qua máy chủ. Máy chủ sẽ chuyển tiếp lệnh qua kết nối WiFi của thiết bị và trả về phản hồi từ thiết bị. Phản hồi outgoing-make cũng nhúng một thông điệp CBBPMessage mà thiết bị sẽ thực thi ngay lập tức.
Phần thân yêu cầu là một phong bì lệnh CBBP. Đối tượng CBBPCommand được lưu trữ theo dõi trạng thái gửi: UNSET → SENT → RECEIVED hoặc TIMED_OUT.
{
"outgoingMessage": {
"command": "WiFiScan"
}
}{
"uuid": "a3f2...",
"status": "SENT",
"device": "d7f3a1b2-...",
"dateSent": "2025-09-15T14:22:01Z",
"outgoingMessage": { /* echoed */ },
"incomingMessage": null
}Kênh
Kênh là các thành phần cơ bản của giao tiếp. Các loại kênh bao gồm ChannelPeople, ChannelGroup, ChannelContact, ChannelContactNumber, ChannelExternalNumber, ChannelService và ChannelRecorder.
Giao tiếp
Khởi tạo và quản lý các phiên giao tiếp đang hoạt động — cuộc gọi đi, VCP, ghi âm và phát trực tuyến nội dung. Phản hồi cuộc gọi đi bao gồm một CBBPMessage mà thiết bị sẽ xử lý ngay lập tức.
Cầu nối âm thanh
Truy cập các bản ghi âm cuộc hội thoại qua ứng dụng Bridge, bao gồm toàn bộ bản ghi chép, danh sách người tham gia và tóm tắt do AI tạo ra. Hỗ trợ nhiều mẫu tóm tắt (ghi chú cuộc họp, ghi chú bài học, chăm sóc sức khỏe, v.v.) và tạo âm thanh TTS cho phần tóm tắt.
Cuộc trò chuyện
Phiên hội thoại được hỗ trợ bởi trí tuệ nhân tạo sử dụng ChatGPT, Gemini hoặc công cụ gốc. Hỗ trợ nhiều vai trò người dùng (Bác sĩ, Gia sư, Thợ máy, v.v.) và lịch sử tin nhắn được phân trang.
Nội dung
Duyệt và phát nội dung âm thanh trực tuyến trên các thiết bị. Nội dung được sắp xếp theo cấu trúc cây thư mục; bạn có thể lọc nội dung phổ biến theo thành phố, khu vực hoặc quốc gia.
Địa điểm
Giải quyết các tọa độ địa lý thành các đối tượng có cấu trúc về thành phố, khu vực và quốc gia. Được các thiết bị sử dụng khi tiếp nhận ngữ cảnh.
Thông báo đẩy
Đăng ký ứng dụng di động để nhận thông báo đẩy từ FCM. Hỗ trợ các nền tảng iOS, Android và web.
Kho
Tải xuống các tệp được lưu trữ trên các đối tượng mô hình và chạy chức năng xóa nền ảnh (trả về kết quả được mã hóa base64).
Vận hành số lượng lớn
Thực hiện nhiều thao tác API trong một yêu cầu HTTP duy nhất. Truyền tham số `single_transaction=true` để gói tất cả các thao tác trong một giao dịch nguyên tử duy nhất — nếu bất kỳ mục nào thất bại, toàn bộ lô giao dịch sẽ được hoàn tác.
Ngày & Giờ
Trả về ngày giờ hiện tại của máy chủ theo múi giờ GMT+0. Không yêu cầu xác thực. Được các thiết bị sử dụng để đồng bộ hóa đồng hồ nội bộ của chúng.
Giao thức cơ bản của huy hiệu Com
CBBP là một giao thức lệnh JSON nhẹ dùng để tương tác trực tiếp với các thẻ Connection. Nó cho phép bạn kiểm soát hoàn toàn mọi chức năng phần cứng và phần mềm trên thiết bị.
Định dạng tin nhắn
Mỗi tương tác CBBP bao gồm một thông điệp lệnh được gửi đến thiết bị và một thông điệp kết quả được thiết bị trả về.
Trường đối tượng trong cả yêu cầu và phản hồi đều chứa dữ liệu cụ thể của lệnh và có thể được bỏ qua khi không cần thiết.
{
"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
}
}Chuyên chở
Các thông điệp CBBP có thể được gửi đến thẻ thông qua ba phương thức truyền tải khác nhau tùy thuộc vào kiến trúc tích hợp của bạn.
Bluetooth (Ứng dụng)
Gửi lệnh CBBP trực tiếp từ ứng dụng di động qua BLE. Yêu cầu thiết bị phải được ghép nối và nằm trong phạm vi kết nối.
Bộ công cụ phát triển phần mềm di động (Mobile SDK)WiFi hoặc Bluetooth thông qua máy chủ
Thông qua API REST, máy chủ sẽ tự động định tuyến đến thiết bị bằng CBBP (Proxy CBBP) — POST /devices//cbbp. Máy chủ sẽ tự động định tuyến đến thiết bị qua WiFi hoặc Bluetooth tùy thuộc vào cách kết nối của thẻ. Phương pháp này thường được sử dụng cho các tích hợp phía máy chủ.
API RESTĐiều phối nội bộ
Điều phối CBBP trên thiết bị hoặc giữa các tiến trình. Được phần mềm điều khiển của huy hiệu sử dụng để định tuyến các lệnh giữa các hệ thống con nội bộ.
Chỉ phần mềmLệnh nguồn
Kiểm soát trạng thái nguồn của thiết bị — chế độ ngủ, thức dậy, khởi động lại và khôi phục cài đặt gốc.
Lệnh WiFi
Cấu hình mạng không dây, quét tìm điểm truy cập (AP), kiểm tra trạng thái kết nối và quản lý thông tin đăng nhập đã lưu.
Lệnh Bluetooth
Kiểm soát việc quảng cáo BLE, ghép nối và giao tiếp giữa các thiết bị định vị.
Lệnh cài đặt
Đọc và ghi cấu hình thiết bị — tên hiển thị, múi giờ, ngôn ngữ và các cờ tính năng.
Lệnh phần mềm
Kích hoạt cập nhật firmware OTA, kiểm tra trạng thái cập nhật và truy vấn phiên bản firmware hiện tại trên thiết bị.
Lệnh thiết bị
Vòng đời thiết bị, xác thực, cấu hình, ghi nhật ký, trạng thái và điều khiển phần cứng.
Lệnh liên lạc
Thực hiện cuộc gọi, gửi tin nhắn, quản lý các phiên giao tiếp đang hoạt động và điều khiển ghi âm.
Lệnh âm thanh
Điều chỉnh âm lượng loa, độ nhạy micro, cấu hình âm thanh và phát lại văn bản thành giọng nói.
Lệnh LED
Thiết lập màu sắc, độ sáng và kiểu hoạt ảnh cho đèn báo hiệu trên huy hiệu.
Lệnh nội bộ
Các lệnh điều phối nội bộ được sử dụng để cung cấp ngữ cảnh, lịch sử kênh, phát âm và giải mã âm thanh.
Lệnh di động
Các lệnh để phối hợp huy hiệu với ứng dụng di động được ghép nối — thông báo đẩy, đồng bộ trạng thái ứng dụng và liên kết sâu.