Get sample details

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.

GetTemplate

POST$BASE_URL.Zalo/GetTemplate

Body

application/json

oa_idstring (int64)

template_idinteger

Response

200

A successful response

Body

application/json

apply_template_quotaboolean

created_atstring (date-time)

preview_urlstring

priceinteger

template_daily_quotainteger

template_idinteger

template_namestring

template_paramsarray of mrTemplateParam (object)

template_qualityukTemplateQuality (enum)

unknownUNDEFINEDLOWMEDIUMHIGH

template_remaining_quotainteger

template_statusueTemplateStatus (enum)

unknownPENDING_REVIEWDISABLEENABLEREJECT

template_tagusTemplateTag (enum)

unknownOTPIN_TRANSACTIONPOST_TRANSACTIONACCOUNT_UPDATEGENERAL_UPDATEFOLLOW_UP

timeoutinteger

typelkTemplateType (enum)

unknowntextotptablerating

updated_atstring (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "apply_template_quota": false,
  "created_at": "2025-01-09T12:25:44.866Z",
  "preview_url": "text",
  "price": 0,
  "template_daily_quota": 0,
  "template_id": 0,
  "template_name": "text",
  "template_params": [
    {
      "accept_null": false,
      "max_length": 0,
      "min_length": 0,
      "name": "text",
      "require": false,
      "type": "text"
    }
  ],
  "template_quality": "unknown",
  "template_remaining_quota": 0,
  "template_status": "unknown",
  "template_tag": "unknown",
  "timeout": 0,
  "type": "unknown",
  "updated_at": "2025-01-09T12:25:44.866Z"
}

Request:

curl --location '$BASE_URL.Zalo/GetTemplate' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API_KEY' \
--data '{
    "oa_id": "<int64>",
    "template_id": "<integer>"
}'

Response:

{
  "apply_template_quota": true,
  "created_at": "2019-08-24T14:15:22Z",
  "price": 0,
  "template_daily_quota": 0,
  "template_id": 0,
  "template_name": "string",
  "template_params": [
    {
      "accept_null": true,
      "max_length": 0,
      "min_length": 0,
      "name": "string",
      "require": true,
      "type": "string"
    }
  ],
  "template_quality": "unknown",
  "template_remaining_quota": 0,
  "template_status": "unknown",
  "template_tag": "unknown",
  "timeout": 0,
  "type": "unknown",
  "updated_at": "2019-08-24T14:15:22Z"
}

Request body structure

Parameters	Data type	Describe
id	int64	OA ID
template_id	integer	ID of the message

Return data attribute structure

Parameters	Data type	Describe
template_id	integer	ID of the message
template_name	string	Name of the message
price	integer	Unit price of the ad
timeout	integer	Sample charge time
apply_template_quota	boolean	True False
template_daily_quota	integer	Number of messages ZNS can send in 1 day
template_quality	string	unknown: Unknown UNDEFINED: OA quality level not determined (in case OA does not send any ZNS notification within the assessment time frame) LOW: Poor quality level MEDIUM: Medium quality level HIGH: High quality level
template_remaining_quota	integer	Number of messages ZNS can send remaining in 1 day
template_status	string	Message status unknown: Unknown PENDING_REVIEW: In progress DISABLE: Locked ENABLE: Approved REJECT: Rejected
template_tag	string	Message level unknown: Unknown OTP: Tin OTP (member 0) IN_TRANSACTION: Confirm/Update transaction information (Tag 1) POST_TRANSACTION: Support related services after transaction (Tag 2) ACCOUNT_UPDATE: Update account information (Tag 3) GENERAL_UPDATE: Change service information (Tag 4) FOLLOW_UP: Promotional announcement to old customers (Tag 5)
template_params	array object	List of record attributes
updated_at	string<date-time>	Update time
created_at	string<date-time>	Creation time