Dịch vụ

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

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

GET {{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
***	String	Thông tin xác thực chung

200: OK Thành công

Kết quả điển hình

{
    "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"
            }
        },

...

Mô tả kết quả

STT	Trường dữ liệu	Chú thích
1	service_name	Tên dịch vụ
2	service_id	Id dịch vụ
3	service_type	Loại dịch vụ
4	type	ID loại dịch vụ
5	detail	Object chi tiết theo từng dịch vụ (Xem bảng dưới)

401: Unauthorized

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)

ID loại dịch vụ: 1 và 12

Dữ liệu mẫu

 {
        "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
         }
}

Mô tả cấu trúc

Object Detail

Trường dữ liệu	Ghi chú
line	Nhánh hotline
number	Đầu số gốc
description	Mô tả
created_at	Ngày tạo
updated_at	Ngày cập nhật
status	Trạng thái dịch vụ: 0: Ngưng sử dụng, 1: Đang sử dụng

Live Chat

ID loại dịch vụ: 2

Dữ liệu mẫu

 {
            "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"
            }
  }

Mô tả cấu trúc

Object Detail

Trường dữ liệu	Ghi chú
domain	Domain chat của dịch vụ
status	Trạng thái sử dụng: 0: Tạm ngừng 1: Đang sử dụng
description	Tên dịch vụ chat

Email

ID loại dịch vụ: 3

Dữ liệu mẫu

 {
            "service_id": 9004932,
            "service_name": "Test cập nhật Email",
            "service_type": "Email",
            "type": 3,
            "detail": {
                "in_email_address": "[e-mail]",
                "out_email_address": "[e-mail]",
                "status": 0,
                "description": "Test cập nhật Email",
                "last_update": "2022-08-03 10:28:44"
            }

Mô tả cấu trúc

Trường	Ghi chú
in_email_address	Email nhận
out_email_address	Email gửi ra
status	Trạng thái: 0: Đang tạm ngưng, 1: Kích hoạt
description	Ghi chú
last_update	Lần cập nhật cuối

Facebook/Instagram

ID loại dịch vụ: 4

Dữ liệu mẫu

  {
            "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"
            }
        }

Mô tả cấu trúc

Tên trường	Ghi chú
page_id	ID trang
active	Trạng thái: 0: ngưng kích hoạt 1: Đang kích hoạt
description	Ghi chú
created_at	Ngày tạo
platform	Nền tảng MESSENGER: Trang facebook hoặc Inbox Facebook INSTAGRAM: Instagram

Miss chat Zalo, Facebook, Live chat

ID loại dịch vụ: 6

Dữ liệu mẫu

  {
    "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"
    }
  }

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	Nền tảng MESSENGER hoặc INSTAGRAM
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

Inbox facebook/Instagram

ID loại dịch vụ: 8

Dữ liệu mẫu

  {
    "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"
    }
  }

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	Nền tảng MESSENGER hoặc INSTAGRAM

Zalo

ID loại dịch vụ: 10

Dữ liệu mẫu

{
  "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"
  }
}

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

Lưu ý. Api gửi SMS không sử dụng serviceId trong danh sách này để gửi.