Connect OA

This API is used to connect OA

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.

ConnectOA

POST$BASE_URL.Zalo/ConnectOA

Body

application/json

codestring

oa_idstring (int64)

stateinteger

Response

200

A successful response

Body

application/json

app_idstring (int64)

avatarstring

connection_idstring (int64)

connection_methodcdConnectionMethod (enum)

Deprecated values: "topship"\n

unknownbuiltindirect

coverstring

created_atstring (date-time)

current_qualitygeOAQuality (enum)

unknownUNDEFINEDLOWMEDIUMHIGH

daily_quotainteger

descriptionstring

expires_atstring (date-time)

is_verifiedboolean

last_week_qualitygeOAQuality (enum)

unknownUNDEFINEDLOWMEDIUMHIGH

namestring

oa_idstring (int64)

onwer_idstring (int64)

remaining_quotainteger

shop_idstring (int64)

statusblStatus (enum)

ZPN

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('$BASE_URL.Zalo/ConnectOA', {
    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-09T12:32:18.002Z",
  "current_quality": "unknown",
  "daily_quota": 0,
  "description": "text",
  "expires_at": "2025-01-09T12:32:18.002Z",
  "is_verified": false,
  "last_week_quality": "unknown",
  "name": "text",
  "oa_id": "text",
  "onwer_id": "text",
  "remaining_quota": 0,
  "shop_id": "text",
  "status": "Z",
  "updated_at": "2025-01-09T12:32:18.002Z"
}

Request:

curl --location '$BASE_URL.Zalo/ConnectOA' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API_KEY' \
--data '{
  "code": "string",
  "oa_id": "int64",
  "state": "integer"
}'

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,
  "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"
}

Request body structure

Parameters	Data type	Describe
code	string	Code returned in redirect_url when performing OA authorization for the app
id	int64	OA ID
state	integer	State returned in redirect_url when performing OA authorization for the app

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 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: Connected N: Disconnected
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