Hàm lấy danh sách UID có tương tác theo khoảng thời gian

HTTP request

POST https://rest.esms.vn/MainService.svc/json/QueryListUID/

• Content Type: application/json

• Response Type: application/json

curl --location 'https://rest.esms.vn/MainService.svc/json/QueryListUID/' \
--header 'Content-Type: application/json' \
--data '{
    "ApiKey": "{{ApiKey}}",
    "SecretKey": "{{SecretKey}}",
    "OAID": "4097311281936189049",
    "Offset": 0, 
    "Count": 50, 
    "FromDate": "01/09/2024",
    "ToDate": "13/10/2024",
    "IsFollower": "",
    "TagName": "" 
}'

• Cấu trúc body của request:

Tham số	Kiểu dữ liệu	Tính băt buộc	Mô tả
ApiKey	string		ApiKey của tài khoản.
SecretKey	string		SecretKey của tài khoản.
OAID	string		Zalo OA ID, là ID của trang Zalo Offical Account của doanh nghiệp. Doanh nghiệp cần đăng nhập vào trang quản trị của Zalo OA để lấy phần Zalo OA ID này. Chú ý: sẽ phải đăng ký trước khi sử dụng.
Offset	string		Thứ tự của UID trong danh sách trả về. Hỗ trợ tối đa 9.950 (tương ứng 10.000 UID, 50 UID/request).
Count	string		Số lượng UID cần lấy. Tối đa mỗi lần request là 50 UID.
FromDate	string		Thời gian bắt đầu lấy UID có tương tác.
ToDate	string		Thời gian kết thúc lấy UID có tương tác.
IsFollower	string		Trạng thái quan tâm OA của UID 1: UID đang quan tâm OA. 0: UID chưa quan tâm OA. Rỗng: lấy tất cả.
TagName	string		Tên của nhãn được gắn cho UID. Khi bạn sử dụng tham số này, API sẽ trả về danh sách UID theo nhãn tương ứng. Lưu ý: Trường hợp không truyền vào TagName, API sẽ trả về toàn bộ UID người dùng.

---

• Response:

100

{
    "CodeResult": "100",
    "Data": {
        "Count": 50,
        "Offset": 0,
        "Total": 4,
        "Users": [
            "7406454492343693107",
            "7210831021380318952",
            "961919545811768483",
            "6559140676281540092"
        ]
    }
}

Request hợp lệ.

101

{
    "CodeResult": "101",
    "ErrorMessage": "Authorize Failed"
}

Sai thông tin ApiKey/SecretKey.

161

{
    "CodeResult": "161",
    "ErrorMessage": "FromDate is invalid date format."
}
{
    "CodeResult": "161",
    "ErrorMessage": "ToDate is invalid date format."
}

Sai định dạng ngày.

162

{
    "CodeResult": "162",
    "ErrorMessage": "Offset is invalid."
}
{
    "CodeResult": "162",
    "ErrorMessage": "Count is invalid."
}

Thứ tự lấy UID hoặc số lượng UID cần lấy không hợp lệ.

Cấu trúc body của response:

Thuốc tính	Kiểu dữ liệu	Mô tả
CodeResult	string	Mã trả về.
Data	object	Chi tiết thông tin UI.

Cấu trúc thuộc tính từng object trong Data

Thuốc tính	Kiểu dữ liệu	Mô tả
Count	string	Kết quả của request.
Offset	string	Thứ tự UID trong danh sách trả về
Tatal	string	Tổng UID thoả yêu cầu reque
Users	array	Danh sách UID lấy được

• Thông tin chi tiết mã lỗi xem ở bảng: Mã lỗi .

• Lấy code mẫu các ngôn ngữ trên Postman: Link code mẫu.