# Chat

Tài liệu lấy dữ liệu lịch sử chat trên hệ thống CareSoft

{% hint style="info" %}
LƯU Ý: Trong trường hợp không truyền tham số `conversation_type` thì hệ thống chỉ lọc lịch sử LIVE chat 
{% endhint %}

<table><thead><tr><th width="82.33333333333331">STT</th><th width="213">Tên trường</th><th>Chú thích</th></tr></thead><tbody><tr><td>1</td><td>ticket_id</td><td>ID phiếu ghi</td></tr><tr><td>2</td><td>ticket_no</td><td>Số phiếu ghi</td></tr><tr><td>3</td><td>customer_id</td><td>ID khách hàng, tương ứng với {{contactId}} khi cần truy xuất thông tin chi tiết của khách</td></tr><tr><td>4</td><td>cus_email</td><td>Email của khách</td></tr><tr><td>5</td><td>cus_name</td><td>Họ tên khách hàng</td></tr><tr><td>6</td><td>cus_phone</td><td>Số điện thoại của khách</td></tr><tr><td>7</td><td>meet_time</td><td>Thời điểm khết nối</td></tr><tr><td>8</td><td>waitTime</td><td>Thời gian chờ</td></tr><tr><td>9</td><td>answer_time</td><td>Thời gian trả lời</td></tr><tr><td>10</td><td>ring_time</td><td>Thời gian chờ rung chuông</td></tr><tr><td>11</td><td>chat_status</td><td>Trạng thái chat LBL_CHAT_STATUS_MISS: Nhỡ<br><br>LBL_CHAT_STATUS_MEET: Gặp</td></tr><tr><td>12</td><td>conversation_id</td><td>ID phiên chat</td></tr><tr><td>13</td><td>landing_page</td><td>Trang web chứa chat widget (Đối với live chate)</td></tr><tr><td>14</td><td>referrer</td><td>Trang web trước đó link tới landing page</td></tr><tr><td>15</td><td>is_trigger</td><td>Trạng thái kích hoạt trigger: LBL_CHAT_CUSTOMER_REQUEST_TRIGGER LBL_CHAT_CUSTOMER_REQUEST_NORMAL</td></tr><tr><td>16</td><td>facebook_page_id</td><td>Facebook page ID</td></tr><tr><td>17</td><td>start_time</td><td>Thời điểm bắt đầu</td></tr><tr><td>18</td><td>end_time</td><td>Thời điểm kết thúc</td></tr><tr><td>19</td><td>chat_duration</td><td>Thời lượng chat</td></tr><tr><td>20</td><td>agent_email</td><td>Email của chuyên viên</td></tr><tr><td>21</td><td>agent_name</td><td>Tên chuyên viên</td></tr><tr><td>22</td><td>group_name</td><td>Bộ phận của chuyên viên</td></tr><tr><td>23</td><td>service_id</td><td>ID Dịch vụ</td></tr></tbody></table>

## Lịch sử chat

## Danh sách lịch sử chat

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

#### Query Parameters

| Name               | Type               | Description                                                                                          |
| ------------------ | ------------------ | ---------------------------------------------------------------------------------------------------- |
| start\_time\_since | DateTime (ISO8601) | <p>Thời gian bắt đầu cuộc gọi từ <br>Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ)</p>                         |
| start\_time\_to    | DateTime (ISO8601) | <p>Thời gian bắt đầu cuộc gọi từ <br>Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ)</p>                         |
| assignees          | array\[int]        | Mảng ID nhân viên xử lý, xem thêm ở [Chuyên viên](/danh-muc/restful-api-cua-caresoft/chuyen-vien.md) |
| groups             | array\[int]        | Mảng ID bộ phận xem thêm ở [Bộ phận](/danh-muc/restful-api-cua-caresoft/bo-phan.md)                  |
| ticket\_id         | Int                | ID phiếu ghi                                                                                         |
| conversation\_type | Int                | <p>Loại chat có 3 tham số<br>0: Livechat<br>1:  Inbox Facebook<br>3: Zalo<br>Mặc định: 0</p>         |
| chat\_status       | Int                | <p>Tình trạng hội thoại: <br>0: Nhỡ<br>1: Gặp</p>                                                    |
| chat\_type         | Int                | <p>Loại hội thoại Có 2 giá trị<br>0: Hội thoại đến<br>1: Hội thoại chủ động ra</p>                   |
| end\_time\_to      | DateTime (ISO8601) | <p>Thời gian bắt đầu cuộc gọi từ <br>Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ)</p>                         |
| end\_time\_since   | DateTime (ISO8601) | <p>Thời gian bắt đầu cuộc gọi từ <br>Kiểu dữ liệu (yyyy-MM-ddTHH:mm:ssZ)</p>                         |
| customers          | array\[int]        | Mảng ID danh sách khách hàng                                                                         |
| services           | Int                | ID dịch vụ                                                                                           |
| page               | Int                | Trang                                                                                                |
| count              | Int                | Số bản ghi trên /trang (Luôn kèm theo param `page`) Tối đa 500                                       |

