Get OA list

This API is used to get the list of connected OAs on eTelecom

Note:

• For APIs used for Shop, the API key is: <api_key>. The base_url information of the Shop.

• For APIs used for Partner, the API key is: <shop_key>. The base_url information of the Partner.

ListOA

post

Body

Responses

200

A successful response

application/json

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-08-01T11:09:34.859Z",
    "date_to": "2025-08-01T11:09:34.859Z",
    "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-08-01T11:09:34.859Z",
      "current_quality": "unknown",
      "daily_quota": 1,
      "description": "text",
      "expires_at": "2025-08-01T11:09:34.859Z",
      "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-08-01T11:09:34.859Z"
    }
  ],
  "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"
  }
}

Request body structure

Parameters	Data type	Describe
app_id	int64	Application ID
id	int64	OA ID
name	string	OA Name
date_from	string<date-time>	Start date
date_to	string<date-time>	End date

Return data attribute structure

Parameters	Data type	Describe
app_id	int64	Application ID
avatar	string	Link to OA cover photo
connection_id	int64	Connection ID
connection_method	string	Connection method unknown builtin direct
description	string	Describe
is_verified	boolean	True: OA verified False: OA not verified
name	string	OA Name
id	int64	OA ID
owner_id	int64	Shop owner ID on eTelecom system
shop_id	int64	Shop ID on eTelecom system
status	string	Status P: Connecting N: Disconnect
current_quality	string	OA's ZNS notification delivery quality in the last 48 hours. HIGH - Good quality level MEDIUM - Medium quality level LOW - Low quality level UNDEFINED - OA quality level not determined (in case OA did not send any ZNS notification within the evaluation timeframe)
last_week_quality	string	OA's ZNS notification sending quality in the last 7 days. Return values: HIGH - Good quality level MEDIUM - Medium quality level LOW - Low quality level UNDEFINED - OA quality level not determined (in case OA did not send any ZNS notification within the evaluation timeframe)
daily_quota	int	Number of ZNS OA notifications sent in 1 day.
remaining_quota	int	Number of ZNS OA notifications sent in the remaining day.
expires_at	string<date-time>	Refresh token expiration time
updated_at	string<date-time>	Update date
created_at	string<date-time>	Date created