Hướng dẫn sử dụng API ZNS của ATPCare

I – LẤY ACCESS TOKEN

B1: Sau khi đăng nhập vào zns.atpcare.vn, tích chọn menu “Quản Lý API”

B2: Lấy token ở “Access Token”, nếu chưa có thì bấm làm mới để tạo 1 Access Token mới

II – DANH SÁCH CÁC API PUBLIC 

1, Lấy danh sách OA

2, Lấy danh sách template

3, Lấy thông tin template ZNS 

4, Lấy thông tin template SMS

5, Gửi zns

6, Gửi sms

7, Thêm khách hàng vào template

8, Thống kê tin đã gửi

9. Thống kê đánh giá

III – HƯỚNG DẪN SỬ DỤNG CÁC API PUBLIC

1, Lấy danh sách OA

Header:

content-type:application/json

Method: GET

URL: https://zns.atpcare.vn/api/get-oa-user?token=access-token

Kết quả trả về:
{

   “success”: [

       {

           “id”: 2106,

           “oa_id”: “3167621278911060324”,

           “oa_name”: “Simple Page”,

           “description”: “Cung cấp giải pháp tự động hóa marketing…”,

           “avatar”: “https://s160-ava-talk.zadn.vn/c/a/5/a/1/160/8c470b2f783b6d07476f1b524a837871.jpg”,

           “cover”: “https://cover-talk.zadn.vn/1/e/5/d/1/8c470b2f783b6d07476f1b524a837871.jpg”,

           “is_verified”: “Đã xác thực”,

           “user_id”: 16610,

           “check_filter”: 1

       },

       {

           “id”: 2107,

           “oa_id”: “1129233942025097216”,

           “oa_name”: “ATP Software Company”,

           “description”: “Cung cấp giải pháp tự động hóa marketing hỗ trợ doanh nghiệp & cá nhân kinh doanh online”,

           “avatar”: “https://s160-ava-talk.zadn.vn/3/b/4/9/8/160/9f6083caaf1986ddbd76808588d6b2d9.jpg”,

           “cover”: “https://cover-talk.zadn.vn/d/e/e/7/4/9f6083caaf1986ddbd76808588d6b2d9.jpg”,

           “is_verified”: “Đã xác thực”,

           “user_id”: 16610,

           “check_filter”: 1

       }

   ]

}

2, Lấy danh sách template

Header:

content-type:application/json

Method: GET

URL: https://zns.atpcare.vn/api/get-list-template?token=access-token

Kết quả trả về:

[

   {

       “id”: 1234,

       “status”: “Đã duyệt”,

       “id_template”: “123456”,

       “oa_id”: “4162123456554334”,

       “dark_logo”: “https://zns.atpcare.vn/storage/templatezns/user/16610/piD6u/3edefbda-7947-4a6f-919c-8d82dbbf946f.png”,

       “bright_logo”: “https://zns.atpcare.vn/storage/templatezns/user/16610/piD6u/b94b8ef4-52c7-456c-a7a4-fafdc9073217.png”,

       “name”: “[ZNS] – mẫu 123456”,

       “title”: “Xác nhận đơn hàng,”,

       “content”: “ATPCARE xin chào Qúy Khách\nXin chào <name> cảm ơn đã mua thành công bản quyền tại ATPCARE\nthông tin chi tiết\nMã đơn : <oder_number>\nNgày : <created_on> \nTổng Tiền : <total_price>\nTrạng Thái Thanh Toán : <financial_status>\nNút: Quan tâm ZALO OA”,

       “main_button”: “”,

       “extra_button”: “”,

       “user_id”: 123456,

       “price”: 330,

       “brand_name”: “”,

       “type”: “”

   },

]

3, Lấy thông tin template ZNS

Header:

content-type:application/json

Method: GET

id=123456 – chính là id_template lấy ở api (2, Lấy danh sách template)

oa_id=4162123456554334 – chính là oa_id lấy ở api (2, Lấy danh sách template)

URL: https://zns.atpcare.vn/api/get-template-info?id=123456&oa_id=4162123456554334&token=access-token

