Lấy thông tin OA

API này dùng để lấy thông tin của OA như: Chất lượng gửi tin, quota tin ZNS, quota tin tag 3 (hậu mãi),....

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

GetShopOA

POST$BASE_URL.Zalo/GetShopOA

Body

application/json

oa_idstring (int64)

Response

200

A successful response

Body

application/json

app_idstring (int64)

avatarstring

connection_idstring (int64)

connection_methodljConnectionMethod (enum)

Deprecated values: "topship"\n

unknownbuiltindirect

coverstring

created_atstring (date-time)

current_qualitygeOAQuality (enum)

unknownUNDEFINEDLOWMEDIUMHIGH

daily_quotainteger

daily_quota_promotioninteger

descriptionstring

estimated_next_month_promotion_quotainteger

expires_atstring (date-time)

is_verifiedboolean

last_week_qualitygeOAQuality (enum)

unknownUNDEFINEDLOWMEDIUMHIGH

monthly_promotion_quotainteger

namestring

oa_idstring (int64)

onwer_idstring (int64)

remaining_monthly_promotion_quotainteger

remaining_quotainteger

shop_idstring (int64)

statusblStatus (enum)

ZPN

updated_atstring (date-time)

webhook_urlstring

Request

JavaScriptCurlPython

const response = await fetch('$BASE_URL.Zalo/GetShopOA', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "app_id": "text",
  "avatar": "text",
  "connection_id": "text",
  "connection_method": "unknown",
  "cover": "text",
  "created_at": "2025-01-07T01:07:14.740Z",
  "current_quality": "unknown",
  "daily_quota": 0,
  "daily_quota_promotion": 0,
  "description": "text",
  "estimated_next_month_promotion_quota": 0,
  "expires_at": "2025-01-07T01:07:14.740Z",
  "is_verified": false,
  "last_week_quality": "unknown",
  "monthly_promotion_quota": 0,
  "name": "text",
  "oa_id": "text",
  "onwer_id": "text",
  "remaining_monthly_promotion_quota": 0,
  "remaining_quota": 0,
  "shop_id": "text",
  "status": "Z",
  "updated_at": "2025-01-07T01:07:14.740Z",
  "webhook_url": "text"
}

Request:

curl --location 'BASE_URL.Zalo/GetShopOA' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API_KEY' \
--data '{
  "oa_id": "string"
}'

Response:

{
  "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,
  "daily_quota_promotion": 0,
  "description": "string",
  "estimated_next_month_promotion_quota": 0,
  "expires_at": "2019-08-24T14:15:22Z",
  "is_verified": true,
  "last_week_quality": "unknown",
  "monthly_promotion_quota": 0,
  "name": "string",
  "oa_id": "string",
  "onwer_id": "string",
  "remaining_monthly_promotion_quota": 0,
  "remaining_quota": 0,
  "shop_id": "string",
  "status": "Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "webhook_url": "string"
}

Cấu trúc body của request

Tham số	Kiểu dữ liệu	Mô tả
oa_id	int64	ID của OA

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.
daily_quota_promotion	int	Số tin ZNS hậu mãi OA được gửi trong ngày. Ghi chú: Từ ngày 1/11, thuộc tính này sẽ trả về giá trị null
monthly_promotion_quota	int	Số tin ZNS hậu mãi OA được gửi trong tháng.
remaining_monthly_promotion_quota	int	Số tin ZNS hậu mãi còn lại OA được gửi trong tháng.
estimated_next_month_promotion_quota	int	Số tin ZNS hậu mãi dự kiến mà OA có thể gửi trong tháng tiếp theo.
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