# Phiếu ghi

## Các trường thông tin của phiếu ghi

Phiếu ghi trên hệ thống CareSoft là 1 đối tượng dữ liệu được tạo ra bởi tất cả các kênh tương tác mà hệ thống đa kênh có thể thu nhận được. Mọi tương tác của khách hàng tới hệ thống đều tạo ra phiếu ghi và lưu trữ thông tin của nó.

**Các trường thông tin của phiếu ghi** 

<table><thead><tr><th width="74" data-type="number">STT</th><th width="205">Tên trường</th><th width="132">Kiểu dữ liệu<select><option value="c1de87f3835849988fba39927355ae11" label="Int" color="blue"></option><option value="58097ed0ba9e42819493eab2984fc5c1" label="Array" color="blue"></option><option value="eb8e153ff4d844788e62f0e80c99ce6a" label="String (255)" color="blue"></option><option value="bd16f1c24b0f4fe1b2a6918a3cef564d" label="String" color="blue"></option><option value="92bb4e6fd2e5421486918f8a8ffdc9fb" label="DateTime" color="blue"></option><option value="e0e0772e6f6a492b8bb350fcfaed9731" label="Object" color="blue"></option></select></th><th>Chú thích</th><th data-hidden>Trạng thái<select></select></th></tr></thead><tbody><tr><td>1</td><td>ticket_no</td><td><span data-option="c1de87f3835849988fba39927355ae11">Int</span></td><td>Số phiếu ghi</td><td></td></tr><tr><td>2</td><td>ticket_status</td><td><span data-option="bd16f1c24b0f4fe1b2a6918a3cef564d">String</span></td><td>Trạng thái phiếu ghi có <a data-footnote-ref href="#user-content-fn-1">5 trạng thái</a> </td><td></td></tr><tr><td>3</td><td>ticket_subject</td><td><span data-option="eb8e153ff4d844788e62f0e80c99ce6a">String (255)</span></td><td>Chủ đề phiếu ghi</td><td></td></tr><tr><td>4</td><td>ticket_priority</td><td><span data-option="bd16f1c24b0f4fe1b2a6918a3cef564d">String</span></td><td>Độ ưu tiên có <a data-footnote-ref href="#user-content-fn-2">3 trạng thái </a></td><td></td></tr><tr><td>5</td><td>ticket_id</td><td><span data-option="c1de87f3835849988fba39927355ae11">Int</span></td><td>Id phiếu ghi, Khóa chính để thực hiện tương tác với phiếu ghi qua API</td><td></td></tr><tr><td>6</td><td>requester_id</td><td><span data-option="c1de87f3835849988fba39927355ae11">Int</span></td><td>Id người yêu cầu, khóa chính để thực hiện tương tác với khách hàng qua API</td><td></td></tr><tr><td>7</td><td>assignee_id</td><td><span data-option="c1de87f3835849988fba39927355ae11">Int</span></td><td>Id người xử lý. Là Id của chuyên viên trong 1 hệ thống</td><td></td></tr><tr><td>8</td><td>created_at</td><td><span data-option="92bb4e6fd2e5421486918f8a8ffdc9fb">DateTime</span></td><td>Ngày tạo phiếu ghi</td><td></td></tr><tr><td>9</td><td>updated_at</td><td><span data-option="92bb4e6fd2e5421486918f8a8ffdc9fb">DateTime</span></td><td>Ngày cập nhật phiếu ghi</td><td></td></tr><tr><td>10</td><td>group_id</td><td><span data-option="c1de87f3835849988fba39927355ae11">Int</span></td><td>Bộ phận của người xử lý (có thể lấy danh sách bộ phận <a href="bo-phan">tại đây</a></td><td></td></tr><tr><td>11</td><td>ticket_source</td><td><span data-option="bd16f1c24b0f4fe1b2a6918a3cef564d">String</span></td><td>Nguồn phiếu ghi, <a href="phieu-ghi/danh-sach-nguon">xem danh sách </a></td><td></td></tr><tr><td>12</td><td>duedate</td><td><span data-option="92bb4e6fd2e5421486918f8a8ffdc9fb">DateTime</span></td><td>Hạn xử lý</td><td></td></tr><tr><td>13</td><td>satisfaction</td><td><span data-option="c1de87f3835849988fba39927355ae11">Int</span></td><td>Điểm hài lòng</td><td></td></tr><tr><td>14</td><td>satisfaction_at</td><td><span data-option="92bb4e6fd2e5421486918f8a8ffdc9fb">DateTime</span></td><td>Ngày đánh giá sự hài lòng</td><td></td></tr><tr><td>15</td><td>satisfaction_send</td><td><span data-option="92bb4e6fd2e5421486918f8a8ffdc9fb">DateTime</span></td><td>Ngày gửi đánh giá hài lòng</td><td></td></tr><tr><td>16</td><td>satisfaction_content</td><td><span data-option="bd16f1c24b0f4fe1b2a6918a3cef564d">String</span></td><td>Nội dung đánh giá hài lòng</td><td></td></tr><tr><td>17</td><td>campaign_id</td><td><span data-option="c1de87f3835849988fba39927355ae11">Int</span></td><td>ID chiến dịch, xem danh sách chiến dịch</td><td></td></tr><tr><td>18</td><td>automessage_id</td><td><span data-option="c1de87f3835849988fba39927355ae11">Int</span></td><td>ID Chiến dịch tự động </td><td></td></tr><tr><td>19</td><td>is_overdue</td><td><span data-option="c1de87f3835849988fba39927355ae11">Int</span></td><td>Trạng thái quá hạn xử lý </td><td></td></tr><tr><td>20</td><td>incident_id</td><td><span data-option="c1de87f3835849988fba39927355ae11">Int</span></td><td>ID<a data-footnote-ref href="#user-content-fn-3"> phiếu ghi cha </a></td><td></td></tr><tr><td>21</td><td>service_id</td><td><span data-option="c1de87f3835849988fba39927355ae11">Int</span></td><td>ID dịch vụ, xem danh sách dịch vụ</td><td></td></tr><tr><td>22</td><td>ticket_source_detail_id</td><td><span data-option="c1de87f3835849988fba39927355ae11">Int</span></td><td>ID nguồn chi tiết của phiếu ghi </td><td></td></tr><tr><td>23</td><td>comments</td><td><span data-option="58097ed0ba9e42819493eab2984fc5c1">Array</span></td><td>[1] Danh sách bình luận trên phiếu ghi</td><td></td></tr><tr><td>24</td><td>custom_filed</td><td><span data-option="58097ed0ba9e42819493eab2984fc5c1">Array</span></td><td>[2] Danh sách trường động và giá trị được lưu trữ cho phiếu ghi</td><td></td></tr><tr><td>25</td><td>assignee</td><td><span data-option="e0e0772e6f6a492b8bb350fcfaed9731">Object</span></td><td>[3] Đối tượng người xử lý</td><td></td></tr><tr><td>26</td><td>requester</td><td><span data-option="e0e0772e6f6a492b8bb350fcfaed9731">Object</span></td><td>[4] Đối tượng người yêu cầu</td><td></td></tr><tr><td>27</td><td>tags</td><td><span data-option="58097ed0ba9e42819493eab2984fc5c1">Array</span></td><td>Danh sách các thẻ được gắn</td><td></td></tr><tr><td>28</td><td>ccs</td><td><span data-option="58097ed0ba9e42819493eab2984fc5c1">Array</span></td><td>[5] Danh sách các người dùng được cc</td><td></td></tr><tr><td>29</td><td>follows</td><td><span data-option="58097ed0ba9e42819493eab2984fc5c1">Array</span></td><td>[6] Danh sách người dùng theo dõi</td><td></td></tr><tr><td>30</td><td>ticket_type</td><td><span data-option="bd16f1c24b0f4fe1b2a6918a3cef564d">String</span></td><td><h4>Trạng thái phản hồi</h4><p>Khi nhân viên chăm sóc khách hàng nhận được một yêu cầu từ khách hàng, họ sẽ thực hiện phản hồi qua một hoặc nhiều kênh khác nhau, <strong>không phụ thuộc vào kênh mà yêu cầu ban đầu được gửi đến</strong>.</p><p>Hệ thống CareSoft hỗ trợ ghi nhận trạng thái phản hồi dựa trên kênh đã sử dụng để phản hồi cho khách hàng. Các giá trị trạng thái bao gồm:</p><ul><li><code>'COMMENT'</code>: Đã để lại bình luận/phản hồi.</li><li><code>'CALLED'</code>: Đã thực hiện cuộc gọi đến khách hàng.</li><li><code>'ANSWERED_CALL'</code>: Đã tiếp nhận và trả lời cuộc gọi từ khách hàng.</li><li><code>'EMAIL'</code>: Đã gửi email.</li><li><code>'SMS'</code>: Đã gửi tin nhắn SMS.</li><li><code>'CHAT'</code>: Đã gửi tin nhắn qua kênh chat.</li><li><code>'ZNS'</code>: Đã gửi tin nhắn qua Zalo Notification Service (ZNS).</li><li><code>'NULL'</code>: Chưa thực hiện phản hồi nào.</li></ul></td><td></td></tr></tbody></table>

## Thêm mới, cập nhật phiếu ghi

#### Thêm mới phiếu ghi

## Thêm mới phiếu ghi

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

Sử dụng hàm này để thêm mới 1 phiếu ghi đồng thời thực hiện giao phiếu cho một chuyên viên chỉ định hoặc một phòng ban bất kỳ.&#x20;

#### Headers

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

#### Request Body

| Name                                                  | Type        | Description                                                                                                                                                                                                                        |
| ----------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ticket                                                | object      | Đối tượng phiếu ghi                                                                                                                                                                                                                |
| ticket.username                                       | String      | Tên người yêu cầu                                                                                                                                                                                                                  |
| ticket.phone<mark style="color:red;">\*</mark>        | Phone       | [(\*) Số điện thoại của người yêu cầu](#user-content-fn-4)[^4]                                                                                                                                                                     |
| ticket.city\_id                                       | String(4)   | ID của thành phố của người yêu cầu (Xem ở api [Thông tin tỉnh/huyện](https://docs.caresoft.vn/danh-muc/restful-api-cua-caresoft/khach-hang/thong-tin-tinh-huyen-xa)).                                                              |
| ticket.district\_id                                   | String(4)   | ID của quận/huyện người yêu cầu (Xem ở api [Thông tin tỉnh/huyện](https://docs.caresoft.vn/danh-muc/restful-api-cua-caresoft/khach-hang/thong-tin-tinh-huyen-xa))                                                                  |
| ticket.address                                        | String(255) | Địa chỉ của người yêu cầu                                                                                                                                                                                                          |
| ticket.email                                          | Email       | (\*) Email người yêu cầu                                                                                                                                                                                                           |
| ticket.ticket\_subject                                | String(255) | Tiêu đề phiếu ghi                                                                                                                                                                                                                  |
| ticket.ticket\_comment                                | String      | Ghi chú của phiếu ghi                                                                                                                                                                                                              |
| ticket.assignee\_id<mark style="color:red;">\*</mark> | Int         | [(\*\*) ID của người nhận phiếu ghi](#user-content-fn-5)[^5]                                                                                                                                                                       |
| ticket.group\_id                                      | Int         | (\*\*) ID của phòng ban được chia phiếu ghi                                                                                                                                                                                        |
| ticket.service\_id                                    | Int         | [(\*\*) ID của dịch vụ](#user-content-fn-6)[^6]                                                                                                                                                                                    |
| ticket.custom\_fields                                 | Array\[]    | (?)[^7] Mảng truyền dữ liệu trường động  phiếu ghi                                                                                                                                                                                 |
| ticket.requester\_id                                  | Int         | Id của người yêu cầu                                                                                                                                                                                                               |
| ticket.ref\_url                                       | URL         | [Địa chỉ trang web đánh dấu nguồn phát sinh ticket](#user-content-fn-8)[^8]                                                                                                                                                        |
| ticket.is\_public                                     | Int         | Trạng thái ghi chú hoặc phản hồi                                                                                                                                                                                                   |
| ticket.duedate                                        | DateTime    | Thời hạn xử lý                                                                                                                                                                                                                     |
| tickets.follow\_user                                  | String      | Danh sách ID của chuyên viên theo dõi phiếu ghi, cách nhau bởi dấu phẩy                                                                                                                                                            |
| tickets.ticket\_status                                | String      | Trạng thái phiếu ghi. Một trong 4 trạng thái ("new", "open","solved", "pending")                                                                                                                                                   |
| tickets.ticket\_priority                              | String      | Độ ưu tiên  là một trong 4 giá trị "High","Low","Normal","Urgent"                                                                                                                                                                  |
| tickets.cc\_user                                      | String      | Danh sách ID của khách hàng CC phiếu ghi, cách nhau bởi dấu phẩy                                                                                                                                                                   |
| tickets.campaign\_id                                  | Int         | ID chiến dịch                                                                                                                                                                                                                      |
| tickets.member\_status\_id                            | Int         | Trạng thái chiến dịch của đối tượng (Xem danh sách tại [đây ](https://docs.caresoft.vn/danh-muc/restful-api-cua-caresoft/chien-dich)), trong trường hợp không truyền sẽ lấy giá trị mặc định. Áp dụng cho chiến dịch có v\_type=1. |
| tickets.ref\_url                                      | String      | Địa chỉ nguồn phát sinh dữ liệu ví dụ trang web đặt form                                                                                                                                                                           |

{% tabs %}
{% tab title="200: OK Thành công" %}
{% tabs %}
{% tab title="Phản hồi thành công" %}
{% code title="Phiếu ghi tạo thành công " %}

```json
{
    "code": "ok",
    "ticket": {
        "updated_at": "2023-03-28 13:55:23",
        "ticket_subject": "Test create ticket from API",
        "ticket_no": 7016,
        "created_at": "2023-03-28 13:55:23",
        "ticket_id": 381185209,
        "requester_id": 126564055
    }
}

```

{% endcode %}

**Chi tiết các trường dữ liệu**&#x20;

<table><thead><tr><th width="70" data-type="number">STT</th><th width="187">Tên trường</th><th width="110">Kiểu</th><th>Ghi chú</th></tr></thead><tbody><tr><td>1</td><td>code</td><td>string</td><td>"ok": thành công, "nok": thất bại</td></tr><tr><td>2</td><td><em><mark style="color:green;"><code>ticket</code></mark></em></td><td>Object</td><td>Đối tượng phiếu ghi tạo thành công </td></tr><tr><td>3</td><td>ticket.updated_at</td><td>DateTime</td><td>Ngày cập nhật</td></tr><tr><td>4</td><td>ticket.created_at</td><td>DateTime</td><td>Ngày tạo</td></tr><tr><td>5</td><td>ticket.ticket_no</td><td>Int</td><td>Số phiếu ghi </td></tr><tr><td>6</td><td>ticket.ticket_id </td><td>Int</td><td><a data-footnote-ref href="#user-content-fn-9">(*) ID phiếu ghi </a></td></tr><tr><td>7</td><td>requester_id</td><td>Int</td><td><a data-footnote-ref href="#user-content-fn-10">(**) ID khách hàng </a></td></tr></tbody></table>
{% endtab %}

{% tab title="Mẫu json gửi đi" %}
{% code title="JSON body tạo ticket" overflow="wrap" %}

```json
{
    "ticket": {
        "phone": "0900000001",
        "username":"Khách hàng Demo",
        "service_id": 12,
        "ticket_subject": "Test create ticket from API",
        "ticket_comment": "Coment create ticket from Api  ",
        "ref_url":"https://caresoft.vn?utm=xtest",
        "duedate":"2023-06-01 20:00:00",
        "is_public":0        
    }
}
```

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

{% endtab %}

{% tab title="400: Bad Request Lỗi sai định dạng (kiểm tra cấu trúc JSON gửi đi sai cú pháp)" %}
{% tabs %}
{% tab title="Sai cú pháp" %}
{% code title="Thông báo lỗi sai cú pháp" %}

```json
{
    "code": "errors",
    "message": "Invalid Format"
}
```

{% endcode %}

{% endtab %}

{% tab title="Sai thông tin" %}
{% code title="Thông báo lỗi sai ID của người xử lý" %}

```json
{
"code": "errors",
"message": "invalid value: assignee_id"
}
```

{% endcode %}

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

{% tab title="500: Internal Server Error " %}

{% endtab %}

{% tab title="401: Unauthorized " %}
{% code title="Sai api token" %}

```json
{
    "code": "errors",
    "message": "Authorization header is incorrect"
}
```

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

{% hint style="info" %}
Nếu bạn đã có ID của người dùng bạn có thể truyền requester\_id mà không cần gửi email, số điện thoại.&#x20;

Hệ thống CareSoft sử dụng số điện thoại và email làm khóa duy nhất do đó sẽ luôn tạo phiếu ghi cho 1 người nếu bạn chỉ thay đổi tên người dùng&#x20;
{% endhint %}

Mẫu code&#x20;

{% tabs %}
{% tab title="curl" %}

```powershell
curl 
--location 'https://api.caresoft.vn/{{domain}}/api/v1/tickets' \
--header 'Authorization: Bearer {{apiToken}}' \
--header 'Content-Type: application/json' \
--data '{
    "ticket": {
        "phone": "0900000001",
        "username": "Khách hàng Demo",
        "service_id": 12,
        "ticket_subject": "Test create ticket from API",
        "ticket_comment": "Coment create ticket from Api  ",
        "ref_url": "https://caresoft.vn?utm=xtest",
        "is_public": 1
    }
}'
```

{% endtab %}

{% tab title="postman" %}

<figure><img src="https://2193274687-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fw9FEMPuWidjTVayVtnJj%2Fuploads%2FNvmbTOTUxY696Ipx0gZT%2FPostmanPostTicket.png?alt=media&#x26;token=15631067-4b15-43f5-bde2-cba3644704a4" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Mẫu body json" %}

```json
{
    "ticket": {
        "phone": "0900000001",
        "username": "Khách hàng Demo",
        "service_id": 12,
        "ticket_subject": "Test create ticket from API",
        "ticket_comment": "Coment create ticket from Api  ",
        "ref_url": "https://caresoft.vn?utm=xtest",
        "duedate":"2023-06-01 20:00:00",
        "is_public": 1
    }
}
```

{% endtab %}

{% tab title="Phản hồi thành công" %}

```json
{
    "code": "ok",
    "ticket": {
        "updated_at": "2023-03-28 13:55:23",
        "ticket_subject": "Test create ticket from API",
        "ticket_no": 7016,
        "created_at": "2023-03-28 13:55:23",
        "ticket_id": 381185209,
        "requester_id": 126564055
    }
}
```

{% endtab %}
{% endtabs %}

#### Cập nhật phiếu ghi

{% tabs %}
{% tab title="Mẫu body json" %}

```
{
    "ticket": {
        "ticket_subject": "Test",
        "ticket_comment": {
            "body": "Cập nhật giá trị mua hành thành giao hàng",
            "is_public": 1,
            "author_id": 124734559
        },
        "ticket_priority": "Hight",
        "ticket_source": "Voice",
        "custom_fields": [
            {
                "id": "6068",
                "value": "106902"
            }
        ]
    }
}

```

Biểu mẫu trên sẽ cập nhật phiếu ghi và 1 giá trị trường động&#x20;
{% endtab %}
{% endtabs %}

## Cập nhật phiếu ghi

<mark style="color:orange;">`PUT`</mark> `{{domain}}/api/v1/tickets/{{ticketId}}`

Cập nhật thông tin vào một phiếu ghi hiện hữu  cần ID của phiếu ghi theo biến `{{ticketId}}`.&#x20;

#### Headers

<table><thead><tr><th width="308">Name</th><th width="123">Type</th><th>Description</th></tr></thead><tbody><tr><td>**<mark style="color:red;">*</mark></td><td>String</td><td><a href="../../../thong-tin-chung#phuong-thuc-xac-thuc">Thông tin xác thực chung </a></td></tr></tbody></table>

#### Request Body

<table><thead><tr><th>Name</th><th width="124">Type</th><th>Description</th></tr></thead><tbody><tr><td>ticket<mark style="color:red;">*</mark></td><td>Object</td><td>Đối tượng phiếu ghi</td></tr><tr><td>ticket.ticket_subject</td><td>String</td><td>Tiêu đề phiếu ghi (nếu cần sửa)</td></tr><tr><td>ticket.ticket_comment<mark style="color:red;">*</mark></td><td>Object</td><td>Đối tượng ghi chú cho phiếu ghi. </td></tr><tr><td>ticket.ticket_comment.body<mark style="color:red;">*</mark></td><td>String</td><td>Nội dung comment</td></tr><tr><td>ticket.ticket_comment.is_public</td><td>Int</td><td><a data-footnote-ref href="#user-content-fn-11">(*) Trạng thái ghi chú có các giá trị 0 và 1  </a></td></tr><tr><td>ticket.ticket_comment.author_id<mark style="color:red;">*</mark></td><td>Int</td><td>(*)<a data-footnote-ref href="#user-content-fn-12"> ID của tác giả ghi chú</a></td></tr><tr><td>ticket.ticket_priority</td><td>String</td><td>(*) Độ ưu tiên của phiếu ghi có các trạng thái : Low, High, Normal</td></tr><tr><td>ticket.custom_fields</td><td>Array</td><td>Mảng thông tin trường động, xem thêm <a href="#danh-sach-truong-dong-phieu-ghi">ở đây</a></td></tr><tr><td>ticket.assignee_id</td><td>Int</td><td>Id của chuyên viên (trong trường hợp cần đổi chuyên viên của phiếu ghi) </td></tr><tr><td>ticket.solved_incidents </td><td>Boolean</td><td>True/False (Mặc định True) <br>Trong trường hợp truyền vào là False và ticket_status="Solved". Hệ thống sẽ kiểm tra phiếu ghi con liên quan nếu còn phiếu chưa solved sẽ trả về lỗi 400 kèm danh sách phiếu ghi chưa solved unsolved_incidents_ticket_id.</td></tr><tr><td>ticket.ticket_status</td><td>String</td><td>Trạng thái phiếu ghi nếu cần thay đổi, truyền 1 trong 4 giá trị: "new", "open", "pending", "solved".  <br></td></tr><tr><td>ticket.member_status_id</td><td>Int</td><td>Thay đổi trạng thái chiến dịch của đối tượng (Xem danh sách tại <a href="chien-dich">đây </a>),  Áp dụng cho chiến dịch có v_type=1. </td></tr></tbody></table>

{% tabs %}
{% tab title="200: OK Thành công" %}
{% tabs %}
{% tab title="Phản hồi thành công" %}

```json
{
    "code": "ok",
    "ticket": {
        "updated_at": "2023-03-29 17:18:40",
        "ticket_subject": "Test",
        "ticket_no": 7043,
        "created_at": "2023-03-29 13:25:31",
        "ticket_id": 381440615
    }
}
```

{% endtab %}

{% tab title="Mẫu param gửi đi" %}

```json
{
    "ticket": {
        "ticket_subject": "Test",
        "ticket_comment": {
            "body": "Comment",
            "is_public": 1,
            "author_id": 124734559
        },
        "ticket_priority": "Hight",
        "ticket_source": "Voice",
        "custom_fields": [
            {
                "id": "6068",
                "value": "106902"
            }
        ]
    }
}

```

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

{% tab title="400: Bad Request Thất bại" %}
{% code title="Lỗi sai tác giả" %}

```json
{
    "code": "errors",
    "message": "invalid value: author_id"
}
```

{% endcode %}

{% code title="Lỗi ID phiếu ghi không tồn tai" %}

```json
{
    "code": "errors",
    "message": "Ticket is not exist"
}

```

{% endcode %}
{% endtab %}

{% tab title="401: Unauthorized Sai token" %}

{% endtab %}

{% tab title="400 Lỗi phiếu ghi con chưa solved" %}

```json
{
    "code": "errors",
    "message": "unsolved_incidents_ticket",
    "extraDataJson": {
        "unsolved_incidents_ticket_id": [
            474842751
        ]
    }
}
```

{% endtab %}
{% endtabs %}

## Danh sách trường động phiếu ghi

Trường động được cấu hình trên giao diện CareSoft. Có 7 kiểu dữ liệu cho trường động phiếu ghi.&#x20;

<figure><img src="https://2193274687-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fw9FEMPuWidjTVayVtnJj%2Fuploads%2FpoDumlWd8ryssk6nmEIa%2FCauHinhTruongDongPhieuGhi.png?alt=media&#x26;token=d20bd972-fecb-4920-8d31-91085bfbb35e" alt=""><figcaption><p>Cách thức cấu hình trường động phiếu ghi và danh sách các trường động đang có trên giao diện caresoft</p></figcaption></figure>

#### **Chi tiết các kiểu dữ liệu của trường động phiếu ghi.**

<table><thead><tr><th width="73.33333333333331" data-type="number">STT</th><th width="254">Kiểu<select><option value="3b555bec719344f78f8b67c63162bb3f" label="TEXT" color="blue"></option><option value="f07a68d773224b7d8848ad1ad6278e0f" label="NUMBER" color="blue"></option><option value="6a4e190eb3a7468798e53c3b6bd7dd6a" label="DATE" color="blue"></option><option value="fc3026d4d20747eda24902cfd59b765a" label="SINGLE DROP-DOWN LIST" color="blue"></option><option value="8e04f7e4186e4e56a8d593557f7819b7" label="MULTIPLE SELECT DROP-DOWN LIST" color="blue"></option><option value="5fa31b9990694be683f59c9a59f93aac" label="STAGE" color="blue"></option><option value="12f0a7fd99f34c3ea88b6daaf9d79182" label="TEXT AREA" color="blue"></option><option value="2cc2620ad7ad4584b94da1f92e3ce345" label="LINK" color="blue"></option></select></th><th>Ghi chú</th></tr></thead><tbody><tr><td>1</td><td><span data-option="3b555bec719344f78f8b67c63162bb3f">TEXT</span></td><td>Văn bản text (độ dài tối đa 255 ký tự)</td></tr><tr><td>2</td><td><span data-option="f07a68d773224b7d8848ad1ad6278e0f">NUMBER</span></td><td>Kiểu số</td></tr><tr><td>3</td><td><span data-option="6a4e190eb3a7468798e53c3b6bd7dd6a">DATE</span></td><td>Kiểu ngày tháng, định dạng <code>YYYY/MM/DD</code> </td></tr><tr><td>4</td><td><span data-option="fc3026d4d20747eda24902cfd59b765a">SINGLE DROP-DOWN LIST</span></td><td>Kiểu chọn 1 giá trị </td></tr><tr><td>5</td><td><span data-option="8e04f7e4186e4e56a8d593557f7819b7">MULTIPLE SELECT DROP-DOWN LIST</span></td><td>Kiểu chọn nhiều giá trị</td></tr><tr><td>6</td><td><span data-option="12f0a7fd99f34c3ea88b6daaf9d79182">TEXT AREA</span></td><td>Kiểu văn bản với giao diện hiển thị mở rộng</td></tr><tr><td>7</td><td><span data-option="5fa31b9990694be683f59c9a59f93aac">STAGE</span></td><td>Kiểu trạng thái stage, là dạng chọn 1 giá trị tương đương kiểu chọn 1 giá trị </td></tr><tr><td>8</td><td><span data-option="2cc2620ad7ad4584b94da1f92e3ce345">LINK</span></td><td>Kiểu địa chỉ website, định dạng <code>http://</code> hoặc <code>https://</code> </td></tr></tbody></table>

{% hint style="info" %}
L**ưu ý:** Trường động phiếu ghi có thể được bật/ tắt hoặc thay đổi kiểu từ giao diện hệ thống CareSoft,  cần đồng bộ định kỳ hàng ngày để đảm bảo các cấu hình thông tin giữa các hệ thống thông suốt.
{% endhint %}

## Danh sách trường động phiếu ghi

<mark style="color:blue;">`GET`</mark> `{{domain}}/api/v1/tickets/custom_fields`

#### 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) |

{% tabs %}
{% tab title="200: OK " %}
{% tabs %}
{% tab title="Kết quả thành công " %}
{% code title="Mẫu kết quả điển hình" %}

```json
{
  "code": "ok",
  "custom_fields": [
    {
      "custom_field_id": 5159,
      "code":"GHICHU",
      "custom_field_lable": "Ghi chú của",
      "type": "Text Area"
    },
    {
      "custom_field_id": 5160,
      "code":"CHITIETSANPHAM",
      "custom_field_lable": "Chi tiết sản phẩm",
      "type": "Single drop-down list",
      "values": [
        {
          "id": 110725,
          "code":"SachOLY",
          "lable": "Sách ô ly",
          "parent_value_id": 106473
        },
        {
          "id": 110726,
          "lable": "Sách 2",
          "code":null,
          "parent_value_id": 106473
        },
        {
          "id": 110727,
          "code":nul
          "lable": "Bút bi",
          "parent_value_id": 106474
        },
        {
          "id": 110728,
          "code":nul
          "lable": "Bút mực",
          "parent_value_id": 106474
        }
      ]
    }
  ]
}
```

{% endcode %}
{% endtab %}

{% tab title="Mô tả kết quả" %}

<table><thead><tr><th width="84" data-type="number">STT</th><th width="179">Tên trường</th><th width="116">Kiểu</th><th>Ghi chú</th></tr></thead><tbody><tr><td>1</td><td>code</td><td>String</td><td><a data-footnote-ref href="#user-content-fn-13">Trạng thái </a></td></tr><tr><td>2</td><td>custom_fields</td><td>Array</td><td>[1] Mảng dữ liệu trường động </td></tr></tbody></table>

*\[1] Chi tiết dữ liệu trường động*

<table><thead><tr><th width="82" data-type="number">STT</th><th width="185">Tên trường</th><th>Chú thích</th></tr></thead><tbody><tr><td>1</td><td>custom_field_id</td><td>ID của trường động</td></tr><tr><td>2</td><td>custom_field_lable</td><td>Tên của trường động </td></tr><tr><td>3</td><td>type</td><td><a data-mention href="#chi-tiet-cac-kieu-du-lieu-cua-truong-dong-phieu-ghi.">#chi-tiet-cac-kieu-du-lieu-cua-truong-dong-phieu-ghi.</a></td></tr><tr><td>4</td><td>values</td><td>Mảng object giá trị và ID giá trị được cấu hình sẵn trên caresoft. (Đối với loại trường động dạng chọn 1, chọn nhiều và tiến Trình (type=3,4,7) </td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="401: Unauthorized " %}

{% endtab %}

{% tab title="404: Not Found " %}

{% endtab %}
{% endtabs %}

## Danh sách phiếu ghi&#x20;

Tùy theo từng nghiệp vụ nhà phát triển có thể sử dụng các param CareSoft cung cấp để lọc các phiếu ghi phát sinh trong quá trình hoạt động.&#x20;

### 1. Danh sách phiếu ghi&#x20;

*(Phiên bản V2)*

{% hint style="warning" %}
**Lưu ý:** API Danh sách phiếu ghi bắt buộc  phải có 1 trong hai cặp parameter  \[created\_since/created\_to] Hoặc \[updated\_since/updated\_to] và thời gian không quá 31 ngày.

Trong trường hợp tất cả các  param đều được điền dữ liệu thì cặp \[updated\_since/updated\_to] được ưu tiên. \
Định dạng dữ liệu dạng Năm-Tháng-NgàyTGiờ:Phút:GiâyZ \
Ví dụ: `created_since=2023-06-26T00:00:00Z` \
Các  hệ thống đang tích hợp cần bổ sung điều kiện tìm kiếm để đáp ứng. Thông báo lỗi sẽ trả về mã lỗi "errors" và param đính kèm ( Xem thêm trong phần Response của API phía dưới: Lỗi 400)
{% endhint %}

## V2- Lấy danh sách phiếu ghi&#x20;

<mark style="color:blue;">`GET`</mark> `{{domain}}/api/v2/tickets`

Danh sách phiếu ghi và các điều kiện lọc danh sách phiếu ghi qua API

#### 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                                                                                                          |
| ------------------------------------------------ | ------------------ | -------------------------------------------------------------------------------------------------------------------- |
| created\_since                                   | DateTime (ISO8601) | Ngày tạo từ lúc, định dạng YYYY-mm-ddTHH:mm:ssZ                                                                      |
| created\_to                                      | DateTime (ISO8601) | Ngày tạo tới, định dạng YYYY-mm-ddTHH:mm:ssZ                                                                         |
| updated\_since<mark style="color:red;">\*</mark> | DateTime (ISO8601) | Ngày cập nhật từ, định dạng YYYY-mm-ddTHH:mm:ssZ                                                                     |
| updated\_to<mark style="color:red;">\*</mark>    | DateTime (ISO8601) | Ngày cập nhật tới, định dạng YYYY-mm-ddTHH:mm:ssZ                                                                    |
| requester\_id                                    | Int                | ID người yêu cầu                                                                                                     |
| assignee\_id                                     | Int                | ID người xử lý                                                                                                       |
| service\_id                                      | Int                | ID dịch vụ                                                                                                           |
| page                                             | Int                | Trang số                                                                                                             |
| count                                            | Int                | Số bản ghi trên trang (tối đa 500)                                                                                   |
| filter\_id                                       | Int                | ID bộ lọc *(Không khả dụng với các bác bộ lọc có tham số người dùng đăng nhập hay bộ phận của người dùng đăng nhập)* |

{% tabs %}
{% tab title="200: OK Kết quả thành công" %}
{% tabs %}
{% tab title="Kết quả điển hình" %}

```json
{
    "code": "ok",
    "numFound": 414,
    "tickets": [
        {
            "ticket_no": 7464,
            "ticket_status": "new",
            "ticket_subject": "Cuộc gọi ra gặp khách hàng tới ****",
            "created_at": "2023-04-24T17:01:35Z",
            "updated_at": "2023-04-24T17:01:52Z",
            "ticket_source_end_status": 0,
            "ticket_source": "Voice Out",
            "ticket_priority": "Normal",
            "service_id": 20043428,
            "ticket_id": 387792628,
            "requester_id": 165802327,
            "assignee_id": 162712234,
            "custom_fields": [              
                {
                    "id": 5163,
                    "lable": "Tiến trình Deal",
                    "type": "Stage",
                    "value": 13332
                },
                {
                    "id": 5164,
                    "lable": "Phân loại phiếu ghi",
                    "type": "Single drop-down list",
                    "value": 1122
                },  
                ....                
                                                              
                 
            ],
            "assignee": {
                "id": 162712234,
                "username": "ltvyy",
                "email": "****m",
                "phone_no": "0****",
                "agent_id": "50027",
                "role_id": 2,
                "group_id": 14181,
                "group_name": "ORV"
            },
            "requester": {
                "id": 165802327,
                "username": "09326****",
                "email": null,
                "phone_no": "0932****",
                "organization_id": null
            },
            "tags": [],
            "ccs": [],
            "follows": []
        },
    ...
  ]
}
```

{% endtab %}

{% tab title="Mô tả kết quả" %}

<table><thead><tr><th width="139">STT</th><th>Tên trường</th><th>Chú thích</th></tr></thead><tbody><tr><td>1</td><td>code</td><td><p>Trạng thái yêu cầu:<br>ok: Thành công</p><p>error: Thất bại</p></td></tr><tr><td>2</td><td>numFound</td><td>Số bản ghi tìm thấy</td></tr><tr><td>3</td><td>tickets [array]</td><td>Mảng dữ liệu phiếu ghi chứa các đối tượng thông tin phiếu ghi</td></tr></tbody></table>

Chi tiết 1 đối tượng phiếu ghi trong mảng tickets

<table><thead><tr><th width="138">STT</th><th>Tên trường</th><th>Chú thích</th></tr></thead><tbody><tr><td>1</td><td>ticket_no</td><td>Số phiếu ghi</td></tr><tr><td>2</td><td>ticket_status</td><td>Trạng thái phiếu ghi là 1 trong trong các giá trị<br>New, Open, Pending, Closed, Solved</td></tr><tr><td>3</td><td>ticket_subject</td><td>Chủ đề phiếu ghi</td></tr><tr><td>4</td><td>created_at</td><td>Ngày tạo</td></tr><tr><td>5</td><td>updated_at</td><td>Ngày cập nhật </td></tr><tr><td>6</td><td>ticket_source_end_status</td><td><a data-footnote-ref href="#user-content-fn-14">Trạng thái kết thúc thoại, chat</a></td></tr><tr><td>7</td><td>ticket_source</td><td>Nguồn phiếu ghi (xem trong danh sách nguồn)</td></tr><tr><td>8</td><td>ticket_priority</td><td>Độ ưu tiên: Gồm các giá trị High, Normal, Low</td></tr><tr><td>9</td><td>service_id</td><td>ID của dịch vụ tạo ra phiếu ghi</td></tr><tr><td>10</td><td>ticket_id</td><td>{{ticketId}} ID của phiếu ghi dùng để giao tiếp qua API </td></tr><tr><td>11</td><td>requester_id</td><td>ID của người yêu cầu, khi lấy thông tin truy xuất chi tiết người yêu cầu thì dùng  ID này</td></tr><tr><td>12</td><td>assignee_id</td><td>ID của chuyên viên xử lý</td></tr><tr><td>13</td><td>custom_fields[array]</td><td>Mảng trường động phiếu ghi và giá trị của nó</td></tr><tr><td>14</td><td>assignee (object)</td><td>Thông tin cơ bản của người xử lý (Tên, ID, Email ..)</td></tr><tr><td>15</td><td>requester (object)</td><td>Thông tin cơ bản của người yêu cầu (Tên, ID, Email ..)</td></tr><tr><td>16</td><td>tags[array]</td><td>Mảng chứa tag của phiếu ghi</td></tr><tr><td>17</td><td>ccs[array]</td><td>Mảng danh sách thông tin người được ccs</td></tr><tr><td>18</td><td>follows [array]</td><td>Mảng danh sách chuyên viên được follow</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="401: Unauthorized " %}

{% endtab %}

{% tab title="403: Forbidden " %}

{% endtab %}

{% tab title="500: Internal Server Error " %}

{% endtab %}

{% tab title="400: Bad Request Thông báo lỗi điều kiện đầu vào" %}
1\.  Lỗi chưa có cặp điều kiện bắt buộc\
\
`Request required [updated_since/updated_to] or [created_since/created_to]`\
\
2\. Lỗi thiếu một trong các param hoặc dữ liệu điền trong các param không hợp lệ\
Định dạng phải là "YYYY-MM-DDTHH:mm:ssZ\
\
`Request required [updated_since/updated_to]`\
`Request required [created_since/created_to]`\
\
3\. Lỗi từ ngày/ đến ngày quá 31 ngày  hoặc từ ngày lớn hơn tới ngày \
`created_since must older than created_to and max 31 days`\
\
4\. Lỗi filterID không thể lấy dữ liệu (thường là các filter ID có cấu hình động theo người dùng đăng nhập \
\
`Can't get this filter!`
{% endtab %}
{% endtabs %}

### 2. Danh sách  phiếu ghi &#x20;

*(Phiên bản 1)*

{% hint style="info" %}
**Lưu ý:** Một thuật toán tối ưu lệnh tìm kiếm phiếu ghi sẽ được thực hiện theo mô hình sau

1. Khi gọi API không cung cấp khoảng ngày kết thúc (chỉ truyền ngày bắt đầu:  created\_since hoặc updated\_since). Mà ngày bắt đầu trước  ngày hiện tại hơn 31 ngày thì hệ thống sẽ tự động chọn khoảng ngày kết thúc là ngày hiện tại và trả về kết quả trong 31 ngày tính từ ngày hiện tại.  Nếu ngày bắt đầu nhỏ hơn ngày hiện tại dưới 31 ngày thì hệ thống giữ nguyên ngày bắt đầu và tiến hành lọc dữ liệu theo tham số trên
2. Khi gọi API cung cấp khoảng ngày kết thúc (param: created\_to hoặc updated\_to). Mà ngày kết thúc sau ngày bắt đầu quá 31 ngày thì hệ thống tự chọn lại khoảng ngày bắt đầu bằng ngày kết thúc - 31 ngày
3. Khi gọi API cung cấp cả hai tham số Bắt đầu và Kết thúc cách nhau không quá 31 ngày thì hệ thống lọc phiếu ghi theo giá trị truyền vào này và trả về kết quả tương ứng.
4. Trong trường hợp cặp điều kiện `created_since` và `updated_since` đều được cung cấp hệ thống sẽ ưu tiên xử lý theo điều kiện `updated_since`
   {% endhint %}

## V1- Lấy danh sách phiếu ghi&#x20;

<mark style="color:blue;">`GET`</mark> `{{domain}}/api/v1/tickets`

Danh sách phiếu ghi và các điều kiện lọc danh sách phiếu ghi qua API, Bắt buộc phải có 1 tham số created\_since hoặc updated\_since&#x20;

#### Headers

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

#### Request Body

| Name                                             | Type               | Description                                                                                                          |
| ------------------------------------------------ | ------------------ | -------------------------------------------------------------------------------------------------------------------- |
| created\_since<mark style="color:red;">\*</mark> | DateTime (ISO8601) | Ngày tạo từ lúc, định dạng YYYY-mm-ddTHH:mm:ssZ                                                                      |
| created\_to                                      | DateTime (ISO8601) | Ngày tạo đến lúc, định dạng YYYY-mm-ddTHH:mm:ssZ                                                                     |
| updated\_since<mark style="color:red;">\*</mark> | DateTime (ISO8601) | Ngày cập nhật từ lúc, định dạng YYYY-mm-ddTHH:mm:ssZ                                                                 |
| updated\_to                                      | DateTime (ISO8601) | Ngày cập nhật đến lúc, định dạng YYYY-mm-ddTHH:mm:ssZ                                                                |
| assignee\_id                                     | Int                | ID người xử lý                                                                                                       |
| service\_id                                      | Int                | ID dịch vụ                                                                                                           |
| page                                             | Int                | Trang số (Mặc định 1)                                                                                                |
| count                                            | Int                | Số bản ghi trên trang (Mặc định 50 tối đa 500)                                                                       |
| filter\_id                                       | Int                | ID bộ lọc *(Không khả dụng với các bác bộ lọc có tham số người dùng đăng nhập hay bộ phận của người dùng đăng nhập)* |
| requester\_id                                    | Int                | ID người yêu cầu                                                                                                     |

{% tabs %}
{% tab title="200: OK Thành công" %}

```json
{
    "code": "ok",
    "numFound": 414,
    "tickets": [
        {
            "ticket_no": 7464,
            "ticket_status": "new",
            "ticket_subject": "Cuộc gọi ra gặp khách hàng tới ****",
            "created_at": "2023-04-24T17:01:35Z",
            "updated_at": "2023-04-24T17:01:52Z",
            "ticket_source_end_status": 0,
            "ticket_source": "Voice Out",
            "ticket_priority": "Normal",
            "service_id": 20043428,
            "ticket_id": 387792628,
            "requester_id": 165802327,
            "assignee_id": 162712234,
            "custom_fields": [              
                {
                    "id": 5163,
                    "lable": "Tiến trình Deal",
                    "type": "Stage",
                    "value": 13332
                },
                {
                    "id": 5164,
                    "lable": "Phân loại phiếu ghi",
                    "type": "Single drop-down list",
                    "value": 1122
                },  
                ....                
                                                              
                 
            ],
            "assignee": {
                "id": 162712234,
                "username": "ltvyy",
                "email": "****m",
                "phone_no": "0****",
                "agent_id": "50027",
                "role_id": 2,
                "group_id": 14181,
                "group_name": "ORV"
            },
            "requester": {
                "id": 165802327,
                "username": "09326****",
                "email": null,
                "phone_no": "0932****",
                "organization_id": null
            },
            "tags": [],
            "ccs": [],
            "follows": []
        },
    ...
  ]
}
```

{% endtab %}

{% tab title="400: Bad Request Lỗi thông tin đầu vào" %}

{% endtab %}

{% tab title="403: Forbidden Lỗi xác thực" %}

{% endtab %}

{% tab title="500: Internal Server Error Lỗi máy chủ" %}

{% endtab %}
{% endtabs %}

## Chi tiết phiếu ghi

Dựa trên danh sách phiếu ghi, hoặc việc tạo, cập nhật các phiếu ghi, nhà phát triển có được ID của phiếu ghi. được định danh là "ticketId"

## Lấy chi tiết thông tin phiếu ghi

<mark style="color:blue;">`GET`</mark> `{{domain}}/api/v1/tickets/{{ticketId}}`

Lấy về thông tin chi tiết 1 phiếu ghi theo <mark style="color:green;">`{{ticketId}}`</mark>

#### 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) |

{% tabs %}
{% tab title="200: OK Thông tin thành công" %}
{% tabs %}
{% tab title="Kết quả điển hình " %}
{% code overflow="wrap" %}

```json
{
    "ticket": {
        "account_id": 8187,
        "ticket_id": 387792628,
        "sla_id": 8113,
        "ticket_no": 7464,
        "requester_id": 165802327,
        "group_id": 14181,
        "ticket_source_end_status": 0,
        "assignee_id": 162712234,
        "ticket_priority": "Normal",
        "ticket_source": "Voice Out",
        "ticket_status": "new",
        "ticket_subject": "Cuộc gọi ra gặp khách hàng tới 0932****",
        "created_at": "2023-04-24 17:01:35",
        "updated_at": "2023-04-24 17:01:52",
        "solved": "2023-04-24 17:01:52",
        "duedate": null,
        "satisfaction": null,
        "satisfaction_at": null,
        "satisfaction_send": null,
        "satisfaction_content": null,
        "campaign_id": null,
        "automessage_id": null,
        "feedback_status": "ANSWERED_CALL",
        "is_overdue": null,
        "incident_id": null,
        "service_id": 20043428,
        "ticket_source_detail_id": 85041,
        "qa_agent": 126642807,
        "qa_script_id": 341,
        "current_agent": 124733804,
        "comments": [
            {
                "id": 933864241,
                "comment": "<b>Cuộc gọi ra</b><br/>Người gọi ra: ltvyy (156@gmail.com)<br/>ID cuộc gọi: 20230424170134-OUTOLTHV-935954<br/>Số điện thoại gọi tới: 093xxx<br/>Đầu số gọi ra: xxxx<br/>Thời gian bắt đầu: 2023-04-24 17:01:34<br/>Khách hàng trả lời cuộc gọi<br/>Thời gian trả lời: 2023-04-24 17:01:37<br/>Agent kết thúc cuộc gọi<br/>Thời gian kết thúc: 2023-04-24 17:01:52<br/>Thời lượng cuộc gọi: 00:00:15",
                "commentator_id": 162712234,
                "commentator_name": "ltvyy",
                "comment_source": "Voice Out",
                "call_id": "20230424170134-OUTOLTHV-935954",
                "created_at": "2023-04-24 17:01:35",
                "is_public": 1,
                "addition_details": null,
                "call_info": {
                    "start_time": "2023-04-24 17:01:34",
                    "end_time": "2023-04-24 17:01:51",
                    "called": "842871****",
                    "caller": "09326***",
                    "call_id": "20230424170134-OUTOLTHV-935954"
                }
            }
        ],
        "custom_filed": [
            
                {
                    "id": 5163,
                    "lable": "Tiến trình Deal",
                    "type": "Stage",
                    "value": 13332
                },
                {
                    "id": 5164,
                    "lable": "Phân loại phiếu ghi",
                    "type": "Single drop-down list",
                    "value": 1122
                },  
                ....  
        ],
        "assignee": {
            "id": 162712234,
            "username": "ltvyy",
            "email": "1****",
            "phone_no": "01****",
            "agent_id": "50027",
            "role_id": 1,
            "group_id": 14181,
            "group_name": "ORV"
        },
        "requester": {
            "id": 165802327,
            "username": "09326****",
            "email": null,
            "phone_no": "09326*****",
            "organization_id": null
        },
        "tags": [],
        "ccs": [],
        "follows": [],
        "sla": "2d 06:23",     
        "qa_script": {
            "id": 481,
            "name": "Điểm âm đúng sai",
            "description": "Điểm âm đúng sai",
            "created_at": "2023-05-27 00:10:32",
            "updated_at": "2023-05-27 00:10:32"
        },
        "qa_result": {
            "updated_at": "2023-06-24 02:55:45",
            "is_agree": null,
            "agent_comment": null,
            "agent_comment_time": null,
            "is_lead_agree": null,
            "qa_lead_id": null,
            "qa_lead_name": null,
            "qa_lead_comment": null,
            "qa_comment_time": null,
            "rate": -27,
            "lstQuestions": [
                {
                    "field": "qa_field1",
                    "info": "kí tự",
                    "type": 0,
                    "rate_type": 1,
                    "rate_point": 0,
                    "comment": ""
                },
                {
                    "field": "qa_field2",
                    "info": "số",
                    "type": 1,
                    "rate_type": 1,
                    "rate_point": -1,
                    "comment": ""
                },
                {
                    "field": "qa_field3",
                    "info": "nt",
                    "type": 2,
                    "rate_type": 1,
                    "rate_point": 10,
                    "comment": null
                },
                {
                    "field": "qa_field4",
                    "info": "chọn1pa",
                    "type": 3,
                    "rate_type": -1,
                    "lstOptions": [
                        {
                            "id": 6901,
                            "description": "a1",
                            "point": -100
                        },
                        {
                            "id": 6902,
                            "description": "a1",
                            "point": -50
                        }
                    ],
                    "rate_point": -50
                },
                {
                    "field": "qa_field5",
                    "info": "chon n",
                    "type": 4,
                    "rate_type": -1,
                    "lstOptions": [
                        {
                            "id": 6903,
                            "description": "n1",
                            "point": -4
                        },
                        {
                            "id": 6904,
                            "description": "n2",
                            "point": -10
                        },
                        {
                            "id": 6905,
                            "description": "n3",
                            "point": 5
                        },
                        {
                            "id": 6906,
                            "description": "n4",
                            "point": 8
                        }
                    ],
                    "rate_point": 4
                },
                {
                    "field": "qa_field6",
                    "info": "vban",
                    "type": 6,
                    "rate_type": 1,
                    "rate_point": 10,
                    "comment": ""
                }
            ]
        },
        "qa_agent_name": {
            "username": "QA Test",
            "id": 126642807
        },
        "qa_current_agent": {
            "username": "Admin",
            "id": 124734559
        }


    }
}

```

{% endcode %}
{% endtab %}

{% tab title="Mô tả kết quả" %}

| STT           | Tên trường                  | Chú thích                                                                                                                                                              |
| ------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1             | ticket\_no                  | Số phiếu ghi                                                                                                                                                           |
| 2             | ticket\_status              | Trạng thái phiếu ghi là 1 trong trong các giá trị New, Open, Pending, Closed, Solved                                                                                   |
| 3             | ticket\_subject             | Chủ đề phiếu ghi                                                                                                                                                       |
| 4             | created\_at                 | Ngày tạo                                                                                                                                                               |
| 5             | updated\_at                 | Ngày cập nhật                                                                                                                                                          |
| 6             | ticket\_source\_end\_status | Trạng thái kết thúc thoại, chat                                                                                                                                        |
| 7             | ticket\_source              | Nguồn phiếu ghi (xem trong danh sách nguồn)                                                                                                                            |
| 8             | ticket\_priority            | Độ ưu tiên: Gồm các giá trị High, Normal, Low                                                                                                                          |
| 9             | service\_id                 | ID của dịch vụ tạo ra phiếu ghi                                                                                                                                        |
| 10            | ticket\_id                  | {{ticketId}} ID của phiếu ghi dùng để giao tiếp qua API                                                                                                                |
| 11            | requester\_id               | ID của người yêu cầu, khi lấy thông tin truy xuất chi tiết người yêu cầu thì dùng ID này                                                                               |
| 12            | assignee\_id                | ID của chuyên viên xử lý                                                                                                                                               |
| 13            | custom\_fields\[array]      | Mảng trường động phiếu ghi và giá trị của nó                                                                                                                           |
| 14            | assignee (object)           | Thông tin cơ bản của người xử lý (Tên, ID, Email ..)                                                                                                                   |
| 15            | requester (object)          | Thông tin cơ bản của người yêu cầu (Tên, ID, Email ..)                                                                                                                 |
| 16            | tags\[array]                | Mảng chứa tag của phiếu ghi                                                                                                                                            |
| 17            | ccs\[array]                 | Mảng danh sách thông tin người được ccs                                                                                                                                |
| 18            | follows \[array]            | Mảng danh sách chuyên viên được follow                                                                                                                                 |
| 19            | duedate                     | Thời hạn xử lý                                                                                                                                                         |
| 20            | satisfaction                | Đánh giá của khách hàng                                                                                                                                                |
| 21            | satisfaction\_at            | Thời điểm đánh giá                                                                                                                                                     |
| 22            | satisfaction\_send          | Thời điểm gửi đánh giá                                                                                                                                                 |
| 23            | satisfaction\_content       | Nội dung đánh giá                                                                                                                                                      |
| 24            | campaign\_id                | ID chiến dịch                                                                                                                                                          |
| 25            | automessage\_id             | ID Tin nhắn tự động                                                                                                                                                    |
| 26            | feedback\_status            | Trạng thái phản hồi                                                                                                                                                    |
| 27            | is\_overdue                 | Trạng thái quá hạn xử lý                                                                                                                                               |
| 28            | incident\_id                | ID phiếu ghi cha (nếu có)                                                                                                                                              |
| 29            | ticket\_source\_detail\_id  | ID nguồn chi tiết                                                                                                                                                      |
| 30            | comments \[Array]           | Mảng các ghi chú và tương tác với phiếu ghi                                                                                                                            |
| 31            | sla\_id                     | ID thỏa thuận dịch vụ                                                                                                                                                  |
| 32            | qa\_agent                   | ID Chuyên viên QA                                                                                                                                                      |
| 33            | qa\_script\_id              | ID Kịch bản QA                                                                                                                                                         |
| 34            | current\_agent              | ID Chuyên viên                                                                                                                                                         |
| 35            | qa\_result                  | <p>Object kết quả QA</p><p>Trong đó<br>- info: Tên câu hỏi</p><p>-rate\_point: Điểm được chấm<br>- rate: Tổng điểm<br>- comment: ý kiến bổ sung trong câu trả lời </p> |
| 36            | qa\_script                  | Object thông tin Kịch bản QA                                                                                                                                           |
| 37            | sla                         | Thời hạn còn lại của thỏa thuận dịch vụ (phiên bản 1)                                                                                                                  |
| 38            | solved                      | Thời điểm solved phiếu                                                                                                                                                 |
| {% endtab %}  |                             |                                                                                                                                                                        |
| {% endtabs %} |                             |                                                                                                                                                                        |
| {% endtab %}  |                             |                                                                                                                                                                        |

{% tab title="404: Not Found " %}

{% endtab %}

{% tab title="403: Forbidden Lỗi xác thực" %}

{% endtab %}

{% tab title="500: Internal Server Error Lỗi máy chủ" %}

{% endtab %}

{% tab title="400: Bad Request Lỗi thông tin đầu vào" %}

{% endtab %}
{% endtabs %}

[^1]: **Các trạng thái gồm**&#x20;

    * <mark style="color:blue;">New</mark>
    * <mark style="color:red;">Open</mark>
    * Closed
    * Solved
    * <mark style="color:green;">Pending</mark>

[^2]: Độ ưu tiên gồm&#x20;

    * <mark style="color:red;">High</mark>
    * <mark style="color:green;">Normal</mark>
    * Low

[^3]: 1 Phiếu ghi có phiếu ghi cha nếu `incident_id` khác -1 hoặc null, trong trường hợp `incident_id` =-1 hoặc null&#x20;

[^4]: Bắt buộc một trong các trường Phone\_no hoặc Email

[^5]: Bắt buộc một trong các trường Assignee\_id, Group\_id hoặc service\_id. Để lấy assignee\_id xem trong api [Danh sách chuyên viên](https://docs.caresoft.vn/danh-muc/restful-api-cua-caresoft/chuyen-vien)

[^6]: Có thể tạo 1 dịch vụ và cấu hình cho 1 nhóm chuyên viên xử lý các phiếu ghi phát sinh từ dịch vụ này

[^7]: Vui lòng xem thêm API [danh sách trường động ticket](#danh-sach-truong-dong-phieu-ghi)

[^8]: Khi gửi kèm tham số ref\_url, hệ thống sẽ tự tạo 1 nguồn chi tiết dựa trên tên miền, các mã utm kèm trong link để gom nhóm các phiếu ghi từ một bộ UTM tracking, Giúp cho việc báo cáo  và định lượng hiện quả thuận tiện hơn.&#x20;

[^9]: ID này dùng để lấy thông tin chi tiết hoặc cập nhật một phiếu ghi hiện hữu

[^10]: Sử dụng ID này để lấy thông tin khách hàng đang lưu trữ trên caresoft hoặc các tương tác khác

[^11]: **Các giá trị tương ứng**

    1: Gửi  ra ngoài tới người yêu cầu,&#x20;

    0: Ghi chú nội bộ

[^12]: Tác giả ghi chú có thể là ID Chuyên viên hoặc  Khách hàng.&#x20;

[^13]:

[^14]: Nếu nguồn phiếu ghi là thoại thì: Giá trị 2 là cuộc gọi nhỡ\
    Nếu nguồn phiếu ghi là chat thì giá trị =1 là chat nhỡ