API ReferenceAPI AutocallChiến dịch
Báo cáo chiến dịch (GetCampaignReport)
Trích xuất danh sách báo cáo chi tiết kết quả chạy cuộc gọi của chiến dịch Autocall.
POST
https://apiai.cloudfone.vn/api/Autocall/GetCampaignReportTra cứu báo cáo chi tiết kết quả thực hiện cuộc gọi của một chiến dịch Autocall cụ thể, hỗ trợ lọc theo các trạng thái kết nối đàm thoại.
Tham số request
| Tham số | Kiểu dữ liệu | Bắt buộc | Mô tả chi tiết |
|---|---|---|---|
ServiceCode | string | Có | Mã dịch vụ Autocall (ví dụ: CF-XXXXX). |
AuthUser | string | Có | Mã tài khoản khách hàng. |
AuthKey | string | Có | Khóa bí mật API do ODS cấp. |
CampaignId | string | Có | Mã UUID của chiến dịch cần lấy báo cáo. |
ReportType | number | Có | Bộ lọc trạng thái cuộc gọi: 0 (Tất cả), 1 (Gọi thành công), 2 (Không bắt máy), 3 (Bấm bận), 4 (Người dùng chặn số), 5 (Không thể kết nối). |
PageIndex | number | Không | Số thứ tự trang cần lấy (mặc định là 1). |
PageSize | number | Không | Số lượng bản ghi trên một trang (mặc định là 20). |
Key | string | Không | Từ khóa tìm kiếm theo số điện thoại hoặc tên khách hàng. |
Cấu trúc phản hồi
Bảng mô tả trường
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
result | string | Trạng thái xử lý (success hoặc failed). |
total | number | Tổng số lượng cuộc gọi trong chiến dịch theo bộ lọc. |
data | array | Danh sách chi tiết kết quả từng cuộc gọi. |
data[].phone | string | Số điện thoại khách hàng được gọi. |
data[].customerName | string | Tên khách hàng (nếu có lưu trong danh bạ nhóm). |
data[].status | string | Trạng thái cuộc gọi (ANSWERED, NO ANSWER, BUSY). |
data[].duration | number | Thời lượng đàm thoại thực tế (giây). |
data[].keypress | string | Phím IVR khách hàng đã bấm tương tác. |
data[].timeCall | string | Thời điểm thực hiện cuộc gọi. |
Lưu ý quan trọng
- Ý nghĩa mã ReportType:
0: Toàn bộ các cuộc gọi phát sinh trong chiến dịch.1: Gọi thành công (khách hàng nhấc máy nghe thông báo).2: Không bắt máy (chuông đổ nhưng không trả lời).3: Khách hàng bấm máy bận (User Busy / Reject).4: Số máy bị chặn hoặc nằm trong danh sách đen DNC.5: Không thể kết nối (thuê bao ngoài vùng phủ sóng, tắt máy).
- Phân tích dữ liệu: Kết hợp trường
keypressvàdurationđể đánh giá mức độ tương tác và quan tâm thực tế của khách hàng đối với kịch bản thoại.
Lỗi thường gặp
- Sai thông tin xác thực
AuthUserhoặcAuthKey. CampaignIdkhông tồn tại hoặc sai định dạng UUID.
- Chiến dịch mới tạo và chưa đến thời điểm kích hoạt gọi (
TimeStartCall). - Bộ lọc
ReportTypekhông có cuộc gọi nào thuộc trạng thái này.