#### Headers

| Name                                   | Type   | Description                                     |
| -------------------------------------- | ------ | ----------------------------------------------- |
| \*\*<mark style="color:red;">\*</mark> | String | [Thông tin xác thực chung](/thong-tin-chung.md) |

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

```json

{
    "code": "OK",
    "numFound": 34,
    "chats": [
        {
            "ticket_id": 387229101,
            "ticket_no": 7415,
            "customer_id": 165644057,
            "group_name": "AGENT",
            "conversation_id": "20230422094830-AIVGTIVI-503996",
            "cus_email": "",
            "cus_name": "cstest",
            "cus_phone": "",
            "start_time": "2023-04-22 09:48:30",
            "end_time": "2023-04-22 09:49:10",
            "chat_duration": 39,
            "agent_email": "dungntt1110@gmail.com",
            "agent_name": "dungntt",
            "ring_time": "2023-04-22 09:48:30",
            "meet_time": "2023-04-22 09:48:39",
            "waitTime": "00:00:08",
            "answer_time": "00:00:31",
            "chat_status": "LBL_CHAT_STATUS_MEET",
            "landing_page": null,
            "referrer": null,
            "is_trigger": "LBL_CHAT_CUSTOMER_REQUEST_NORMAL",
            "facebook_page_id": null,
            "service_id": 60047005
        },
        ...
        ]
}

```

{% endtab %}

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

<table><thead><tr><th width="87">Stt</th><th width="153">Tên trường</th><th>Chú thích</th></tr></thead><tbody><tr><td>1</td><td>code</td><td>Trạng thái thành công: <br>ok: Thành công errors: Thất bại</td></tr><tr><td>2</td><td>numFound</td><td>Số bản ghi tìm thấy theo điều kiện lọc</td></tr><tr><td>3</td><td>chats []</td><td>Mảng dữ liệu danh sách lịch sử chat (xem phía dưới)</td></tr></tbody></table>

Chi tiết 1 đối tượng Chat trong mảng `chats`

<table><thead><tr><th width="77">STT</th><th width="163">Tên trường</th><th>Chú thích</th></tr></thead><tbody><tr><td>1</td><td>ticket_id</td><td>ID phiếu ghi</td></tr><tr><td>2</td><td>ticket_no</td><td>Số phiếu ghi</td></tr><tr><td>3</td><td>customer_id</td><td>ID khách hàng, tương ứng với {{contactId}} khi cần truy xuất  thông tin chi tiết của khách</td></tr><tr><td>4</td><td>cus_email</td><td>Email của khách</td></tr><tr><td>5</td><td>cus_name</td><td>Họ tên khách hàng</td></tr><tr><td>6</td><td>cus_phone</td><td>Số điện thoại của khách</td></tr><tr><td>7</td><td>meet_time</td><td>Thời điểm khết nối</td></tr><tr><td>8</td><td>waitTime</td><td>Thời gian chờ</td></tr><tr><td>9</td><td>answer_time</td><td>Thời gian trả lời</td></tr><tr><td>10</td><td>ring_time</td><td>Thời gian chờ rung chuông</td></tr><tr><td>11</td><td>chat_status</td><td><p>Trạng thái chat<br>LBL_CHAT_STATUS_MISS:  Nhỡ</p><p>LBL_CHAT_STATUS_MEET: Gặp</p></td></tr><tr><td>12</td><td>conversation_id</td><td>ID phiên chat</td></tr><tr><td>13</td><td>landing_page</td><td>Trang web chứa chat widget (Đối với live chate)</td></tr><tr><td>14</td><td>referrer</td><td>Trang web trước đó link tới landing page</td></tr><tr><td>15</td><td>is_trigger</td><td>Trạng thái kích hoạt trigger:<br>LBL_CHAT_CUSTOMER_REQUEST_TRIGGER LBL_CHAT_CUSTOMER_REQUEST_NORMAL</td></tr><tr><td>16</td><td>facebook_page_id</td><td>Facebook page ID</td></tr><tr><td>17</td><td>start_time</td><td>Thời điểm bắt đầu</td></tr><tr><td>18</td><td>end_time</td><td>Thời điểm kết thúc</td></tr><tr><td>19</td><td>chat_duration</td><td>Thời lượng chat</td></tr><tr><td>20</td><td>agent_email</td><td>Email của chuyên viên</td></tr><tr><td>21</td><td>agent_name</td><td>Tên chuyên viên</td></tr><tr><td>22</td><td>group_name</td><td>Bộ phận của chuyên viên</td></tr><tr><td>23</td><td>service_id</td><td>ID  Dịch vụ</td></tr></tbody></table>

Để lấy nội dung chat vui lòng truy xuất Chi tiết phiếu ghi đi kèm để lấy thông tin&#x20;
{% endtab %}
{% endtabs %}
{% endtab %}

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

{% endtab %}

{% tab title="400: Bad Request " %}

{% endtab %}

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

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.caresoft.vn/danh-muc/restful-api-cua-caresoft/chat.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.