API ReferenceAPI AutocallÂm thanh
Danh sách tệp âm thanh (GetAudioList)
Tra cứu danh sách các tệp âm thanh TTS và file ghi âm đã tạo trên hệ thống Autocall.
POST
https://apiai.cloudfone.vn/api/Audio/GetAudioListLấy danh sách các tệp âm thanh hiện có trong kho dữ liệu của doanh nghiệp, hỗ trợ phân trang và tìm kiếm theo tên tệp để lấy mã AudioId cấu hình cho chiến dịch.
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. |
Key | string | Không | Từ khóa tìm kiếm theo tên tệp âm thanh. |
PageIndex | number | Không | Số thứ tự trang hiện tại (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). |
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 file âm thanh tìm thấy. |
data | array | Danh sách thông tin chi tiết từng tệp âm thanh. |
data[].id | number | Mã ID tệp âm thanh (dùng trong chiến dịch Autocall). |
data[].audioName | string | Tên định danh của tệp âm thanh. |
data[].type | string | Loại âm thanh (Google, FPT, VBEE, VTCC, File). |
data[].voiceType | string | Mã kiểu giọng đọc đã cấu hình. |
data[].createdDate | string | Thời điểm tạo file âm thanh. |
Lưu ý quan trọng
- Lấy danh sách mã tệp: Sử dụng trường
data[].idđể gán vào thuộc tínhActionParamtrong mảngAudioskhi thiết lập kịch bản cuộc gọi qua API StartCampaign. - Phân trang: Sử dụng
PageIndexvàPageSizeđể duyệt toàn bộ danh sách khi kho âm thanh có nhiều tệp.
Lỗi thường gặp
- Sai thông tin xác thực
AuthUserhoặcAuthKey. - Dịch vụ
ServiceCodekhông hợp lệ.
- Doanh nghiệp chưa tạo tệp âm thanh nào, hoặc từ khóa tìm kiếm
Keykhông khớp với tên tệp nào.