For the complete documentation index, see llms.txt. This page is also available as Markdown.

4. API get ticket

1. List of tickets or details of a ticket via id on Ant CRM

URL: https://apiring.antbuddy.com/tickets

Method: GET

Content-Type: application/json

Parameters

Type

Required

Explain

TicketId

string

Id of ticket

page

number

Page number, maximum 20 Orders per page

limit

number

Number of records per page

typeTime

string

If the parameter typeTime is passed as updatedAt, then the updated date will be used; otherwise, the created date will be used.

startDate

string

For example:2024-03-13T06:24:20.673Z

endDate

string

For example:2024-03-19T06:24:20.673Z

isTicketDeleted

Boolean

If isTicketDeleted is true, retrieve all tickets, including deleted tickets.

Results returned: HTTP Response Code: 200

Response:

[{

SLA: "",

TicketId: 17464,

assignedTo: "thong.nguyen@antbuddy.com",

group: “”,

category: “”,

resolutionTypeOb: “”,

contact: {},

cusFields: []

deal: {},

files: []

priority: "Medium"

status: "Assigned"

summary: "<p>test</p>"

title: "[Phone] Thông test",

createdAt: “”, // Thời gian tạo ticket

updatedAt: “” // Thời gian cập nhật ticket

}]

  1. Add tickets

URL: https://apiring.antbuddy.com/tickets

Method: POST

Content-Type: application/json

Parameters

Type

Required

Explain

title

string

AND

Ticket name

ticketIdApiRing

string

Ticket code

summary

string

Summary/Summary

priority

string

Priority. Default: Medium

SLA

string

AND

Sla

contact

object Y

Y

{

“id”: “661ca720f70843211b05712a” //

Customer id code If yes, it is not required.

“emails”: [{type: “Work”, value:

“xyz@example.com”}], “name”: “thong”, // required

“phones”: [{type: “Work”, value: “023232”}]

}

deal

object

group

string

category

string

status

string

resolutionTypeOb

string

files

array

cusFields

array

AntCRM custom fields.

[

{ name: "Shipping

unit",

value: “Fast delivery”

}

]

Results returned:

HTTP Response Code: 200

Response:

{

"success": 1,

"TicketId”: 9457 (ticket id on antcrm) }

  1. Edit tickets

URL: https://apiring.antbuddy.com/tickets

Method: PUT

Content-Type: application/json

Parameters

Type

Required

Explain

TicketId

string

AND

title

string

Ticket name

summary

string

Summary/Summary

priority

string

Priority

SLA

string

deal

object

category

string

status

string

resolutionTypeOb

string

filed

array

cusFields

array

AntCRM custom fields.

[

{ name: "Shipping

unit",

value: “Fast delivery”

}

]

Results returned:

HTTP Response Code: 200

Response:

{

"success": 1,

"number”: 9457 (id of order on antcrm) }

  1. Delete tickets

URL: https://apiring.antbuddy.com/tickets

Method: DELETE

Content-Type: application/json

Parameters

Type

Required

Explain

TicketId

string

AND

ticket id on antcrm

Results returned: HTTP Response Code: 200

Response:

{

"success": 1

}

1. Thông tin chung của Ticket

Field
Mô tả

id

ID nội bộ của ticket

ticketId

Mã ticket hiển thị (dễ đọc cho user)

title

Tiêu đề ticket

summary

Nội dung chi tiết (HTML)

status

Trạng thái (vd: Closed)

priority

Độ ưu tiên (Low / Medium / High)

tags

Danh sách tag gắn vào ticket

category / subCategory / subSubCategory

Danh mục ticket

group

Nhóm xử lý (vd: CS & QA)

assignedTo

Người đang được giao xử lý

createdBy

Người tạo ticket

closedBy

Người đóng ticket

cusFields

Danh sách trường tùy chỉnh

2. Thời gian & SLA

Field
Mô tả

createdAt / createdAtDate

Thời điểm tạo ticket (timestamp)

updatedAt

Thời điểm cập nhật gần nhất

assignedAt

Thời điểm assign

resolvedAt

Thời điểm xử lý xong

closedAt / closedAtDate

Thời điểm đóng ticket

lastDateCare

Lần chăm sóc cuối

idleTimeAt

Thời điểm bắt đầu idle

SLA

Field
Mô tả

SLA

ID cấu hình SLA

SLAAt

Deadline SLA

SLAIn

Thời gian SLA

SLAStatus

Trạng thái SLA (Success / Fail)

SLAResolutionActual

Thời gian thực tế resolve

firstResponseActual

Thời gian phản hồi đầu tiên

3. Trạng thái & Xử lý

Field
Mô tả

isOpen

Ticket còn mở hay không

isClose

Ticket đã đóng

isWait

Đang chờ xử lý

isAutomation

Ticket tạo tự động

reraisedTimes

Số lần reopen

holdingTime

Thời gian giữ ticket

deferredIn / deferredDate

Thông tin hoãn xử lý

4. Thông tin khách hàng (Contact)

Field
Mô tả

contact

Object thông tin khách hàng

name

Tên công ty / khách hàng

customerId

ID khách hàng

contactType

Loại (customer, lead…)

phones / emails

Danh sách liên hệ

addresses

Địa chỉ

responsibleStaff

Nhân viên phụ trách

createdBy

Người tạo contact

Last updated