Response object data

Knowledge Base Kb

Field Name	Type	Description	Example Value
id	integer	KB data unique identifier	5
subject	string	Article Title	"LINE Rich Menu"
content	string	Article content, supports HTML format	"<h2>Overview</h2><p>..."
like_count	integer	Number of likes	1
dislike_count	integer	Number of dislikes	0
readed_count	integer	Read count (reading counter)	10
is_public	boolean	Whether the article is public	true
creater_id	integer	Creator user ID	3
creater	object	Creator information, contains detailed user attributes	{...}
├─ id	integer	User ID	3
├─ name	string	User full name	"eason d"
sub_category_id	integer/null	Subcategory ID	null
sub_category	object/null	Subcategory information	null
file_entities_count	integer	Number of attachments	0
file_entities	array	Attachment list, each element contains file information	[]
category_id	integer	Main category ID	-1
category	object/null	Main category information	null
kb_tags	array	KB tag information object list	[]
kb_tag_ids	array	KB tag ID list	[]

Address

PROPERTY	TYPE	DESCRIPTION
id	Number	Address id
type	Number	Address type 0: Home 1: Mailing 2: Billing 3: Shipping 4: Current residence 5: Other
address	String	Address content
profile_id	Number	ID of the customer's profile object
state	Object	County/City
state_id	Number	ID of the county/city
country	Object	Country
country_id	Number	ID of the country
city	Object	District
city_id	Number	ID of the district
description	String	Address description

Country

PROPERTY	TYPE	DESCRIPTION
id	Number	id
name	String	Name

State

PROPERTY	TYPE	DESCRIPTION
id	Number	id
name	String	Name

City

PROPERTY	TYPE	DESCRIPTION
id	Number	id
name	String	Name

Contact

PROPERTY	TYPE	DESCRIPTION
id	Number	Customer ID
name	String	Full name
first_name	String	Last name
last_namt	String	Given name
membership_no	String	Membership number
identity_no	String	National ID number
gender	Number	Gender
birth_at	Datetime	Birthday
profile_id	Number	ID of the customer's profile object
profile	Object	Customer profile object
sponsor	Object	Owner
sponsor_id	Number	Owner ID
email_contacts	Array of objects	Customer email array
cz_cols	Array of objects	Array of customer's dynamic fields
tags	Array of objects	Tag array
disturb_setting	Object	Do Not Disturb
*_contacts	Array of objects	Represents the customer's corresponding social media data in each messaging channel. For example: fb_contacts Represents Facebook social media data; line_contacts Represents LINE Official Account related data.

Customer Profile

PROPERTY	TYPE	DESCRIPTION
id	Number	The id of the customer profile object, used to fetch addresses and phones
phones	Array of object	Phone array

Email Contact

PROPERTY	TYPE	DESCRIPTION
id	Number	Email address id
contact_id	Number	Belongs to Customer id
address	String	Email address
draft	String	Draft
name	String	Custom email alias
description	String	Email description

Custom field CzCol

PROPERTY	TYPE	DESCRIPTION
id	Number	Dynamic field id
name	String	Dynamic field name
description	String	Dynamic field description
is_allowed_null	Boolean	Whether null values are allowed
default	Object	The default value of this dynamic field
type	Number	Dynamic field type 0: Number 1: String 2: Boolean 3: Date 4: Time 5: DateTime 6: Single choice 7: Multiple choice
category_id	Number	Parent category id
category	Object	Parent category
creater_id	Number	Employee id who created this dynamic field
creater	Object	Employee who created this dynamic field Employee

Custom field category CzColCategory

PROPERTY	TYPE	DESCRIPTION
id	Number	Dynamic field category id
name	String	Dynamic field category name
type	Number	Dynamic field category type {0: Contact dynamic form 1: Contact dynamic table 2: Ticket dynamic form 3: Ticket dynamic table}
description	String	Dynamic field category description
cols	Array of objects	Dynamic fields

Contact custom form Contact Cz Relation

PROPERTY	TYPE	DESCRIPTION
id	Number	Contact dynamic relation table id
relation_id	Number	Dynamic field category id
relation_name	String	Dynamic field category Name
information	Array of Objects	Contact dynamic relation table contents Array

