ODS
API ReferenceAPI tổng đàiKhởi tạo cuộc gọi

Khởi tạo cuộc gọi Click-to-Call

Thực hiện cuộc gọi từ phần mềm (CRM, ERP) đến khách hàng thông qua máy nhánh nhân viên với API AutoCall.

POSThttps://api.ods.vn/api/CloudFone/AutoCall

API này dùng để làm tính năng "Bấm để gọi" (Click-to-Call) trên phần mềm CRM, ERP hoặc website: Nhân viên bấm nút "Gọi" trên màn hình, tổng đài sẽ tự động kết nối máy nhánh của nhân viên với số điện thoại của khách hàng mà không cần bấm số thủ công.

Cách thức hoạt động

Cuộc gọi được tổng đài điều phối tự động qua 2 chặng liên tiếp:

Sơ đồ tuần tự xử lý cuộc gọi (Sequence Diagram)
CRM / ERPỨng dụng gọiTổng đài ODSAPI & GatewayMáy nhánh ExtNhân viên trựcKhách hàngPhoneNumber1POST /api/CloudFone/AutoCall2200 OK { result: "success" }⚡ Bất đồng bộ: Nhận lệnh ngay, chưa gọi kháchChặng 1: Kết nối máy nhánh nhân viên3Đổ chuông máy nhánh Ext (PhoneName)4Nhân viên nhấc máy (Answered)Chặng 2: Gọi khách hàng & Nối thoại5Tổng đài quay số gọi khách (PhoneNumber)6Khách hàng nhấc máy7Nối thoại 2 chiềuExt ⟷ Khách đàm thoại trực tiếp
1. API Bất đồng bộ

API phản hồi 200 OK để báo nhận lệnh thành công, không đồng nghĩa khách đã nghe máy.

2. Quy tắc 2 chặng

Tổng đài gọi máy nhánh nhân viên trước. Nhân viên bắt máy thì tổng đài mới quay số gọi khách hàng.

3. Lấy kết quả qua Webhook

Trạng thái nghe máy, thời lượng thoại và file ghi âm sẽ được gửi về qua Webhook hoặc tra cứu theo KeySearch.

Máy nhánh nhân viên (Ext) bắt buộc phải đang đăng ký online trên IP Phone, Softphone hoặc Webphone để nhận chuông ở chặng 1. Nếu bạn cần tổng đài gọi khách hàng trước rồi mới chuyển tiếp vào nhóm trực hoặc kịch bản IVR, hãy sử dụng Click-to-Call V2.

Tham số request

Tham sốKiểu dữ liệuBắt buộcMặc địnhMô tả chi tiết
ServiceNamestringCó—Mã dịch vụ tổng đài khi mua tại ODS (ví dụ: CF-BS00XXXXX).
AuthUserstringCó—Mã tài khoản khách hàng khi mua tổng đài (ví dụ: CF000XXX).
AuthKeystringCó—Khóa bí mật API do ODS cấp (chỉ gọi từ backend, không để lộ ở client).
ExtstringCó—Số máy nhánh của nhân viên nhận cuộc gọi (ví dụ: 101, 9119).
PhoneNumberstringCó—Số điện thoại của khách hàng cần gọi đến (ví dụ: 0900000000).
PrefixstringKhông"0"Tiền tố gọi ra theo cấu hình tổng đài (thường giữ mặc định "0").
PhoneNamestringKhông""Tên khách hàng hiển thị trên máy nhánh khi chuông reo (để trống sẽ hiện "tongdaitudong").
KeySearchstringKhông""Mã tham chiếu tự đặt (khuyến nghị UUID) để đối chiếu lịch sử cuộc gọi sau này.

Cấu trúc và ý nghĩa phản hồi

TrườngKiểu dữ liệuMô tả chi tiết
resultstringTrạng thái xử lý lệnh: "success" hoặc "failed".
messagestringThông báo phản hồi từ hệ thống tổng đài.
keySearchstringMã định danh cuộc gọi trả về (dùng tra cứu CDR hoặc nhận webhook).

Ý nghĩa của result: "success": Chỉ xác nhận tổng đài đã tiếp nhận lệnh và bắt đầu đổ chuông máy nhánh nhân viên. Để biết khách hàng có nhấc máy hay không (ANSWERED), xem qua Webhook Popup hoặc Lịch sử cuộc gọi.

Xử lý sự cố thường gặp

Bài viết liên quan