Khai thác dữ liệu chuyên sâu

Api Search hỗ trợ tìm kiếm đa điều kiện, tìm khách hàng, tổ chức, phiếu ghi theo các thành phần đặc thù của chúng

Trong một số trường hợp cần khai thác sâu dữ liệu theo các điều kiện riêng biệt (VD: Chỉ lấy các phiếu ghi có trường động có tên "Phân loại" đã lựa chọn giá trị "Chốt đơn"). Lập trình viên có thể sử dụng API search và truyền vào các điều kiện tìm kiếm cụ thể theo giá trị "Chốt đơn" như yêu cầu

Để bắt đầu tìm kiếm sử dụng cú pháp truyền qua body json với cấu trúc

Param tìm phiếu ghi cuộc gọi nhỡ
{
    "params": {
        "q": "Cuộc gọi nhỡ"
    }
}

Trong đó: “q” chứa từ khóa tìm kiếm, Tùy theo định dạng dữ liệu của “q” mà hệ thống sẽ tìm kiếm nhanh trong dữ liệu phiếu ghi:

  • Nếu chứa toàn số. Hệ thống sẽ tự tìm theo Số Phiếu ghi.

  • Nếu là ký tự văn bản, hệ thống sẽ tìm theo Tiêu đề của phiếu ghi

Api Search

API tìm kiếm dữ liệu chuyên sâu

POST {{domain}}/api/v1/search

Headers

NameTypeDescription

***

String

Thông tin xác thực mặc định

Request Body

NameTypeDescription

*

String

Đối tượng được mô tả trong tài liệu phía dưới

  1. TÌM PHIẾU GHI

Sub paramKey paramKiểuÝ nghĩa

type

String

Loại dữ liệu tìm kiếm TICKET: Tìm phiếu ghi (*) mặc định USER: Tìm khách hàng ORG: Tìm tổ chức

page

Int

Trang dữ liệu

count

Int

Số bản ghi trên 1 trang dữ liệu trả về (Tối đa 500)

params

Object array

Mảng đối tượng chứa điều kiện tìm kiếm

q

Chuỗi tìm kiếm mặc định

  • Nếu chứa toàn số. Hệ thống sẽ tự tìm theo Số Phiếu ghi.

  • Nếu là ký tự văn bản, hệ thống sẽ tìm theo Tiêu đề của phiếu ghi Lưu ý: Nếu truyền dạng 098xxxx (số điện thoại) thì hệ thống sẽ hiểu là tìm theo chuỗi ký tự văn bản và tìm tương đối trong tiêu đề phiếu ghi

ticket_subject

String

Tìm tương đối trong tiêu đề phiếu ghi

ticket_id

int

Tìm chính xác theo TIcket_ID

ticket_no

Int

Tìm chính xác theo Ticket Number

assignee_id

Int

Tìm chính xác theo người xử lý (Xem thêm API Contact để lấy được ID)

service_id

Int

Tìm chính xác theo ID dịch vụ (Tham khảo API Lấy danh sách dịch vụ để có ServiceID)

ticket_priority

String

ticket_status

String

ticket_source

String

requester_id

Int

Tìm ticket chính xách theo ID người yêu cầu (Xem thêm API Contact để lấy được ID)

campaign_id

Int

Tìm ticket chính xách theo ID chiến dịch (Xem thêm API Chiến dịch)

satisfaction_channel

Int

Tìm ticket theo kênh khảo sát. Các giá trị cho phép từ 1 đến 6 Trong đó: 1- voice, 2 - email, 3- sms, 4- manual, 5 - Livechat, 6 - Inbox Facebook

created_since

Date

Tìm ticket có ngày tạo từ ngày (YYYY-MM-DDTHH:mm:ssZ)

created_to

Date

Tìm ticket có ngày tạo nhỏ hơn ngày (YYYY-MM-DDTHH:mm:ssZ)

updated_since

Date

Tìm ticket có ngày cập nhật từ ngày (YYYY-MM-DDTHH:mm:ssZ)

updated_to

Date

Tìm ticket có ngày cập nhật nhỏ hơn ngày (YYYY-MM-DDTHH:mm:ssZ)

duedate_since

Date

Tìm ticket có thời hạn xử lý từ ngày (YYYY-MM-DDTHH:mm:ssZ)

duedate_to

Date

Tìm ticket có thời hạn xử lý nhỏ hơn ngày (YYYY-MM-DDTHH:mm:ssZ)

qa_script_id

Int

Tìm kiếm phiếu ghi theo ID kịch bản QA

qa_agent

Int

Tìm kiếm phiếu ghi theo ID Chuyên viên QA

current_agent

Int

Tìm kiếm phiếu ghi QA theo chuyên viên

tag_name

String

Tìm ticket có gắn tag

custom_fields

Array

Mảng chứa điều kiện tìm kiếm theo trường động (* xem thêm mục 4)

  1. TÌM KHÁCH HÀNG (CONTACT)

