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
Body
oa_idstring · int64Optional
Responses
200

A successful response

application/json
post
$BASE_URL.Zalo/GetShopOA
200

A successful response

Request:

Response:

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

Last updated