API yêu cầu

Yêu cầu bao gồm những thông tin được giải thích trong bảng sau:

Subject Tiêu đề của yêu cầu
Content Content of the ticket
Status Trạng thái của yêu cầu bao gồm:
{0: mới, 1: mở, 2; tạm dừng, 3: đã giải quyết, 4: đóng}
Agent_id ID của nhân viên được phân công xử lý
Group_id ID của nhóm được phân công
Requester_id ID của khách hàng
Cc_agents ID của những nhân viên được CC trong yêu cầu
[{id1},{id2},…]
Type Loại của yêu cầu bao gồm:
{1: câu hỏi, 2: sự cố, 3: vấn đề, 4: công việc}
Priority Độ ưu tiên của yêu cầu bao gồm:
{1: thấp, 2: bình thường, 3: cao, 4: khẩn cấp}
Tags Gắn các tag cho yêu cầu
[{tag1},{tag2},…]
Fields Các thông tin yêu cầu (bộ nhãn)
{field_key1:value1, field_key2:value2,…}

API TẠO YÊU CẦU

POST https://{sub_domain}.izihelp.com/api/ticket/detail

  • Để tạo được một yêu cầu, bắt buộc phải có các thông tin: subject, comment,status
  • Các thông tin còn lại tùy theo nhu cầu bạn có thể thêm vào hoặc không.
  • Tạo yêu cầu trạng thái giải quyết thì bắt buộc phải có agent_id.
  • Không được tạo yêu cầu trạng thái đóng (dùng kích hoạt và kích hoạt tự động để đóng).

Ví dụ:

 "comment":{
   "content":"Tôi muốn hỏi MS001 con hàng không"
   }, 
 "ticket":{
   "subject": "MS001 còn hàng không?", 
   "status": 1, 
   "fields": { 
       "source_url": "https://example.com/vi/pricing/",
       "date": 1510825200000,
       "Tickey_type": "1stPriority_Change information",
       "SDT": "0908936859",
       "Root_Cause": "Không xác định được",
       "Customer_ID": "A90T1",
       "Contact_Operations": ["QUẬN 6","QUẬN 3"] 
      },
  "priority": 2,
  "type": 1, 
  "agent_id": "57680286ef6d3f8f081e6bc7",
  "group_id": "57680287ef6d3f8f081e6c35",
  "requester_id": "578d9a7bee0cedea5d651bbe", 
  "tags": [
     "tuvan",
     "banhang",
     "kiemhang" 
     ],
  "cc_agents": [
     "577f144171fe9b5b5ff364b4", 
     "5780a7f303bf588e1afc9b89", 
     "578350137ea90fe266a5a8d8"
    ]
  } 
}

CẬP NHẬT YÊU CẦU

PUT https://{sub_domain}.izihelp.com/api/ticket/detail/{ticket_id}

  • Thêm thông tin mới và giữ nguyên thông tin đã có sẵn trước đó thì dùng {“:mode”: “mix-data”}
  • Muốn xóa thông tin đã có trước đó thì truyền trong “delete” dạng {“field”:true}

{

  "comment":{

      "content":"Mãu này còn hàng nhé bạn ơi. Bạn thích màu nào?"

    },

 "update":{

      "status":2,

      "tags":[

         {":mode": "mix-data"},

         "mausac"

      ] },

"delete":{

    "type":true,

    "fields":{

      "Root_Cause": true

      }

 }

 }

XÓA YÊU CẦU

DELETE https://{sub_domain}.izihelp.com/api/tickets/{ticket_id}

XEM YÊU CẦU

GET https://{sub_domain}.izihelp.com/api/tickets/{ticket_id}

XEM COMMENT ĐẦU TIÊN (Mô tả)

GET https://{sub_domain}.izihelp.com/api/ticket/detail/{ticket_id}/first-comment

XEM DANH SÁCH COMMENT

– params: id,
– body:
– query: view,limit, skip, sortBy, sortOrder
– limit default value là 15
– skip theo thời gian comment add_time
– nếu response trả về có biến is_all: false nghĩa là vẫn còn data để xem tiếp

GET https://{sub_domain}.izihelp.com/api/ticket/detail/{ticket_id}/comments