Lấy danh sách trường thông tin

Lưu ý

Ứng dụng cần được OA cấp quyền "Quản lý trường thông tin người dùng" để sử dụng API này.

HTTP request

• URL: https://openapi.zalo.me/v3.0/oa/userfield/get
• Method: GET
• Response Type: text/json

Example request

curl --location --request GET 'https://openapi.zalo.me/v3.0/oa/userfield/get' \
--header 'access_token: <your_access_token>' \
--header 'Content-Type: application/json' \
--data '{
    "field_type": "system"
}'

Tham số header

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
access_token	string	yes	Token cho phép ứng dụng đại diện OA gọi API

Cấu trúc body của request

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
field_type	string	no	Dùng để lọc loại trường thông tin (system hoặc oa_custom)
fields_to_get	array	no	Dùng để lọc các khóa chỉ định Nếu không có tham số fields_to_get, API sẽ trả về tất cả các trường thông tin. Nếu có tham số fields_to_get, API sẽ chỉ trả về thông tin của các trường được chỉ định. Nếu một trường trong fields_to_get không tồn tại, trường này sẽ bị bỏ qua trong kết quả trả về.

Example response

{
    "error": 0,
    "message": "success",
    "data": {
        "fields": [
            {
                "key": "user_id",
                "name": "User ID",
                "description": "ID của KH trên hệ thống Zalo OA, mỗi KH sẽ có 1 ID duy nhất",
                "status": "active",
                "data_type": "id",
                "value_unique": true,
                "field_type": "system"
            },
            {
                "key": "ten_hien_thi",
                "name": "Tên Hiển Thị",
                "description": "Tên hiển thị của người dùng",
                "status": "active",
                "data_type": "text",
                "value_unique": false,
                "field_type": "oa_custom"
            }
        ]
    }
}

Cấu trúc response

Tham số	Kiểu dữ liệu	Mô tả
error	integer	Mã lỗi (0 nếu thành công)
message	string	Thông báo kết quả
data	array	Đối tượng chứa danh sách các trường thông tin

Cấu trúc của mỗi trường trong data.fields

Tham số	Kiểu dữ liệu	Mô tả
key	string	Khóa của trường thông tin
name	string	Tên trường thông tin
data_type	string	Loại dữ liệu của trường thông tin
description	string	Mô tả trường thông tin
status	string	Trạng thái của trường thông tin "active": Đang hoạt động "inactive": Tạm ngưng
field_type	string	Loại trường thông tin (system hoặc oa_custom)
value_unique	boolean	Có ràng buộc unique value hay không. Hiện tại chỉ có user_external_id và user_id có giá trị là true.
additional_fields	object	Cài đặt bổ sung cho data_type là table. Mô tả chi tiết các trường dữ liệu con của table. Ví dụ: "additional_fields": [ { "key": "da_thanh_toan_chua", "data_type": "boolean" }, { "key": "da_thanh_toan_chua", "data_type": "datetime", "additional_format": "dd/MM/yyyy" } ]
additional_format	string	Cài đặt bổ sung cho data_type là datetime. Format hiển thị cho kiểu datetime. Ví dụ: "additional_format": "dd/MM/yyyy"