Kết quả trả về:
{

   “status”: “success”,

   “data”: {

       “templateId”: 123456,

       “templateName”: “Thông báo đặt hàng “,

       “status”: “ENABLE”,

       “listParams”: [

           {

               “name”: “lastName”,

               “require”: true,

               “type”: “STRING”,

               “maxLength”: 30,

               “minLength”: 0,

               “acceptNull”: false

           },

           {

               “name”: “phone”,

               “require”: true,

               “type”: “STRING”,

               “maxLength”: 50,

               “minLength”: 0,

               “acceptNull”: false

           },

           {

               “name”: “address”,

               “require”: true,

               “type”: “STRING”,

               “maxLength”: 50,

               “minLength”: 0,

               “acceptNull”: false

           }

       ],

       “timeout”: 7200000,

       “previewUrl”: “https://account.zalo.cloud/znspreview/kTJocZfXZa-GoA34OmtTFQ==”,

       “templateQuality”: “UNDEFINED”,

       “templateTag”: “IN_TRANSACTION”,

       “price”: “200.0”,

       “applyTemplateQuota”: false

   }

}

4, Lấy thông tin template SMS

Header:

access-token:access-token

content-type:application/json

Method: GET

id=123456 – chính là id_template lấy ở api (2, Lấy danh sách template)

URL: https://zns.atpcare.vn/api/get-template-info?id=123456&type=sms&token=access-token

Kết quả trả về:

{

   “status”: “success”,

   “data”: {

       “templateId”: “123456”,

       “templateName”: “[SMS] – sms Test chúc mừng năm mới”,

       “status”: “ENABLE”,

       “price”: 450,

       “listParams”: [

           {

               “name”: “content”,

               “require”: true

           }

       ]

   }

}

5, Gửi ZNS

Header:

access-token:access-token

content-type:application/json

Method: POST

Body: các param là các field đã đăng ký với ATP ZNS
Trường phone, oa_id (lấy ở API 2), template_id (lấy ở API 2) là các trường bắt buộc luôn có
{

   “phone”: “0123456789”,

   “oa_id”: “31671234567900”,

   “template_id”: “123456”,
  “template_data”: {

   “lastName”: “Hiếu”,

   “day”: “12/08/2023”,

   “orderid”: “103231234”

   }

}Để lấy thông tin gửi api gửi zns ta cũng có thể vào menu Quản Lý API -> chọn template để ATP ZNS truy xuất ra thông tin api (áp dụng cho cả SMS và ZNS)

URL: https://zns.atpcare.vn/api/send-zns

Kết quả trả về:

{

  “status”: “success”,

  “data”: {

    “error”: 0,

    “message”: “Success”,

    “data”: {

      “sent_time”: “1728210802950”,

      “sending_mode”: “1”,

      “quota”: {

        “remainingQuota”: “4998”,

        “dailyQuota”: “5000”

      },

      “msg_id”: “0fb4f1a6c8a231231231”

    },

    “price”: 330

  }

}

6, Gửi SMS

Header:

access-token:access-token

content-type:application/json

Method: POST

Body: các param là các field đã đăng ký với ATP ZNS
Trường phone, oa_id (lấy ở API 2), template_id (lấy ở API 2) là các trường bắt buộc luôn có
{

   “phone”: “0123456778”,

   “template_id”: “123456”,

   “template_data”: {

       “customer_name”: “Hiếu”,

       “total”: “1000”

    }

}

URL: https://zns.atpcare.vn/api/send-sms

7, Thêm khách hàng vào template

Header:

access-token:access-token

content-type:application/json

Method: POST

Body: 

{

   “template_id”:”247308″,

   “oa_id”:”316123213213123″,

   “phone”:”84775999345″,

   “lastName”:”Nguyen Hieu”,

   “day”:”25/10/2023″,

   “orderid”:”1235432523″

}

URL: https://zns.atpcare.vn/api/insert-customer

8, Thống kê tin đã gửi

Header:

access-token:access-token

content-type:application/json

Method: POST

Body: 

start_date: thời gian bắt đầu quét

end_date: thời gian kết thúc quét

{

   “template_id”: 123456,

   “start_date”: “01/08/2024”,

   “end_date”: “31/08/2024”

}

URL: https://zns.atpcare.vn/api/analytics/date-range

9. Thống kê đánh giá

Header:
content-type:application/json

Method: GET

API: https://zns.atpcare.vn/api/get-rating-template?id_oa=1234&template_id=1231234&from_time=1727715600000&to_time=1730307600000&token={{access_token}