ODS
API ReferenceAPI AutocallChiến dịch

Tạo và cập nhật chiến dịch (StartCampaign)

Khởi tạo chiến dịch gọi tự động Autocall hoặc cập nhật chiến dịch hiện có.

POSThttps://apiai.cloudfone.vn/api/Autocall/StartCampaign

Tạo mới một chiến dịch gọi tự động hàng loạt tới danh sách khách hàng hoặc cập nhật thông tin cấu hình của chiến dịch hiện có khi truyền CampaignId.

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

Luồng chuẩn bị và khởi chạy chiến dịch
  1. 1
    Chuẩn bị danh bạ

    Tạo nhóm và lấy ContactID

  2. 2
    Chuẩn bị tài nguyên

    Lấy Trunk và AudioId

  3. 3
    Gửi StartCampaign

    Truyền lịch gọi và cấu hình IVR

  4. 4
    Theo dõi kết quả

    Lưu CampaignId; nhận callback nếu có APIURL

ContactID, Trunk và AudioId phải được lấy từ các API tài nguyên tương ứng trước khi gửi request. CampaignId là khóa dùng để tra cứu hoặc cập nhật chiến dịch.

Tham số request

Tham sốKiểu dữ liệuBắt buộcMô tả chi tiết
ServiceCodestringCóMã dịch vụ khi mua gói Autocall tại ODS (ví dụ: CF-XXXXX).
AuthUserstringCóMã tài khoản khách hàng (ví dụ: ODSXXXX).
AuthKeystringCóKhóa bí mật API do ODS cấp.
CampaignNamestringCóTên chiến dịch (ví dụ: Chiến dịch CSKH Tháng 10).
ContactIDnumberCóID của nhóm danh bạ khách hàng cần gọi (tạo từ API AddContactGroup).
TrunkstringCóTên đầu số Trunk dùng để thực hiện cuộc gọi ra (lấy từ API GetTrunkList).
TimeStartCallstringCóThời gian kích hoạt chiến dịch bắt đầu gọi (ví dụ: 2026-10-19 08:30:00.000).
CampaignIdstringKhôngMã UUID của chiến dịch. Nếu truyền vào, hệ thống sẽ cập nhật chiến dịch; nếu để trống, hệ thống sẽ tạo mới.
AudiosarrayCóDanh sách tệp âm thanh áp dụng cho chiến dịch.
KeypressarrayKhôngDanh sách cấu hình phím bấm rẽ nhánh (IVR).
APIURLstringKhôngURL API máy chủ khách hàng để nhận thông báo kết quả cuộc gọi.
APIKEYstringKhôngKhóa API bảo mật của khách hàng đi kèm với APIURL.

Cấu trúc mảng Audios

Thuộc tínhKiểu dữ liệuMô tả
DTMFstringKý hiệu ngữ cảnh âm thanh: "s" (Start - âm thanh chào mừng bắt đầu), "i" (Invalid - âm thanh phát khi khách hàng bấm sai phím).
ActionParamstringMã ID của tệp âm thanh tương ứng (tạo từ API CreateTTSAudio).

Cấu trúc mảng Keypress

Thuộc tínhKiểu dữ liệuMô tả
KeystringKý tự phím bấm của khách hàng ("1", "2", v.v.).
ActionstringMã số hành động khi phím được bấm (tra cứu danh sách qua GetListAction).

Cấu trúc phản hồi

TrườngKiểu dữ liệuMô tả
resultstringTrạng thái thực thi (success hoặc failed).
messagestringThông báo kết quả từ máy chủ Autocall.
datastringMã CampaignId của chiến dịch vừa được tạo hoặc cập nhật.

Lưu ý quan trọng

  • Định dạng thời gian: Tham số TimeStartCall phải có đầy đủ phần mili-giây: YYYY-MM-DD HH:mm:ss.000 (ví dụ: 2026-10-19 08:30:00.000). Nếu đặt thời gian trong quá khứ, chiến dịch sẽ được kích hoạt gọi ngay lập tức.
  • Yêu cầu tệp âm thanh: Mảng Audios bắt buộc phải có ít nhất một phần tử với DTMF: "s" (âm thanh bắt đầu phát khi khách hàng nhấc máy). Nếu chiến dịch có tương tác phím bấm, nên bổ sung DTMF: "i" (âm thanh phát khi bấm sai phím).
  • Trunk gọi ra: Phải sử dụng đúng tên Trunk được trả về từ API GetTrunkList.
  • Callback Webhook: Nếu điền APIURL, máy chủ ODS sẽ tự động bắn HTTP POST về URL này sau mỗi cuộc gọi kết thúc để cập nhật trạng thái cho hệ thống của bạn (sử dụng URL máy chủ của bạn thay cho example.com).

Lỗi thường gặp

Bài viết liên quan

Danh sách chiến dịch

Tra cứu trạng thái chiến dịch đang chạy.

Báo cáo chiến dịch

Xem tỷ lệ kết nối thành công và chi tiết từng số gọi.

API Gọi tự động (Autocall)

Tổng quan các API tự động hóa chiến dịch cuộc gọi thoại hàng loạt, chuyển văn bản thành giọng nói (TTS) và báo cáo.

Danh sách chiến dịch (GetCampaignList)

Tra cứu danh sách các chiến dịch gọi tự động Autocall theo trạng thái và từ khóa.