Zalo — Official Account

Get OA info — zalo.get_oa

Get the connected Official Account: name, followers, verification and package.

Side effect	Risk	Needs approval	Idempotent	Scopes
NONE	low	no	yes	—

Input

No input.

Extra fields: ignored.

Output

Field	Type	Description
data	object	The connected Official Account.
data.oaid	string	ID of the OA. The reference table calls it oa_id; its example uses oaid.
data.name	string	Name of the OA.
data.description	string	Description of the OA.
data.oa_alias	string	Short name used in the OA's link.
data.is_verified	boolean	True when the OA is verified.
data.oa_type	integer	OA type: 2 business, 4 government agency.
data.cate_name	string	Business category of the OA.
data.num_follower	integer	Total followers of the OA.
data.avatar	string	URL of the OA avatar.
data.cover	string	URL of the OA cover image.
data.package_name	string	Name of the service package. Only business OAs return it.
data.package_valid_through_date	string	Last day the package is valid, dd/MM/yyyy. Only OAs on a package return it.
data.package_auto_renew_date	string	Date the package renews itself, dd/MM/yyyy. Only OAs on a package with auto-renew on return it.
data.linked_ZCA	string	The ZCA account linked to the OA. Only OAs linked to a ZCA wallet return it. The reference table spells it linked_zca; its example uses linked_ZCA.

Check message quota — zalo.check_message_quota

Check message quota for one user (user_id) or for the OA (quota_owner, product_type, quota_type). Send either user_id or the quota fields.

Side effect	Risk	Needs approval	Idempotent	Scopes
NONE	low	no	yes	—

Input

Field	Type	Required	Description
user_id	string	no	Zalo user ID of the OA follower.
quota_owner	string	no	Quota owner, e.g. OA.
product_type	string	no	Product type the quota belongs to.
quota_type	string	no	Quota type to check.

Extra fields: ignored.

Output

Field	Type	Description
data	object	Zalo returns a list here; the declared object type cannot hold it yet.

Check group quota — zalo.check_group_quota

Check the OA's group chat (GMF) quota. Returns the asset_id used to create groups.

Side effect	Risk	Needs approval	Idempotent	Scopes
NONE	low	no	yes	—

Input

Field	Type	Required	Description
quota_owner	string	yes	Quota owner, e.g. OA.
product_type	string	yes	Product type the quota belongs to.
quota_type	string	yes	Quota type to check.

Extra fields: ignored.

Output

Field	Type	Description
data	object	Zalo returns a list here; the declared object type cannot hold it yet.

Check message window — zalo.check_message_window

Check whether a message is still inside the 48 hour free consultation window.

Side effect	Risk	Needs approval	Idempotent	Scopes
NONE	low	no	yes	—

Input

Field	Type	Required	Description
message_id	string	yes	ID of a message in the conversation.

Extra fields: ignored.

Output

Field	Type	Description
data	object	The user's message window and remaining sends.
data.last_interaction	string	When the user last interacted with the OA, Unix time in milliseconds, as a string.
data.cs_reply	object	Consultation replies left. Always remain 8 from 1 Jan 2026; no longer returned after 1 Mar 2026.
data.cs_reply.remain	integer	Replies left.
data.cs_reply.total	integer	Replies allowed.
data.promotion	object	Promotion messages the OA can still send to this user.
data.promotion.daily_remain	integer	Sends left today.
data.promotion.daily_total	integer	Sends allowed per day.
data.promotion.monthly_remain	integer	Sends left this month.
data.promotion.monthly_total	integer	Sends allowed per month.