Key paramKey paramKiểu dữ liệuÝ nghĩa

type

String

Loại dữ liệu tìm kiếm:

page

Int

Trang dữ liệu

count

Int

Số bản ghi trên 1 trang dữ liệu trả về

params

Object

Mảng đối tượng chứa điều kiện tìm kiếm

q

Chuỗi tìm kiếm mặc định

  • Nếu chứa toàn số. Hệ thống sẽ tự tìm theo ID người dùng.

  • Nếu là ký tự văn bản, hệ thống sẽ tìm theo Địa chỉ, tên người dùng, email người dùng, số điện thoại của người dùng Lưu ý: Nếu truyền dạng 098xxxx (số điện thoại) thì hệ thống sẽ hiểu là tìm theo chuỗi ký tự văn bản và tìm tương đối trong tên người dùng, số điện thoại của người dùng

email

String

Tìm tương đối theo email của người dùng

organization_id

Int

Tìm chính xác theo tổ chức của người dùng (Xem thêm API Tìm tổ chức)

follower_id

Int

Tìm chính xác khách hàng theo ID của người xử lý (Xem thêm API Agent)

username

String

Tìm tương đối theo tên người dùng

phone_no

String

Tìm tương đối theo số điện thoại của người dùng

address

String

Tìm tương đối theo địa chỉ người dung

detail

String

Tìm tương đối theo trường thông tin thêm

note

String

Tìm tương đối theo trường ghi chú

tag_name

String

Tìm người dùng có gắn tag

created_since

Date

Tìm người dùng có ngày tạo từ ngày

created_to

Date

Tìm người dùng có ngày tạo nhỏ hơn ngày

updated_since

Date

Tìm người dùng có ngày cập nhật từ ngày

updated_to

Date

Tìm người dùng có ngày cập nhật nhỏ hơn ngày

custom_field

Array

Mảng chứa điều kiện tìm kiếm theo trường động (* xem thêm mục 4)

TỔ CHỨC

Key paramKey paramKiểu dữ liệuÝ nghĩa

type

String

Loại dữ liệu tìm kiếm TICKET: Tìm phiếu ghi USER: Tìm khách hàng ORG: Tìm tổ chức

page

Int

Trang dữ liệu

count

Int

Số bản ghi trên 1 trang dữ liệu trả về

params

Object array

Mảng đối tượng chứa điều kiện tìm kiếm

q

Chuỗi tìm kiếm mặc định

  • Nếu chứa toàn số. Hệ thống sẽ tự tìm chính xác theo ID Tổ chức.

  • Nếu là ký tự văn bản, hệ thống sẽ tìm theo Tên tổ chức, Domain của tổ chức

domain

String

Tìm tương đối theo domain của tổ chức

name

String

Tìm tương đối theo tên tổ chức

detail

String

Tìm tương đối theo trường thông tin thêm

note

String

Tìm tương đối theo trường chú ý

created_since

Date

Tìm tổ chức có ngày tạo từ ngày

created_to

Date

Tìm tổ chức

có ngày tạo nhỏ hơn ngày

updated_since

Date

Tìm tổ chức có ngày cập nhật từ ngày

updated_to

Date

Tìm tổ chức có ngày cập nhật nhỏ hơn ngày

tag_name

String

Tìm người dùng có gắn tag

custom_fields

Array

Mảng chứa điều kiện tìm kiếm theo trường động (* xem thêm mục 4)

TRƯỜNG ĐỘNG

Trường động có cấu trúc chung giống nhau cho cả 3 đối tượng và tùy theo kiểu dữ liệu trường động được thiết lập trong cấu hình, hệ thống sẽ nhận diện kiểu dữ liệu tương ứng

Cấu trúc mảng trường động kết hợp

"custom_fields": [    
            {
                "field_id": 14,
                "field_value_since": "2019-10-09T10:15:00Z",
                "field_value_to": "2019-11-09T10:15:00Z"
            },
            {
                "field_id": 16,
                "field_value_greater": "15",
                "field_value_lesser": "50"
            },
            {
                "field_id": 19,
                "field_value": "CODE234"
            }
        ]

Trong đó:

  • field_id: ID trường động (Tham khảo API /custom_fields của từng đối tượng dữ liệu trong tài liệu API DOCS)

  • field_value: Từ khóa tìm kiếm tương đối đối với dữ liệu dạng Văn bản, Số, Ký tự, chọn nhiều, tìm kiếm chính xác với dữ liệu dạng chọn 1.

  • field_value_since: Tìm kiếm với dữ liệu dạng ngày tháng từ ngày.

  • field_value_to: Tìm kiếm dữ liệu với dạng ngày tháng tới ngày

  • field_value_greater: Tìm kiếm dữ liệu dạng số với giá trị lớn hơn.

  • field_value_lesser: Tìm kiếm dữ liệu dạng số với giá trị nhỏ hơn

PreviousKết quả chiến dịchNextSmart Dialer

Last updated