# Tin nhắn Zalo ZNS

## 1. Gửi ZNS 

Chuẩn bị: ID kịch bản trên hệ thống caresoft với template được ZALO duyệt (kèm ZNS\_ID)

**Thông tin trường dữ liệu gửi ZNS** 

<table><thead><tr><th width="98">STT</th><th width="129">Trường</th><th width="168">Kiểu </th><th>Chú thích</th></tr></thead><tbody><tr><td>1</td><td>zns</td><td>Object</td><td>Object chứa thông tin gửi ZNS</td></tr><tr><td></td><td>..</td><td></td><td></td></tr><tr><td>2</td><td>phone</td><td>TelephoneNo</td><td>Số điện thoại cần gửi ZNS</td></tr><tr><td>3</td><td>template_id</td><td>Int</td><td>Mẫu nội dung template được cấu hình đã được Zalo phê duyệt Template này được cấu hình liên kết đến 1 zalo OA đã tích hợp vào caresoft từ trước đó<br>(Xem hướng dẫn ở mục 2) </td></tr><tr><td>4</td><td>ticket_id</td><td>Int</td><td>Id của phiếu ghi nếu muốn thực hiện nghiệp vụ trả lời cho 1 phiếu ghi đã có, trong trường hợp không truyền tham số này hệ thống sẽ tự tạo 1 phiếu ghi mới </td></tr><tr><td>5</td><td>params</td><td>Object</td><td><p>Object Param dạng <br><code>{</code></p><p> <code>param:value,</code> </p><p> <code>param1:value1</code></p><p><code>}</code><br> Đây là tên biến và giá trị thay thế được cấu hình trên nội dung kịch bản ZNS (xem hướng dẫn Mục 3 phía dưới)</p><p>Trong trường hợp không truyền tham số này, Hệ thống tự động lấy các tham số đã cấu hình mapping trong kịch bản </p></td></tr></tbody></table>

**Body Payload tiêu biểu.**&#x20;

\
Trong payload này  hệ thống sẽ gửi 1 kịch bản ZNS có ID là 366 tới khách hàng có số điện thoại  09839\*\*148  và ghi chú phản hồi vào phiếu ghi có ID  297005

{% code title="Body Payload JSON/Object" %}

```json
{
    "zns": {
        "phone": "09839**148",
        "template_id": 366,
        "ticket_id": 297005,
        "params": {
            "requester": "Nguyễn Hải Hà",
            "masoDatve": "098733" 
        }
    }
}
```

{% endcode %}

## Gửi tin nhắn Zalo ZNS

<mark style="color:green;">`POST`</mark> `{{domain}}/api/v1/zalo/zns`

Gửi tin nhắn ZNS tới 1 số điện thoại bất kỳ đã đăng ký tài khoản Zalo

#### Headers

| Name                                   | Type   | Description                                                                                |
| -------------------------------------- | ------ | ------------------------------------------------------------------------------------------ |
| \*\*<mark style="color:red;">\*</mark> | String | [Thông tin xác thực chung ](https://docs.caresoft.vn/thong-tin-chung#phuong-thuc-xac-thuc) |

#### Request Body

| Name             | Type    | Description                                                                                                                                                                                                                                                                                                                                                                 |
| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| zns              | Object  | Object thông tin gửi ZNS                                                                                                                                                                                                                                                                                                                                                    |
| zns.phone        | PhoneNo | Số điện thoại cần gửi ZNS                                                                                                                                                                                                                                                                                                                                                   |
| zns.template\_id | Int     | <p>Mẫu nội dung template được cấu hình đã được Zalo phê duyệt Template này được cấu hình liên kết đến 1 zalo OA đã tích hợp vào caresoft từ trước đó<br>(Xem hướng dẫn ở mục 2) </p><p></p><p></p>                                                                                                                                                                          |
| zns.params       | Object  | <p>Object Param dạng <br><code>{</code></p><p> <code>param:value,</code> </p><p> <code>param1:value1</code></p><p><code>}</code><br> Đây là tên biến và giá trị thay thế được cấu hình trên nội dung kịch bản ZNS (xem hướng dẫn Mục 3 phía dưới)</p><p>Trong trường hợp không truyền tham số này, Hệ thống tự động lấy các tham số đã cấu hình mapping trong kịch bản </p> |
| zns.ticket\_id   | Int     | Id của phiếu ghi nếu muốn thực hiện nghiệp vụ trả lời cho 1 phiếu ghi đã có, trong trường hợp không truyền tham số này hệ thống sẽ tự tạo 1 phiếu ghi mới                                                                                                                                                                                                                   |

{% tabs %}
{% tab title="200: OK Kết quả thành công" %}

```json
{
    "status": "OK",
    "ticket": {
        "ticketId": "297002"
    }
}
```

{% endtab %}

{% tab title="400: Bad Request Lỗi thông tin " %}
{% code title="Lỗi không tìm thấy template" %}

```json
{
    "code": "errors",
    "errors": {
        "template_id": [
            "The selected template id is invalid."
        ]
    }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

## 2. Cách lấy template\_id trên CareSoft

Sử dụng tài khoản Admin  vào menu Admin → Kịch bản , Trong loại kịch bản chọn “Gửi tin nhắn Zalo ZNS” →  bấm tìm kiếm&#x20;

Copy ID kịch bản trong phần kết quả  (khoanh tròn màu đỏ) tương ứng.&#x20;

<figure><img src="https://lh6.googleusercontent.com/FR3KZfJpXNPid19BxdgP69QK17slyDMs92PE9DaSm92ax0oLhHkWqDmTNWsJaFH8tRSn3iQzPmATa_OQn47K-6fq0cek8_F2limRQrRTUTNo0NsSqW4axhZVTlqqrnMKMAu43zuIPn0RR2VaXTAG8Q" alt=""><figcaption></figcaption></figure>

## 3. Cấu hình kịch bản ZNS&#x20;

Lưu ý: ID kịch bản Zalo ZNS phải là ID được Zalo phê duyệt.  Zalo OA là Page Zalo đã được tích hợp vào CareSoft&#x20;

<figure><img src="https://lh3.googleusercontent.com/OsuLPKcPW9oqKpV9sr3ncEe-sKbQ5NHQn0IC_45Uwuw5Qj0tqPTo_LaZnNolb5u3ZGvX7t5pf4GtfYjistNWvM5FaplfuB1tTFf3jqrYBvQX4q4dczC3rkJIEDGorlk_Ec2uZQKlIZ1j68mF1HBwbQ" alt=""><figcaption></figcaption></figure>