Danh sách nhóm danh bạ (GetContactGroupList)

Tra cứu danh sách các nhóm danh bạ khách hàng đã tạo trên hệ thống Autocall.

POSThttps://apiai.cloudfone.vn/api/Contact/GetContactGroupList

Lấy danh sách các nhóm danh bạ hiện có, hỗ trợ phân trang và tìm kiếm theo tên nhóm.

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 nhóm danh bạ.
`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`).

Ví dụ request

curl -X POST "https://apiai.cloudfone.vn/api/Contact/GetContactGroupList" \
  -H "Content-Type: application/json" \
  -d '{
    "ServiceCode": "YOUR_SERVICE_CODE",
    "AuthUser": "YOUR_AUTH_USER",
    "AuthKey": "YOUR_AUTH_KEY",
    "Key": "",
    "PageIndex": 1,
    "PageSize": 20
  }'

Response mẫu

{
  "result": "success",
  "message": "",
  "total": 3,
  "data": [
    {
      "contactGroupId": 1006,
      "contactGroupName": "Khach hang VIP Thang 10",
      "totalContacts": 150,
      "createdDate": "2026-10-13 08:30:00"
    }
  ]
}

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 nhóm danh bạ tìm thấy.
`data`	array	Danh sách thông tin chi tiết từng nhóm danh bạ.
`data[].contactGroupId`	number	Mã ID của nhóm danh bạ (dùng cho chiến dịch).
`data[].contactGroupName`	string	Tên của nhóm danh bạ.
`data[].totalContacts`	number	Tổng số lượng số điện thoại hiện có trong nhóm.
`data[].createdDate`	string	Thời điểm tạo nhóm.

Lưu ý quan trọng

Tra cứu ID nhóm: Dùng endpoint này để tìm nhanh mã contactGroupId trước khi cấu hình vào tham số ContactID trong API StartCampaign.
Phân trang: Sử dụng PageIndex và PageSize để duyệt toàn bộ danh sách khi có nhiều nhóm danh bạ.

Danh sách nhóm danh bạ (GetContactGroupList)

Tham số request

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

Bảng mô tả trường

Lưu ý quan trọng

Lỗi thường gặp

Bài viết liên quan

Chi tiết nhóm danh bạ

Tạo nhóm danh bạ

Danh sách nhóm danh bạ (GetContactGroupList)

400 Bad Request / result: failed

Danh sách data rỗng []

Chi tiết nhóm danh bạ

Tạo nhóm danh bạ