Dùng HTTPS API và WebSocket API của UCM6300
UCM6300 cung cấp HTTPS API để ứng dụng bên thứ ba truy vấn, chỉnh cấu hình và điều khiển cuộc gọi, cùng WebSocket API cho kết nối hai chiều nhận sự kiện thời gian thực. Bạn bật API trong Web UI, đặt username/password, xác thực bằng challenge/response (MD5), rồi gọi API qua HTTPS hoặc kết nối wss tới cổng 8089.
Cần chuẩn bị gì?
- UCM6300 chạy HTTPS (nếu UCM dùng HTTP thì không dùng được API)
- Quyền quản trị để bật API và đặt username/password
- Ứng dụng/máy chủ bên thứ ba kết nối được tới UCM qua HTTPS/WSS
- API dùng chung chứng thư với cổng web của UCM
Các bước
-
Bật HTTPS API trên UCM
Vào Integrations > API Configuration > HTTPS API Settings (New) (firmware cũ có thể nằm ở Other Features > API Configuration), tích Enable và đặt Username, Password dùng để kết nối API.
Trường Ý nghĩa Mặc định Enable Bật/tắt API Tắt Username Tài khoản xác thực API Tự đặt Password Mật khẩu xác thực API Tự đặt Port Cổng kết nối HTTPS 8089 Call Control Cho phép điều khiển cuộc gọi qua API Tùy chọn -
Xác thực challenge/response
Luồng đăng nhập: (1) gửi action challenge kèm username và version để lấy chuỗi challenge; (2) tạo mã băm MD5 từ challenge + password; (3) gửi action login với username và token để nhận cookie phiên; (4) các yêu cầu sau gắn kèm cookie đó.
-
Duy trì phiên HTTPS API
Phiên HTTPS hết hạn sau 5 phút không hoạt động. Dùng action ping để giữ phiên mà không thay đổi cấu hình.
-
Kết nối WebSocket API
Mở kết nối tới wss://[PBX IP]:8089/websockify (ví dụ wss://192.168.129.49:8089/websockify). Có thể tái dùng cookie đã sinh từ HTTPS API, hoặc gửi action challenge rồi đăng nhập như trên. WebSocket giữ phiên dài cho tới khi logout.
-
Giữ phiên và đăng ký sự kiện WebSocket
Gửi action heartbeat định kỳ để server không ngắt phiên. Dùng subscribe/unsubscribe để đăng ký sự kiện; server đẩy thông báo qua bản tin notify khi có sự kiện. Ví dụ đăng ký theo máy nhánh: ExtensionStatus/1006 hoặc dải ExtensionStatus/1005~1007.
Bảng tham số hay phải chỉnh
| Tham số | Mặc định | Khi nào cần đổi |
|---|---|---|
| Enable (HTTPS API Settings New) | Tắt | Bật khi cần cho ứng dụng bên thứ ba truy cập API. |
| Username / Password | Tự đặt | Đặt khi bật API; dùng cho cả HTTPS API và WebSocket API. |
| Port | 8089 | Đổi nếu hạ tầng mạng yêu cầu cổng khác; WSS cũng dùng cổng này. |
| Call Control | Tùy chọn | Bật khi cần điều khiển/quản lý cuộc gọi qua API. |
Chưa làm được, kiểm tra gì?
- Không gọi được API: Xác nhận UCM đang chạy HTTPS (không phải HTTP) và chứng thư web hợp lệ; API dùng chung chứng thư với cổng web.
- Phiên bị ngắt: Với HTTPS API dùng ping (hết hạn sau 5 phút rảnh); với WebSocket gửi heartbeat định kỳ để giữ phiên. › IP-PBX WebSocket API – User Guide
Làm gì tiếp theo?
Xem thêm hướng dẫn tích hợp UCM6300