# 回應物件資料 ## 知識庫 Kb
欄位名稱型態說明範例值
idintegerKB 資料唯一識別碼5
subjectstring文章標題"LINE 圖文選單"
contentstring文章內容，支援 HTML 格式"<h2>概述</h2><p>..."
like_countinteger被按讚數量1
dislike_countinteger被倒讚數量0
readed_countinteger已讀次數（閱讀計數器）10
is_publicboolean是否公開文章true
creater_idinteger建立者使用者 ID3
createrobject建立者資訊，內含詳細使用者屬性{...}
├─ idinteger使用者 ID3
├─ namestring使用者姓名（全名）"eason d"
sub_category_idinteger/null子分類 IDnull
sub_categoryobject/null子分類資訊null
file_entities_countinteger附件數量0
file_entitiesarray附件清單，每個元素包含檔案資訊[]
category_idinteger主分類 ID-1
categoryobject/null主分類資訊null
kb_tagsarrayKB 標籤資訊物件清單[]
kb_tag_idsarrayKB 標籤 ID 清單[]
## 地址 Address | PROPERTY | TYPE | DESCRIPTION | | --------------- | ------ | -------------------------------------------------------------------------------------------------------- | | **id** | Number | 地址 id | | **type** | Number |

地址類型

| | **address** | String | 地址內容 | | **profile\_id** | Number | 客戶個資物件的 id | | **state** | Object | [縣市](#ou-city) | | **state\_id** | Number | 縣市的id | | **country** | Object | [國家](#guo-jia-country) | | **country\_id** | Number | 國家的id | | **city** | Object | [區](#ou-city) | | **city\_id** | Number | 區的id | | **description** | String | 地址描述說明 | ## 國家 Country | PROPERTY | TYPE | DESCRIPTION | | -------- | ------ | ----------- | | **id** | Number | id | | **name** | String | 名稱 | ## 城市 State | PROPERTY | TYPE | DESCRIPTION | | -------- | ------ | ----------- | | **id** | Number | id | | **name** | String | 名稱 | ## 區 City | PROPERTY | TYPE | DESCRIPTION | | -------- | ------ | ----------- | | **id** | Number | id | | **name** | String | 名稱 | ## 客戶 Contact | PROPERTY | TYPE | DESCRIPTION | | -------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | **id** | Number | 客戶的 ID | | **name** | String | 全名 | | **first\_name** | String | 姓氏 | | **last\_namt** | String | 名字 | | **membership\_no** | String | 會員編號 | | **identity\_no** | String | 身分證字號 | | **gender** | Number | 性別 | | **birth\_at** | Datetime | 生日 | | **profile\_id** | Number | 客戶個資物件的 ID | | **profile** | Object | [客戶個資物件](#ke-hu-ge-zi-wu-jian-profile) | | **sponsor** | Object | [業主](#ye-zhu-sponsor) | | **sponsor\_id** | Number | 業主 ID | | **email\_contacts** | Array of objects | [客戶電子信箱陣列](#dian-zi-xin-xiang-emailcontact) | | **cz\_cols** | Array of objects | [客戶的動態欄位陣列](#dong-tai-lan-wei-czcol) | | **tags** | Array of objects | [標籤陣列](#ke-hu-biao-qian-contact-tag) | | **disturb\_setting** | Object | [勿擾](#ke-hu-wu-rao-she-ding-disturb-setting) | | **\*\_contacts** | Array of objects |

代表該客戶在各訊息管道中所對應的社群媒體資料。例如：
fb\_contacts 表示 Facebook 的社群媒體資料；
line\_contacts 則表示 LINE 官方帳號的相關資料。

| ## 客戶個資物件 Profile | PROPERTY | TYPE | DESCRIPTION | | ---------- | --------------- | ------------------------------ | | **id** | Number | 客戶個資物件的 id，會被用來撈取住址，電話 | | **phones** | Array of object | [電話陣列](#dian-hua-phone-number) | ## 電子信箱 Email Contact | PROPERTY | TYPE | DESCRIPTION | | --------------- | ------ | --------------------------- | | **id** | Number | 電子郵件信箱 id | | **contact\_id** | Number | 所屬 [客戶](#ke-hu-contact) 的id | | **address** | String | 電子郵件位址 | | **draft** | String | 草稿 | | **name** | String | 自定義的電子信箱別名 | | **description** | String | 電子信箱描述 | ## 自訂欄位 CzCol | PROPERTY | TYPE | DESCRIPTION | | --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | **id** | Number | 動態欄位的 id | | **name** | String | 動態欄位的名稱 | | **description** | String | 動態欄位的描述說明 | | **is\_allowed\_null** | Boolean | 是否允許空值 | | **default** | Object | 此動態欄位的預設值 | | **type** | Number |

動態欄位的類型

| | **category\_id** | Number | 主分類的 id | | **category** | Object | [主分類](#zhu-fen-lei-category) | | **creater\_id** | Number | 建立此動態欄位的員工id | | **creater** | Object | 建立此動態欄位的 [員工](#yuan-gong-employee) | ## 自訂欄位分類 CzColCategory | PROPERTY | TYPE | DESCRIPTION | | --------------- | ---------------- | ---------------------------------------------------------- | | **id** | Number | 動態欄位分類 的 id | | **name** | String | 動態欄位分類名稱 | | **type** | Number | 動態欄位分類類型 {0: 客戶動態關聯表單 1: 客戶動態關聯表格 2: 工單動態關聯表單 3: 工單動態關聯表格} | | **description** | String | 動態欄位分類描述 | | **cols** | Array of objects | [動態欄位](#dong-tai-lan-wei-czcol) | ## 客戶自訂表格 Contact Cz Relation | PROPERTY | TYPE | DESCRIPTION | | ------------------ | ---------------- | ----------------------------------------------------------------------------------------- | | **id** | Number | 客戶動態關聯表格 id | | **relation\_id** | Number | [動態欄位分類](#dong-tai-lan-wei-fen-lei-czcolcategory) 的 id | | **relation\_name** | String | [動態欄位分類](#dong-tai-lan-wei-fen-lei-czcolcategory) 的名稱 | | **information** | Array of Objects | [客戶動態關聯表格內容](#ke-hu-dong-tai-guan-lian-biao-ge-nei-rong-contactczrelationinformation) 的陣列 | ## 客戶自訂表格 Contact Cz RelationInformation | PROPERTY | TYPE | DESCRIPTION | | ------------- | ------ | ------------------------------------ | | **id** | Number | 客戶動態關聯表格內容的 id | | **value** | String | 客戶動態關聯表格內容的值 | | **col\_id** | Number | [動態欄位 ](#dong-tai-lan-wei-czcol)的 id | | **col\_name** | String | [動態欄位 ](#dong-tai-lan-wei-czcol)的名稱 | ## 客戶標籤 Contact Tag | PROPERTY | TYPE | DESCRIPTION | | --------------- | ------ | ----------- | | **id** | Number | id | | **name** | String | 名稱 | | **description** | String | 說明 | ## 客戶勿擾設定 Disturb Setting | PROPERTY | TYPE | DESCRIPTION | | -------------------------- | --------------- | -------------------- | | **id** | Number | id | | **type** | Array of string | 勿擾設定的類型，包含電話，Fb，Line | | **no\_disturb\_start\_at** | Time | 勿擾設定起始時間 | | **no\_disturb\_end\_at** | Time | 勿擾設定結束時間 | | **reason** | String | 勿擾理由 | ## 員工 Employee | PROPERTY | TYPE | DESCRIPTION | | ----------------------- | -------- | ---------------------------------------- | | **id** | Number | 員工的id | | **name** | String | 姓名 | | **first\_name** | String | 姓氏 | | **last\_name** | String | 名字 | | **employee\_no** | String | 員工編號 | | **photo\_url** | String | 照片路徑 | | **identity\_no** | String | 身分證字號 | | **job\_title\_id** | Number | 職稱 id | | **job\_title** | Object | [職稱](#zhi-chen-job-title) | | **department\_id** | Number | 部門 id | | **department** | Object | [部門](#bu-men-deaprtment) | | **extension\_id** | Number | 分機 id | | **extension** | Object | [分機](#fen-ji-extension) | | **profile** | Object | [客戶個資](#ke-hu-ge-zi-wu-jian-profile) | | **is\_active** | Boolean | 是否啟用 | | **role** | String | 權限 | | **email** | String | 信箱地址 | | **group\_id** | Number | 員工群組 id | | **group** | Object | [員工群組](#yuan-gong-qun-zu-employee-group) | | **is\_immortal** | Boolean | 不可被修改 | | **cti\_agent\_account** | String | cti 帳號名稱 | | **cti\_agent** | Object | [電話專員](#dian-hua-zhuan-yuan-ctiagent) | | **created\_at** | Datetime | 初始建立時間 | | **updated\_at** | Datetime | 最後更新時間 | ## 職稱 Job Title | PROPERTY | TYPE | DESCRIPTION | | --------------- | ------ | ----------- | | **id** | Number | id | | **abbrev** | String | 簡稱 | | **name** | String | 名稱 | | **description** | String | 說明 | ## 分機 Extension | PROPERTY | TYPE | DESCRIPTION | | ---------------------- | ------ | ------------------------------------- | | **id** | Number | id | | **type** | Number | 類型 <0: 分機, 1: ACD, 2: IVR, 3: WEBRTC> | | **extension** | String | 分機號碼 | | **description** | String | 說明 | | **media\_cluster\_id** | Number | **待補** | | **media\_cluster** | Object | **待補** | | **employee\_id** | Number | [員工](#yuan-gong-employee) | | **employee** | Object | 員工 id | ## 電話專員 CtiAgent | PROPERTY | TYPE | DESCRIPTION | | ------------- | ------ | ---------------------------------------- | | **id** | Number | id | | **account** | String | 帳號 | | **employee** | Object | [員工](#yuan-gong-employee) | | **group\_id** | Number | 員工群組 id | | **group** | Object | [員工群組](#yuan-gong-qun-zu-employee-group) | ## 員工群組 Employee Group | PROPERTY | TYPE | DESCRIPTION | | ------------------ | --------------- | ------------------------------------ | | **id** | Number | 員工的id | | **name** | String | 姓名 | | **description** | String | 說明 | | **supervisor\_id** | Number | 督導的 id | | **supervisor** | Object | 督導，格式為[員工](#yuan-gong-employee) | | **members** | Array of object | 群組成員，格式為[員工](#yuan-gong-employee)的陣列 | ## 部門 Deaprtment | PROPERTY | TYPE | DESCRIPTION | | --------------- | ------ | ----------- | | **id** | Number | id | | **name** | String | 名稱 | | **abbrev** | String | 簡稱 | | **number** | Number | 代號 | | **description** | String | 說明 | ## 電話 Phone Number | PROPERTY | TYPE | DESCRIPTION | | --------------- | ------ | --------------------------------- | | **id** | Number | id | | **type** | Number | 0: 住家, 1: 公司, 2: 手機, 3: 傳真, 4: 其他 | | **extension** | String | 分機 | | **number** | String | 號碼 | | **description** | String | 說明 | ## 工單 Ticket | PROPERTY | TYPE | DESCRIPTION | | ------------------------- | -------- | --------------------------------------------------------------------- | | **id** | Number | id | | **subject** | String | 標題 | | **content** | String | 內容 | | **due\_at** | Datetime | 截止時間 | | **status** | Number | 工單狀態 < 0: 待處理 1: 處理中 2: 已解決 3: 已關閉 > | | **status\_memo** | String | 狀態備註 | | **priority** | Number | 優先順序 | | **termination\_code\_id** | Number | 狀態細項 id | | **termination\_code** | Object | [狀態細項](#gong-chan-zhuang-tai-xi-xiang-dai-ma-ticket-termination-code) | | **contact** | Object | [客戶](#ke-hu-contact) | | **contact\_id** | Number | 客戶 id | | **sub\_category** | Object | [子分類](#zi-fen-lei-subcategory) | | **sub\_category\_id** | Number | 子分類 id | | **creater** | Object | [建立此工單的員工](#yuan-gong-employee) | | **handler\_id** | Number | 建立此工單的員工 id | | **handler** | Object | [負責此工單的員工](#yuan-gong-employee) | | **sponsor\_id** | Number | 負責此工單的員工 id | | **sponsor** | Object | [此工單所屬的業主](#ye-zhu-sponsor) | | **created\_at** | Datetime | 初始建立時間 | | **updated\_at** | Datetime | 最後更新時間 | ## 工單狀態細項代碼 Ticket Termination Code | PROPERTY | TYPE | DESCRIPTION | | --------------- | ------ | -------------------------------------- | | **id** | Number | id | | **name** | String | 名稱 | | **description** | String | 說明 | | **status** | Number | 對應工單狀態 < 0: 待處理 1: 處理中 2: 已解決 3: 已關閉 > | | **creater\_id** | Number | 建立此狀態細項的員工 id | | **creater** | Object | [建立此狀態細項的員工](#yuan-gong-employee) | ## 主分類 Category | PROPERTY | TYPE | DESCRIPTION | | --------------- | ---------------- | -------------------------------- | | **id** | Number | id | | **name** | String | 名稱 | | **description** | String | 說明 | | **children** | Array of objects | [子分類陣列](#zi-fen-lei-subcategory) | ## 子分類 SubCategory | PROPERTY | TYPE | DESCRIPTION | | ---------------- | ------ | ---------------------------- | | **id** | Number | id | | **name** | String | 名稱 | | **description** | String | 說明 | | **category** | Object | [主分類](#zhu-fen-lei-category) | | **category\_id** | Number | 主分類 id | ## 業主 Sponsor | PROPERTY | TYPE | DESCRIPTION | | ---------------- | ------- | ----------- | | **id** | Number | id | | **name** | String | 名稱 | | **description** | String | 說明 | | **is\_immortal** | Boolean | 是否不可更改 | ## 服務紀錄 Interact-collection | PROPERTY | TYPE | DESCRIPTION | | ------------------------- | -------- | ------------------------------------------- | | id | Number | 服務紀錄系統 ID | | is\_acw\_completed | Boolean | 是否已完成服務，0：未完成、1：完成 | | first\_enter\_queue\_time | String | 客戶進線開始分派的時間。 | | first\_start\_service\_at | Datetime | 專員接應與客戶開始服務時間。 | | last\_finished\_at | Datetime | 與客戶結束交談時間，但並不表示服務完成。 | | acw\_at | Datetime | 專員結束完成此筆服務時間。 | | handler\_id | Number | 負責專員系統 ID | | handler | Object | 負責專員資料 | | contact\_id | Number | 客戶 ID | | contact | Object | 客戶資料 | | memo | String | 服務紀錄備註 | | bound\_type | Number |

服務的方向。

0 表示專員主動拜訪；1 客戶表示主動聯繫。

| | logs | Array | 此服務紀錄所有相關連的交談紀錄，列表方式不包含完整資訊，請由單筆讀取獲取完整資訊。 | | sponsor\_id | Number | 業主 ID | | sponsor | Object | 業主資料 | | reasons | Array | 服務原因資料 | | reason\_ids | Arrary | 服務原因所以 ID | | result\_id | Number | 服務結果 ID | | result | Object | 服務結果資料 | | media\_cluster\_id | Number | 管道整合 ID | | media\_cluster | Object | 管道整合 | | transfer\_logs | Array | 此服務紀錄轉派過的紀錄 | | created\_at | Datetime | 服務紀錄系統建立時間 | ## 自訂表格匯入範本 Relation Import Recipe | Property | Type | Description | | ------------------------ | ------ | --------------------------------------- | | id | Number | **自訂表格批次匯入範本**的 id | | name | String | **自訂表格批次匯入範本**的名稱 | | importable\_type | String | **自訂表格批次匯入範本**的類型，目前僅支援 **App\Contact** | | description | String | **自訂表格批次匯入範本**的詳細描述 | | headers | Array | 匯入檔案的欄位定義 | | cz\_col\_category\_id | Number | 動態欄位分類 的 id | | cz\_col\_category | Object | 動態欄位分類 | | unique\_columns | Array | 定義的**客戶**唯一值判斷欄位 | | relation\_unique\_column | Array | 定義的**自訂表格**唯一值判斷欄位 | | creater\_id | Number | 建立人員 的 id | | creater | Object | 建立人員 | | tasks\_count | Number | 根據此**自訂表格批次匯入範本**所建立的**自訂表格批次匯入任務**數量 | ## 自訂表格匯入排程 Relation Import Task > 僅說明重要欄位 | Property | Type | Description | | --------------------- | -------- | ----------------------------------------- | | id | Number | **自訂表格匯入任務**的 id | | size | Number | 檔案大小 (byte) | | total\_amount | Number | 總行數 | | description | String | 任務描述 | | status | Number | 狀態 (0: 建立, 1: 匯入中, 2: 完成, 10: 錯誤, 11: 暫停) | | current\_sheet\_index | Number | 目前匯入檔案執行到第幾個 sheet | | current\_row\_index | Number | 目前匯入到第幾行 | | executed\_start\_at | Datetime | 開始執行時間 | | executed\_end\_at | Datetime | 結束執行時間 | | creater\_id | Number | 建立人員 的 id | | created\_at | Datetime | 初始建立時間 | | updated\_at | Datetime | 最後更新時間 | ## 客戶匯入範本 Entity Import Recipe | Property | Type | Description | | --------------------- | ------ | ----------------------------------- | | id | Number | **批次匯入範本**的 id | | name | String | **批次匯入範本**的名稱 | | importable\_type | String | **批次匯入範本**的類型，目前僅支援 **App\Contact** | | description | String | **批次匯入範本**的詳細描述 | | headers | Array | 匯入檔案的欄位定義 | | cz\_col\_category\_id | Number | 動態欄位分類 的 id | | cz\_col\_category | Object | 動態欄位分類 | | unique\_columns | Array | 定義的**客戶**唯一值判斷欄位 | | creater\_id | Number | 建立人員 的 id | | creater | Object | 建立人員 | | tasks\_count | Number | 根據此**批次匯入範本**所建立的**批次匯入任務**數量 | ## 客戶匯入排程 Entity Import Task > 僅說明重要欄位 | Property | Type | Description | | --------------------- | -------- | ----------------------------------------- | | id | Number | **匯入任務**的 id | | size | Number | 檔案大小 (byte) | | total\_amount | Number | 總行數 | | description | String | 任務描述 | | status | Number | 狀態 (0: 建立, 1: 匯入中, 2: 完成, 10: 錯誤, 11: 暫停) | | current\_sheet\_index | Number | 目前匯入檔案執行到第幾個 sheet | | current\_row\_index | Number | 目前匯入到第幾行 | | executed\_start\_at | Datetime | 開始執行時間 | | executed\_end\_at | Datetime | 結束執行時間 | | creater\_id | Number | 建立人員 的 id | | created\_at | Datetime | 初始建立時間 | | updated\_at | Datetime | 最後更新時間 |