Contact custom form Contact Cz RelationInformation

PROPERTY	TYPE	DESCRIPTION
id	Number	ID of contact dynamic relation table content
value	String	Value of contact dynamic relation table content
col_id	Number	Dynamic fields id
col_name	String	Dynamic fields Name

Contact Tag

PROPERTY	TYPE	DESCRIPTION
id	Number	id
name	String	Name
description	String	Description

Contact Do Not Disturb Setting

PROPERTY	TYPE	DESCRIPTION
id	Number	id
type	Array of string	Types of Do Not Disturb settings, including phone, Fb, Line
no_disturb_start_at	Time	Do Not Disturb start time
no_disturb_end_at	Time	Do Not Disturb end time
reason	String	Do Not Disturb reason

Employee

PROPERTY	TYPE	DESCRIPTION
id	Number	Employee id
name	String	Name
first_name	String	Last name
last_name	String	Given name
employee_no	String	Employee number
photo_url	String	Photo path
identity_no	String	National ID number
job_title_id	Number	Job title id
job_title	Object	Job title
department_id	Number	Department id
department	Object	Department
extension_id	Number	Extension id
extension	Object	Extension
profile	Object	Customer personal data
is_active	Boolean	Whether enabled
role	String	Permissions
email	String	Email address
group_id	Number	Employee group id
group	Object	Employee group
is_immortal	Boolean	Cannot be modified
cti_agent_account	String	cti account name
cti_agent	Object	CTI agent
created_at	Datetime	Initial creation time
updated_at	Datetime	Last update time

Job Title

PROPERTY	TYPE	DESCRIPTION
id	Number	id
abbrev	String	Abbreviation
name	String	Name
description	String	Description

Extension

PROPERTY	TYPE	DESCRIPTION
id	Number	id
type	Number	Type <0: Extension, 1: ACD, 2: IVR, 3: WEBRTC>
extension	String	Extension number
description	String	Description
media_cluster_id	Number	To be filled
media_cluster	Object	To be filled
employee_id	Number	Employee
employee	Object	Employee id

CTI Agent

PROPERTY	TYPE	DESCRIPTION
id	Number	id
account	String	Account
employee	Object	Employee
group_id	Number	Employee group id
group	Object	Employee group

Employee Group

PROPERTY	TYPE	DESCRIPTION
id	Number	Employee id
name	String	Name
description	String	Description
supervisor_id	Number	Supervisor id
supervisor	Object	Supervisor, format isEmployee
members	Array of object	Group members, format isEmployeeArray

Department

PROPERTY	TYPE	DESCRIPTION
id	Number	id
name	String	Name
abbrev	String	Abbreviation
number	Number	Code
description	String	Description

Phone Number

PROPERTY	TYPE	DESCRIPTION
id	Number	id
type	Number	0: Home, 1: Company, 2: Mobile, 3: Fax, 4: Other
extension	String	Extension
number	String	Number
description	String	Description

Ticket

PROPERTY	TYPE	DESCRIPTION
id	Number	id
subject	String	Title
content	String	Content
due_at	Datetime	Due time
status	Number	Ticket status < 0: Pending 1: In Progress 2: Resolved 3: Closed >
status_memo	String	Status note
priority	Number	Priority
termination_code_id	Number	Status detail id
termination_code	Object	Status detail
contact	Object	Customer
contact_id	Number	Customer id
sub_category	Object	Subcategory
sub_category_id	Number	Subcategory id
creater	Object	Employee who created this ticket
handler_id	Number	Employee id who created this ticket
handler	Object	Employee responsible for this ticket
sponsor_id	Number	Employee id responsible for this ticket
sponsor	Object	Owner of this ticket
created_at	Datetime	Initial creation time
updated_at	Datetime	Last update time

Ticket Termination Code

PROPERTY	TYPE	DESCRIPTION
id	Number	id
name	String	Name
description	String	Description
status	Number	Corresponding ticket status < 0: Pending 1: In Progress 2: Resolved 3: Closed >
creater_id	Number	Employee id who created this status detail
creater	Object	Employee who created this status detail

Category

PROPERTY	TYPE	DESCRIPTION
id	Number	id
name	String	Name
description	String	Description
children	Array of objects	Subcategory array

