Gửi ZNS

circle-info

Lưu ý:

SendZNS

post
Body
modestring · enumOptionalPossible values:
oa_idstring · int64Optional
phonestringOptional
sending_modestring · enumOptionalPossible values:
template_idintegerOptional
tracking_idstringOptional
Responses
chevron-right
200

A successful response

application/json
campaign_idstring · int64Optional
created_atstring · date-timeOptional
delivery_statusstring · enumOptionalPossible values:
delivery_timestring · date-timeOptional
error_codeintegerOptional
error_messagestringOptional
fee_mainintegerOptional
fee_tokenintegerOptional
feedbackstring[]Optional
idstring · int64Optional
is_chargedbooleanOptional
is_developmentbooleanOptional
journey_idstring · int64Optional
msg_idstringOptional
notestringOptional
oa_idstring · int64Optional
phonestringOptional
rateintegerOptional
request_timestring · date-timeOptional
response_datastringOptional
sending_modestring · enumOptionalPossible values:
sent_timestring · date-timeOptional
shop_idstring · int64Optional
statusstring · enumOptionalPossible values:
submit_timestring · date-timeOptional
template_idintegerOptional
timeoutintegerOptional
tracking_idstringOptional
typestring · enumOptionalPossible values:
updated_atstring · date-timeOptional
user_idstring · int64Optional
zl_user_idstring · int64Optional
post
$BASE_URL.Zalo/SendZNS
200

A successful response

Request:

Response:

Cấu trúc body của request

Tham số
Kiểu dữ liệu
Mô tả

mode

string

Enum: "unknown" "development" development: Khi có nhu cầu gửi thử mẫu ZNS để kiểm tra trước khi gửi chính thức, bạn có thể gọi lệnh ZNS API ở chế độ development. Chế độ development chỉ hỗ trợ gửi thử mẫu ZNS đến quản trị viên của ứng dụng hoặc quản trị viên của OA.

Nếu tham số mode không được truyền, mặc định mode = unknown

oa_id

int64

ID của OA

template_id

int

ID của mẫu tin

sending_mode

string

Chế độ gửi:

phone

string

Số điện thoại người nhận

template_data

object

Các thuộc tính của mẫu tin mà bạn đã đăng ký với Zalo

Lưu ý: Cấu trúc template_data được quy định riêng ứng với từng mẫu tin

tracking_id

string

Mã số đánh dấu lần gọi API của bạn, do bạn định nghĩa. Bạn có thể dùng tracking_id để đối soát mà không phụ thuộc vào message_id của eTelecom cung cấp.

Cấu trúc thuộc tính dữ liệu trả về

Tham số
Kiểu dữ liệu
Mô tả

id

string <int64>

ID tin nhắn trên hệ thống của eTelecom

shop_id

string <int64>

ID cửa hàng trên hệ thống của eTelecom

user_id

string <int64>

ID người gửi tin trên hệ thống của eTelecom

campaign_id

string <int64>

ID của chiến dịch

delivery_status

string

Unkown: Không xác định

Received: Đã nhận Seen: Đã xem

delivery_time

string<date-time>

Thời gian thiết bị của người dùng nhận được thông báo ZNS

error_code

int

Mã lỗi

error_message

string

Thông báo lỗi

fee_main

int

Phí chính

fee_token

int

Phí khởi tạo token

is_charged

boolean

True: Tin ZNS được tính phí

False: Tin ZNS không được tính phí

is_development

boolean

True: Tin ZNS ở chế độ phát triển thử nghiệm

False: Tin ZNS không ở chế độ phát triển thử nghiệm

journey_id

string

ID của journey

msg_id

string

ID của thông báo ZNS

type

string

template: ZNS thường

journey: ZNS journey

status

string

Trạng thái Z: Mới tạo P: Enable N: Disable

template_data

object

Tham số tin nhắn

phone

string

Số điện thoại người nhận

sent_time

string<date-time>

Thời gian gửi thông báo ZNS

sending_mode

string

Bao gồm giá trị:

  • "unknown": Không xác định

  • "default": tin ZNS được gửi theo cơ chế thông thường

  • "tag3": tin ZNS được gửi theo cơ chế vượt hạn mức

template_id

integer

ID của mẫu tin

timeout

integer

Thời gian tối đa mà hệ thống xử lý yêu cầu

tracking_id

string

Mã số đánh dấu lần gọi API của bạn, do bạn định nghĩa. Bạn có thể dùng tracking_id để đối soát mà không phụ thuộc vào message_id của eTelecom cung cấp.

updated_at

string<date-time>

Ngày cập nhật

created_at

string<date-time>

Ngày tạo

Last updated