Send ZNS

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.

SendZNS

POST$BASE_URL.Zalo/SendZNS

Body

application/json

oa_idstring (int64)

phonestring

template_dataobject

template_idinteger

tracking_idstring

Response

200

A successful response

Body

application/json

campaign_idstring (int64)

created_atstring (date-time)

delivery_statuseeDeliveryStatus (enum)

unknownreceivedseen

delivery_timestring (date-time)

enable_sms_on_zns_failureboolean

error_codeinteger

error_messagestring

fee_maininteger

fee_tokeninteger

feedbackarray of string

idstring (int64)

is_chargedboolean

journey_idstring (int64)

msg_idstring

notestring

oa_idstring (int64)

phonestring

rateinteger

sent_timestring (date-time)

shop_idstring (int64)

smsmrSms (object)

statusbmStatus (enum)

ZPSN

submit_timestring (date-time)

template_dataobject

template_idinteger

timeoutinteger

tracking_idstring

typenqMessageType (enum)

unknowntemplatejourneyuid

updated_atstring (date-time)

user_idstring (int64)

zl_user_idstring (int64)

Request

JavaScriptCurlPython

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

Response

200

{
  "campaign_id": "text",
  "created_at": "2025-01-09T12:28:10.290Z",
  "delivery_status": "unknown",
  "delivery_time": "2025-01-09T12:28:10.290Z",
  "enable_sms_on_zns_failure": false,
  "error_code": 0,
  "error_message": "text",
  "fee_main": 0,
  "fee_token": 0,
  "feedback": [
    "text"
  ],
  "id": "text",
  "is_charged": false,
  "journey_id": "text",
  "msg_id": "text",
  "note": "text",
  "oa_id": "text",
  "phone": "text",
  "rate": 0,
  "sent_time": "2025-01-09T12:28:10.290Z",
  "shop_id": "text",
  "sms": {
    "brandname": "text",
    "code": "text",
    "description": "text",
    "message": "text",
    "request_time": "2025-01-09T12:28:10.290Z",
    "send_time": "2025-01-09T12:28:10.290Z",
    "status": "text",
    "status_description": "text",
    "unicode": false
  },
  "status": "Z",
  "submit_time": "2025-01-09T12:28:10.290Z",
  "template_id": 0,
  "timeout": 0,
  "tracking_id": "text",
  "type": "unknown",
  "updated_at": "2025-01-09T12:28:10.290Z",
  "user_id": "text",
  "zl_user_id": "text"
}

Request:

curl --location '$BASE_URL.Zalo/SendZNS' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API_KEY' \
--data '{
  "oa_id": "<int64>",
  "phone": "<string>",
  "template_data": {
    "property1": "string",
    "property2": "string"
  },
  "template_id": "<int>",
  "tracking_id": "<string>"
}'

Response:

{
  "campaign_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "delivery_status": "unknown",
  "delivery_time": "2019-08-24T14:15:22Z",
  "error_code": 0,
  "error_message": "string",
  "fee_main": 0,
  "fee_token": 0,
  "id": "string",
  "is_charged": true,
  "journey_id": "string",
  "msg_id": "string",
  "oa_id": "string",
  "phone": "string",
  "sent_time": "2019-08-24T14:15:22Z",
  "shop_id": "string",
  "status": "Z",
  "template_data": {
    "property1": "string",
    "property2": "string"
  },
  "template_id": 0,
  "timeout": 0,
  "tracking_id": "string",
  "type": "unknown",
  "updated_at": "2019-08-24T14:15:22Z",
  "user_id": "string"
}

Request body structure

Parameters	Data type	Describe
id	int64	OA ID
template_id	int	ID of the message
phone	string	Recipient phone number
template_data	object	Properties of the message you registered with Zalo Note: The template_data structure is specified separately for each message.
tracking_id	string	Your API call tracking number, defined by you. You can use tracking_id for reconciliation without depending on the message_id provided by eTelecom.

Return data attribute structure

Parameters	Data type	Describe
id	int64	Message ID on eTelecom system
shop_id	int64	Store ID on eTelecom system
user_id	int64	Sender ID on eTelecom system
campaign_id	int64	Campaign ID
delivery_status	string	Unkown: Unknown Received: Received Seen: Viewed
delivery_time	string<date-time>	Time the user's device receives the ZNS notification
error_code	int	Error code
error_message	string	Error message
fee_main	int	Main fee
fee_token	int	Token Creation Fee
is_charged	boolean	True: ZNS News is charged False: ZNS news is free of charge
journey_id	string	Journey ID
msg_id	string	ZNS message ID
type	string	template: ZNS usually journey: ZNS journey
status	string	Status Z: Newly created P: Enable N: Disable
template_data	object	Message parameters
phone	string	Recipient phone number
sent_time	string<date-time>	ZNS notification sending time
template_id	integer	ID of the message
timeout	integer	Maximum time required by the system to process the request
tracking_id	string	Your API call tracking number, defined by you. You can use tracking_id for reconciliation without depending on the message_id provided by eTelecom.
updated_at	string<date-time>	Update date
created_at	string<date-time>	Date created