# Dịch vụ

Danh sách các Dịch vụ tích hợp trên CareSoft. Các serviceId trong API  dưới đây có thể dùng làm mapping nguồn phiếu ghi hoặc tạo mới phiếu ghi qua API để phân phối cho nhóm chuyên viên được gán. 

### **Các loại dịch vụ trên API** 

| TypeId | Loại           |
| ------ | -------------- |
| 1      | Gọi vào        |
| 2      | Live chat      |
| 3      | Email          |
| 4      | Facebook       |
| 6      | Miss chat      |
| 7      | Voicemail      |
| 8      | Inbox Facebook |
| 9      | Api            |
| 10     | Zalo           |
| 11     | Voice out      |
| 12     | Ivr            |
| 13     | Ticket form    |

## Danh sách các dịch vụ trên Caresoft

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

#### Query Parameters

| Name        | Type | Description                                              |
| ----------- | ---- | -------------------------------------------------------- |
| type        | Int  | Lọc theo loại dịch vụ dựa trên Type ID ở bảng mô tả trên |
| service\_id | Int  | Id dịch vụ                                               |

#### 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ành công" %}
{% tabs %}
{% tab title="Kết quả điển hình" %}

```json

{
    "code": "ok",
    "services": [
     {
            "service_id": 1005815,
            "service_name": "99-991-Gọi vào",
            "service_type": "Gọi vào",
            "type": 1,
            "detail": {
                "line": "991_1111",
                "number": "",
                "description": "99-991-Gọi vào (1111)",
                "created_at": "2021-12-03 13:09:50",
                "updated_at": "2021-12-03 13:11:31"
            }
        },
        {
            "service_id": 1005817,
            "service_name": "99-992-Gọi vào",
            "service_type": "Gọi vào",
            "type": 1,
            "detail": {
                "line": "992_1111",
                "number": "",
                "description": "99-992-Gọi vào (1111)",
                "created_at": "2021-12-03 13:09:50",
                "updated_at": "2021-12-03 13:11:31"
            }
        },

...
```

{% endtab %}

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

<table><thead><tr><th width="102">STT</th><th width="163">Trường dữ liệu</th><th>Chú thích</th></tr></thead><tbody><tr><td>1</td><td>service_name</td><td>Tên dịch vụ</td></tr><tr><td>2</td><td>service_id</td><td>Id dịch vụ</td></tr><tr><td>3</td><td>service_type</td><td>Loại dịch vụ</td></tr><tr><td>4</td><td>type</td><td>ID loại dịch vụ</td></tr><tr><td>5</td><td>detail</td><td>Object chi tiết theo từng dịch vụ (Xem bảng dưới) </td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endtab %}

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

{% endtab %}
{% endtabs %}

## Mẫu các dữ liệu chi tiết của từng dịch vụ

### Gọi vào và IVR ( Interactive Voice Response)&#x20;

ID loại dịch vụ: 1 và 12&#x20;

{% tabs %}
{% tab title="Dữ liệu mẫu" %}

```json
 {
        "service_id": 1005815,
        "service_name": "99-991-Gọi vào",
        "service_type": "Gọi vào",
        "type": 1,
        "detail": {
              "line": "991_1111",
              "number": "19001800",
              "description": "99-991-Gọi vào (1111)",
              "created_at": "2021-12-03 13:09:50",
              "updated_at": "2021-12-03 13:11:31",
              "status": 1
         }
}

```

{% endtab %}

{% tab title="Mô tả cấu trúc" %}
Object Detail

<table><thead><tr><th width="247">Trường dữ liệu</th><th>Ghi chú</th></tr></thead><tbody><tr><td>line</td><td>Nhánh hotline</td></tr><tr><td>number</td><td>Đầu số gốc</td></tr><tr><td>description</td><td>Mô tả</td></tr><tr><td>created_at</td><td>Ngày tạo</td></tr><tr><td>updated_at</td><td>Ngày cập nhật</td></tr><tr><td>status</td><td>Trạng thái dịch vụ: 0: Ngưng sử dụng, 1: Đang sử dụng</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

### Live Chat

ID loại dịch vụ: 2

{% tabs %}
{% tab title="Dữ liệu mẫu" %}

```json
 {
            "service_id": 6006242,
            "service_name": "test",
            "service_type": "Live chat",
            "type": 2,
            "detail": {
                "domain": "vi2_ticketsharing",
                "status": 1,
                "description": "Box chat trên site bán hàng"
            }
  }
```

