eTelecom docs
English
English
  • INSTRUCTIONS FOR USE
    • Administration page for cs.etelecom
    • Google Chrome Extension
    • App eTelecom
  • API INTEGRATION
    • Shop
      • Account
      • Usage
    • Partner
      • Account
      • Usage
    • VPBX
      • VoIP SDK
        • Android
        • iOS
        • Web
        • Flutter
      • PBX REST APIs
        • Partner Get Tenant List
        • Partner Add Hotline
        • Partner Get Hotline List
        • Partner Activate Tenant
        • Partner Add Hotline To Tenant
        • Partner Removed Hotline From Tenant
        • Partner Remove Hotline
        • Create Tenant
        • Get Tenant information
        • Get Driver Config
        • Get hotline list
        • Create Account User
        • Get List User
        • Create extension
        • Get extension information
        • Get extension list
        • Assign extension to user
        • Change hotline for extension
        • Remove User Of Extension
        • Get call history
    • Zalo Cloud
      • Instructions for connecting Zalo Cloud
      • Zalo Cloud API
        • Create OA authorization link
        • Connect OA
        • Get refresh token
        • Get OA list
        • Get OA information
        • Update Webhook for OA
        • Get list of users
        • Send Text Consulting
        • Send Consulting message according to user information request form
        • Send advice message with sticker
        • Send message Consulting with attached photo
        • Send message Consulting attached file
        • Send transaction message
        • Upload file
        • Send request for calling permission
        • Check if the customer has granted calling permission
        • Get list of requests for calling permission
        • Create a news template
        • Get sample details
        • Get list of news samples
        • Journey Token Creation
        • Get Journey Token Details
        • Get Journey Token List
        • Get message list
        • Get message details
        • Send ZNS
        • Send ZNS with Journey Token
  • SMS BRANDNAME
    • User manual
    • SMS API
      • Send SMS
      • Get message status
      • Get sample details
Powered by GitBook
On this page
  1. API INTEGRATION
  2. Zalo Cloud
  3. Zalo Cloud API

Get sample details

PreviousCreate a news templateNextGet list of news samples

Last updated 5 months ago

Note:

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

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

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

<api_key>
Shop
<shop_key>
Partner

GetTemplate

post
Body
oa_idstring ยท int64Optional
template_idintegerOptional
Responses
200
A successful response
application/json
post
POST /GetTemplate HTTP/1.1
Host: $BASE_URL.Zalo
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "oa_id": "text",
  "template_id": 1
}
200

A successful response

{
  "apply_template_quota": true,
  "created_at": "2025-06-14T22:57:10.262Z",
  "preview_url": "text",
  "price": 1,
  "template_daily_quota": 1,
  "template_id": 1,
  "template_name": "text",
  "template_params": [
    {
      "accept_null": true,
      "max_length": 1,
      "min_length": 1,
      "name": "text",
      "require": true,
      "type": "text"
    }
  ],
  "template_quality": "unknown",
  "template_remaining_quota": 1,
  "template_status": "unknown",
  "template_tag": "unknown",
  "timeout": 1,
  "type": "unknown",
  "updated_at": "2025-06-14T22:57:10.262Z"
}