SubCategory

PROPERTY	TYPE	DESCRIPTION
id	Number	id
name	String	Name
description	String	Description
category	Object	Parent category
category_id	Number	Parent category id

Sponsor

PROPERTY	TYPE	DESCRIPTION
id	Number	id
name	String	Name
description	String	Description
is_immortal	Boolean	Whether it cannot be changed

Interact-collection (Service Record)

PROPERTY	TYPE	DESCRIPTION
id	Number	Service record system ID
is_acw_completed	Boolean	Whether the service is completed, 0: not completed, 1: completed
first_enter_queue_time	String	Time when customer first entered queue and assignment started.
first_start_service_at	Datetime	Time when agent answered and started service with customer.
last_finished_at	Datetime	Time when conversation with customer ended, but does not indicate service completion.
acw_at	Datetime	Time when agent finished completing this service.
handler_id	Number	Responsible agent system ID
handler	Object	Responsible agent data
contact_id	Number	Customer ID
contact	Object	Customer data
memo	String	Service record notes
bound_type	Number	Direction of the service. 0 indicates agent-initiated visit; 1 indicates customer-initiated contact.
logs	Array	All associated conversation records of this service record. The list does not include full information; retrieve a single record to get full details.
sponsor_id	Number	Owner ID
sponsor	Object	Owner data
reasons	Array	Service reason data
reason_ids	Arrary	IDs of all service reasons
result_id	Number	Service result ID
result	Object	Service result data
media_cluster_id	Number	Integration channel ID
media_cluster	Object	Integration channel
transfer_logs	Array	Transfer records for this service record
created_at	Datetime	Service record system creation time

Relation Import Recipe (Custom Form Import Template)

Property	Type	Description
id	Number	Custom form batch import templateid
name	String	Custom form batch import templateName
importable_type	String	Custom form batch import templateType of, currently only supports App\Contact
description	String	Custom form batch import templateDetailed description of
headers	Array	Field definitions of the import file
cz_col_category_id	Number	Dynamic field category id
cz_col_category	Object	Dynamic field category
unique_columns	Array	DefinedCustomerFields for unique value determination
relation_unique_column	Array	DefinedCustom formFields for unique value determination
creater_id	Number	Creator id
creater	Object	Creator
tasks_count	Number	According to thisCustom form batch import templateCreatedNumber of custom form batch import tasksCount

Relation Import Task (Custom Form Import Schedule)

Only important fields are described

Property	Type	Description
id	Number	Custom form import taskid
size	Number	File size (bytes)
total_amount	Number	Total rows
description	String	Task description
status	Number	Status (0: Created, 1: Importing, 2: Completed, 10: Error, 11: Paused)
current_sheet_index	Number	Which sheet the import file is currently executing
current_row_index	Number	Which row is currently being imported
executed_start_at	Datetime	Execution start time
executed_end_at	Datetime	Execution end time
creater_id	Number	Creator id
created_at	Datetime	Initial creation time
updated_at	Datetime	Last update time

Entity Import Recipe (Contact Import Template)

Property	Type	Description
id	Number	Batch import templateid
name	String	Batch import templateName
importable_type	String	Batch import templateType of, currently only supports App\Contact
description	String	Batch import templateDetailed description of
headers	Array	Field definitions of the import file
cz_col_category_id	Number	Dynamic field category id
cz_col_category	Object	Dynamic field category
unique_columns	Array	DefinedCustomerFields for unique value determination
creater_id	Number	Creator id
creater	Object	Creator
tasks_count	Number	According to thisBatch import templateCreatedBatch import taskCount

Entity Import Task (Contact Import Schedule)

Only important fields are described

Property	Type	Description
id	Number	Import taskid
size	Number	File size (bytes)
total_amount	Number	Total rows
description	String	Task description
status	Number	Status (0: Created, 1: Importing, 2: Completed, 10: Error, 11: Paused)
current_sheet_index	Number	Which sheet the import file is currently executing
current_row_index	Number	Which row is currently being imported
executed_start_at	Datetime	Execution start time
executed_end_at	Datetime	Execution end time
creater_id	Number	Creator id
created_at	Datetime	Initial creation time
updated_at	Datetime	Last update time