{% endtab %}

{% tab title="Mô tả cấu trúc" %}
Object Detail

<table><thead><tr><th width="219">Trường dữ liệu</th><th>Ghi chú</th></tr></thead><tbody><tr><td>domain</td><td>Domain chat của dịch vụ</td></tr><tr><td>status</td><td>Trạng thái sử dụng: <br>0: Tạm ngừng<br>1: Đang sử dụng</td></tr><tr><td>description</td><td>Tên dịch vụ chat</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

### Email

ID loại dịch vụ: 3

{% tabs %}
{% tab title="Dữ liệu mẫu" %}

```json
 {
            "service_id": 9004932,
            "service_name": "Test cập nhật Email",
            "service_type": "Email",
            "type": 3,
            "detail": {
                "in_email_address": "hungnx03009@gmail.com",
                "out_email_address": "hungnx03009@gmail.com",
                "status": 0,
                "description": "Test cập nhật Email",
                "last_update": "2022-08-03 10:28:44"
            }

```

{% endtab %}

{% tab title="Mô tả cấu trúc" %}

<table><thead><tr><th width="245">Trường</th><th>Ghi chú</th></tr></thead><tbody><tr><td>in_email_address</td><td>Email nhận</td></tr><tr><td>out_email_address</td><td>Email gửi ra</td></tr><tr><td>status</td><td>Trạng thái: 0: Đang tạm ngưng, 1: Kích hoạt</td></tr><tr><td>description</td><td>Ghi chú</td></tr><tr><td>last_update</td><td>Lần cập nhật cuối</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

### Facebook/Instagram

ID loại dịch vụ: 4

{% tabs %}
{% tab title="Dữ liệu mẫu" %}

```json

  {
            "service_id": 9105775,
            "service_name": "Camera Man",
            "service_type": "Facebook",
            "type": 4,
            "detail": {
                "page_id": "546869858829726",
                "active": "1",
                "description": "Camera Man",
                "created_at": "2021-11-02 10:55:38",
                "platform": "MESSENGER"
            }
        }

```

{% endtab %}

{% tab title="Mô tả cấu trúc" %}

| Tên trường    | Ghi chú                                                                                                   |
| ------------- | --------------------------------------------------------------------------------------------------------- |
| page\_id      | ID trang                                                                                                  |
| active        | <p>Trạng thái: <br>0: ngưng kích hoạt<br>1: Đang kích hoạt</p>                                            |
| description   | Ghi chú                                                                                                   |
| created\_at   | Ngày tạo                                                                                                  |
| platform      | <p><strong>Nền tảng</strong><br>MESSENGER: Trang facebook hoặc Inbox Facebook<br>INSTAGRAM: Instagram</p> |
| {% endtab %}  |                                                                                                           |
| {% endtabs %} |                                                                                                           |

### Miss chat Zalo, Facebook, Live chat&#x20;

ID loại dịch vụ: 6

{% tabs %}
{% tab title="Dữ liệu mẫu" %}

```json

  {
    "service_id": 9405942,
    "service_name": "How to swiming",
    "service_type": "Miss chat",
    "type": 6,
    "detail": {
         "page_id": "714542025321103",
         "active": "1",
         "description": "How to swiming",
         "created_at": "2021-11-24 22:35:07",
         "platform": "MESSENGER",
          "chat_type": "FACEBOOK"
    }
  },
  {
    "service_id": 9406241,
    "service_name": "Caresoft contact center",
    "service_type": "Miss chat",
    "type": 6,
    "detail": {
      "oa_id": "285586298586590917",
      "active": 0,
      "description": "Giải pháp phần mềm quản lý tương tác, bán hàng và dịch vụ khách hàng đa kênh. Nâng cao chất lượng dịch vụ và tỉ lệ chuyển đổi Hotline, Facebook, Zalo, Web, Apps, Email Sms",
      "name": "Caresoft contact center",
      "chat_type": "ZALO"
    }
  },
  {
    "service_id": 9406243,
    "service_name": "test",
    "service_type": "Miss chat",
    "type": 6,
    "detail": {
      "domain": "vi2_ticketsharing",
      "status": 1,
      "description": "test",
      "chat_type": "CHAT"
    }
  }

```

{% endtab %}

