回應物件資料

知識庫 Kb

欄位名稱	型態	說明	範例值
id	integer	KB 資料唯一識別碼	5
subject	string	文章標題	"LINE 圖文選單"
content	string	文章內容，支援 HTML 格式	"<h2>概述</h2><p>..."
like_count	integer	被按讚數量	1
dislike_count	integer	被倒讚數量	0
readed_count	integer	已讀次數（閱讀計數器）	10
is_public	boolean	是否公開文章	true
creater_id	integer	建立者使用者 ID	3
creater	object	建立者資訊，內含詳細使用者屬性	{...}
├─ id	integer	使用者 ID	3
├─ name	string	使用者姓名（全名）	"eason d"
sub_category_id	integer/null	子分類 ID	null
sub_category	object/null	子分類資訊	null
file_entities_count	integer	附件數量	0
file_entities	array	附件清單，每個元素包含檔案資訊	[]
category_id	integer	主分類 ID	-1
category	object/null	主分類資訊	null
kb_tags	array	KB 標籤資訊物件清單	[]
kb_tag_ids	array	KB 標籤 ID 清單	[]

地址 Address

PROPERTY	TYPE	DESCRIPTION
id	Number	地址 id
type	Number	地址類型 0: 住家 1: 郵寄 2: 帳單 3: 寄送 4: 現居 5: 其他
address	String	地址內容
profile_id	Number	客戶個資物件的 id
state	Object	縣市
state_id	Number	縣市的id
country	Object	國家
country_id	Number	國家的id
city	Object	區
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	客戶個資物件
sponsor	Object	業主
sponsor_id	Number	業主id
campaign_queues	Array of objects	此欄位請忽略，尚未具備正式功能
email_contacts	Array of objects	客戶電子信箱陣列
fbs	Array of objects	此欄位請忽略，尚未具備正式功能
lines	Array of objects	此欄位請忽略，尚未具備正式功能
cz_cols	Array of objects	客戶的動態欄位陣列
tags	Array of objects	標籤陣列
disturb_setting	Object	勿擾

客戶個資物件 Profile

PROPERTY	TYPE	DESCRIPTION
id	Number	客戶個資物件的 id，會被用來撈取住址，電話
phones	Array of object	電話陣列

電子信箱 Email Contact

PROPERTY	TYPE	DESCRIPTION
id	Number	電子郵件信箱 id
contact_id	Number	所屬 客戶 的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	動態欄位的類型 0: 數字 1: 字串 2: 布林值 3: 日期 4: 時間 5: 日期時間 6: 單選 7: 多選
category_id	Number	主分類的 id
category	Object	主分類
creater_id	Number	建立此動態欄位的員工id
creater	Object	建立此動態欄位的 員工

自訂欄位分類 CzColCategory

PROPERTY	TYPE	DESCRIPTION
id	Number	動態欄位分類 的 id
name	String	動態欄位分類名稱
type	Number	動態欄位分類類型 {0: 客戶動態關聯表單 1: 客戶動態關聯表格 2: 工單動態關聯表單 3: 工單動態關聯表格}
description	String	動態欄位分類描述
cols	Array of objects	動態欄位

客戶自訂表格 Contact Cz Relation

PROPERTY	TYPE	DESCRIPTION
id	Number	客戶動態關聯表格 id
relation_id	Number	動態欄位分類 的 id
relation_name	String	動態欄位分類 的名稱
information	Array of Objects	客戶動態關聯表格內容 的陣列

客戶自訂表格 Contact Cz RelationInformation

PROPERTY	TYPE	DESCRIPTION
id	Number	客戶動態關聯表格內容的 id
value	String	客戶動態關聯表格內容的值
col_id	Number	動態欄位 的 id
col_name	String	動態欄位 的名稱

客戶標籤 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	職稱
department_id	Number	部門 id
department	Object	部門
extension_id	Number	分機 id
extension	Object	分機
profile	Object	客戶個資
is_active	Boolean	是否啟用
role	String	權限
email	String	信箱地址
group_id	Number	員工群組 id
group	Object	員工群組
is_immortal	Boolean	不可被修改
cti_agent_account	String	cti 帳號名稱
cti_agent	Object	電話專員
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	員工
employee	Object	員工 id

電話專員 CtiAgent

PROPERTY	TYPE	DESCRIPTION
id	Number	id
account	String	帳號
employee	Object	員工
group_id	Number	員工群組 id
group	Object	員工群組

員工群組 Employee Group

PROPERTY	TYPE	DESCRIPTION
id	Number	員工的id
name	String	姓名
description	String	說明
supervisor_id	Number	督導的 id
supervisor	Object	督導，格式為員工
members	Array of object	群組成員，格式為員工的陣列

部門 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	狀態細項
contact	Object	客戶
contact_id	Number	客戶 id
sub_category	Object	子分類
sub_category_id	Number	子分類 id
creater	Object	建立此工單的員工
handler_id	Number	建立此工單的員工 id
handler	Object	負責此工單的員工
sponsor_id	Number	負責此工單的員工 id
sponsor	Object	此工單所屬的業主
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	建立此狀態細項的員工

主分類 Category

PROPERTY	TYPE	DESCRIPTION
id	Number	id
name	String	名稱
description	String	說明
children	Array of objects	子分類陣列

子分類 SubCategory

PROPERTY	TYPE	DESCRIPTION
id	Number	id
name	String	名稱
description	String	說明
category	Object	主分類
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	最後更新時間