Skip to navigation

Tổng quan

OMICX Public API cho phép các đối tác bên thứ ba tích hợp trực tiếp với nền tảng OMICX qua HTTP, gồm 4 nhóm năng lực:

NhómDùng đểXem chi tiết
Khách hàngTạo, tra cứu, tìm kiếm, cập nhật khách hàng CRM; ghi chú, đánh giá, chuyển phụ trách, gán người liên quanKhách hàng
Cấu hìnhDanh mục tham chiếu dùng kèm Khách hàng — thuộc tính, tiêu chí AI Insights, Tag, Nhóm, nhân viên, quy trìnhCấu hình
Tích hợpSpeech to Text, Text to Speech, và Webhook nhận sự kiện bất đồng bộTích hợp
Hệ thốngHealth checkHệ thống

Xác thực

Tất cả endpoint (trừ GET /health) đều yêu cầu header X-Api-Key — xem chi tiết tại trang API Keys.

Base URL

https://api.omicx.one cho toàn bộ endpoint, trừ health check dùng base URL riêng — xem Health Check. Luôn dùng HTTPS, không gửi API key qua HTTP thường.

Đồng bộ và bất đồng bộ

  • Khách hàng, Speech to Text, Text to Speech, Cấu hình xử lý đồng bộ (synchronous) — kết quả trả về ngay trong response HTTP, không cần polling.
  • Webhook hoạt động theo chiều ngược lại: bạn đăng ký một endpoint HTTP của mình để nhận sự kiện (ví dụ khi một job Speech to Text/Text to Speech hoàn tất) — xem Webhook và Callback Events.

Content-Type theo từng endpoint

EndpointContent-Type
POST /customers, PATCH /customers, POST /customers/search, …application/json
POST /ttsapplication/json
POST /sttmultipart/form-data
GET /health— (không cần xác thực)