{% tab title="Mô tả cấu trúc" %}
Loại dịch vụ Miss chat gồm 3 loại Miss chat khác nhau. Có 1 key phân biệt trong object Detail là "chat\_type"

**chat\_type** gồm các giá trị

* CHAT: Live chat
* FACEBOOK:   Messenger và Instagram
* ZALO: Zalo

**Đối với Live Chat (chat\_type: CHAT)**

| Trường      | Ghi chú                             |
| ----------- | ----------------------------------- |
| domain      | domain chat cấu hình trên giao diện |
| status      | Trạng thái                          |
| chat\_type  | Kiểu Miss, Giá trị: CHAT            |
| description | Ghi chú                             |

**Đối với Messenger và Instagram  (chat\_type: FACEBOOK)**

| Trường      | Ghi chú                                                   |
| ----------- | --------------------------------------------------------- |
| page\_id    | Page ID                                                   |
| active      | Trạng thái kích hoạt: 0: Mất kích hoạt, 1: Đang hoạt động |
| description | Ghi chú                                                   |
| created\_at | Ngày tạo                                                  |
| platform    | <p>Nền tảng<br>MESSENGER hoặc INSTAGRAM</p>               |
| chat\_type  | FACEBOOK                                                  |

**Đối với ZALO  (chat\_type:ZALO)**

| Trường        | Ghi chú                                                   |
| ------------- | --------------------------------------------------------- |
| oa\_id        | OA ID                                                     |
| active        | Trạng thái kích hoạt: 0: Mất kích hoạt, 1: Đang hoạt động |
| description   | Giới thiệu của trang OA ZALO                              |
| name          | Tên OA                                                    |
| chat\_type    | ZALO                                                      |
| {% endtab %}  |                                                           |
| {% endtabs %} |                                                           |

### Inbox facebook/Instagram

ID loại dịch vụ: 8

{% tabs %}
{% tab title="Dữ liệu mẫu" %}

```json

  {
    "service_id": 6106245,
    "service_name": "CSG Developer (Instagram)",
    "service_type": "Inbox Facebook",
    "type": 8,
    "detail": {
      "page_id": "17841456598879972",
      "active": "1",
      "description": "CSG Developer",
      "created_at": "2022-11-11 17:22:28",
      "platform": "INSTAGRAM"
    }
  },
  {
    "service_id": 6106249,
    "service_name": "Hoa Sơn Gaming",
    "service_type": "Inbox Facebook",
    "type": 8,
    "detail": {
      "page_id": "113006833398415",
      "active": "1",
      "description": "Hoa Sơn Gaming",
      "created_at": "2022-12-07 10:27:23",
      "platform": "MESSENGER"
    }
  }

```

{% endtab %}

{% tab title="Mô tả cấu trúc" %}

| Trường        | Ghi chú                                                   |
| ------------- | --------------------------------------------------------- |
| page\_id      | Page ID                                                   |
| active        | Trạng thái kích hoạt: 0: Mất kích hoạt, 1: Đang hoạt động |
| description   | Tên trang                                                 |
| created\_at   | Ngày tạo                                                  |
| platform      | <p>Nền tảng<br>MESSENGER hoặc INSTAGRAM</p>               |
| {% endtab %}  |                                                           |
| {% endtabs %} |                                                           |

### Zalo

ID loại dịch vụ: 10

{% tabs %}
{% tab title="Dữ liệu mẫu" %}

```json
{
  "service_id": 6205009,
  "service_name": "Dota2",
  "service_type": "Zalo",
  "type": 10,
  "detail": {
    "oa_id": "1881674073797784908",
    "active": 1,
    "description": "Dota2 VN community Share Funny moment",
    "name": "Dota2"
  }
}
```

{% endtab %}

{% tab title="Mô tả cấu truc" %}

| Trường dữ liệu | Ghi chú                                                   |
| -------------- | --------------------------------------------------------- |
| oa\_id         | OA ID                                                     |
| active         | Trạng thái kích hoạt: 0: Mất kích hoạt, 1: Đang hoạt động |
| description    | Giới thiệu của trang OA ZALO                              |
| name           | Tên OA                                                    |
| {% endtab %}   |                                                           |
| {% endtabs %}  |                                                           |

{% hint style="info" %}
Lưu ý. Api gửi SMS  không sử dụng serviceId trong danh sách này để gửi.
{% endhint %}