Danh sách liên hệ (GetContactList)

Tra cứu toàn bộ danh bạ liên hệ khách hàng trên hệ thống Autocall.

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

Lấy toàn bộ danh sách khách hàng đã được nhập vào hệ thống Autocall (không giới hạn theo nhóm), hỗ trợ tìm kiếm theo số điện thoại, tên hoặc phân trang.

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 hoặc số điện thoại.
`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/GetContactList" \
  -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": 520,
  "data": [
    {
      "contactId": 1052,
      "phone": "0900000000",
      "contactName": "Nguyen Van A",
      "company": "ODS JSC",
      "address": "TP. Ho Chi Minh"
    }
  ]
}

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 liên hệ tìm thấy.
`data`	array	Danh sách thông tin chi tiết từng liên hệ.
`data[].contactId`	number	Mã định danh duy nhất của liên hệ.
`data[].phone`	string	Số điện thoại khách hàng.
`data[].contactName`	string	Tên định danh của liên hệ.
`data[].company`	string	Tên công ty / tổ chức.
`data[].address`	string	Địa chỉ của khách hàng.

Lưu ý quan trọng

Quản lý danh bạ tổng: Endpoint này giúp bạn tra cứu toàn bộ danh bạ khách hàng đã từng nhập vào hệ thống Autocall, độc lập với việc liên hệ đó có được gán vào nhóm hay không.
Phân trang: Sử dụng PageIndex và PageSize để duyệt danh bạ quy mô lớn.

Danh sách liên hệ (GetContactList)

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

Thêm liên hệ

Xóa liên hệ

Danh sách liên hệ (GetContactList)

400 Bad Request / result: failed

Danh sách data rỗng []

Thêm liên hệ

Xóa liên hệ