Lấy danh sách OA

API này dùng để lấy danh sách OA đã được kết nối trên eTelecom

Lưu ý:

• Đối với các API sử dụng cho Shop thì API_KEY: <api_key>.Thông tin base_url của Shop

• Đối với các API sử dụng cho Partner thì API_KEY: <shop_key>.Thông tin base_url của Partner

ListOA

post

Body

Responses

post

HTTPcURLJavaScriptPython

POST /ListOA HTTP/1.1
Host: $BASE_URL.Zalo
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "filter": {
    "app_id": "text",
    "date_from": "2025-04-29T09:52:04.673Z",
    "date_to": "2025-04-29T09:52:04.673Z",
    "name": "text",
    "oa_id": "text"
  },
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 1,
    "sort": "text"
  }
}

200

A successful response

{
  "accounts": [
    {
      "app_id": "text",
      "avatar": "text",
      "connection_id": "text",
      "connection_method": "unknown",
      "cover": "text",
      "created_at": "2025-04-29T09:52:04.673Z",
      "current_quality": "unknown",
      "daily_quota": 1,
      "description": "text",
      "expires_at": "2025-04-29T09:52:04.673Z",
      "is_verified": true,
      "last_week_quality": "unknown",
      "name": "text",
      "oa_id": "text",
      "onwer_id": "text",
      "remaining_quota": 1,
      "shop_id": "text",
      "status": "Z",
      "updated_at": "2025-04-29T09:52:04.673Z"
    }
  ],
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 1,
    "next": "text",
    "prev": "text",
    "sort": "text"
  }
}

Request:

curl --location '$BASE_URL.Zalo/ListOA' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API-KEY' \
--data '{
  "filter": {
    "app_id": "<int64>",
    "date_from": "<dateTime>",
    "date_to": "<dateTime>",
    "name": "<string>",
    "oa_id": "<int64>"
  },
  "paging": {
    "after": "<string>",
    "before": "<string>",
    "limit": "<integer>",
    "sort": "<string>"
  }
}'

Response:

{
  "accounts": [
    {
      "app_id": "string",
      "avatar": "string",
      "connection_id": "string",
      "connection_method": "unknown",
      "cover": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "current_quality": "unknown",
      "daily_quota": 0,
      "description": "string",
      "expires_at": "2019-08-24T14:15:22Z",
      "is_verified": true,
      "last_week_quality": "unknown",
      "name": "string",
      "oa_id": "string",
      "onwer_id": "string",
      "remaining_quota": 0,
      "shop_id": "string",
      "status": "Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "paging": {
    "after": "string",
    "before": "string",
    "limit": 0,
    "next": "string",
    "prev": "string",
    "sort": "string"
  }
}

Cấu trúc body của request

Tham số	Kiểu dữ liệu	Mô tả
app_id	int64	ID của ứng dụng
oa_id	int64	ID của OA
name	string	Tên OA
date_from	string<date-time>	Ngày bắt đầu
date_to	string<date-time>	Ngày kết thúc

Cấu trúc thuộc tính dữ liệu trả về

Tham số	Kiểu dữ liệu	Mô tả
app_id	int64	ID của ứng dụng
avatar	string	Đường dẫn đến ảnh bìa của OA
connection_id	int64	ID kết nối
connection_method	string	Phương thức kết nối unknown builtin direct
description	string	Mô tả
is_verified	boolean	True: OA được verify False: OA chưa được verify
name	string	Tên OA
oa_id	int64	ID của OA
owner_id	int64	ID của chủ shop trên hệ thống eTelecom
shop_id	int64	ID của shop trên hệ thống eTelecom
status	string	Trạng thái P: Đang kết nối N: Ngắt kết nối
current_quality	string	Chất lượng gửi thông báo ZNS trong 48 giờ gần nhất của OA. HIGH - Mức độ chất lượng tốt MEDIUM - Mức độ chất lượng trung bình LOW - Mức độ chất lượng kém UNDEFINED - Mức độ chất lượng OA chưa được xác định (trường hợp OA không gửi thông báo ZNS nào trong khung thời gian đánh giá)
last_week_quality	string	Chất lượng gửi thông báo ZNS trong 7 ngày gần nhất của OA. Các giá trị trả về: HIGH - Mức độ chất lượng tốt MEDIUM - Mức độ chất lượng trung bình LOW - Mức độ chất lượng kém UNDEFINED - Mức độ chất lượng OA chưa được xác định (trường hợp OA không gửi thông báo ZNS nào trong khung thời gian đánh giá)
daily_quota	int	Số thông báo ZNS OA được gửi trong 1 ngày.
remaining_quota	int	Số thông báo ZNS OA được gửi trong ngày còn lại.
expires_at	string<date-time>	Thời gian hết hạn của refresh token
updated_at	string<date-time>	Ngày cập nhật
created_at	string<date-time>	Ngày tạo