Gửi ZNS

Lưu ý:

  • Đối với các API sử dụng cho Shop thì API key:<api_key>.Thông tin base_url của Shop

  • Đối với các API sử dụng cho Partner thì API key:<shop_key>.Thông tin base_url của Partner

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"
}

Cấu trúc body của request

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

oa_id

int64

ID của OA

template_id

int

ID của mẫu tin

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

int64

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

shop_id

int64

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

user_id

int64

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

campaign_id

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í

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

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