Document API - ISA Technology

Document API

CRM kết nối API thì cần các đường dẫn để nhận theo dạng URL hoặc JSON :

  • CUỘC GỌI ĐẾN

Khi có cuộc gọi vào tổng đài sẽ đổ chuông tới máy nhân viên (ví dụ extension: 101):

https://{domain_crm}/api/callcenter/call_in?phone=093xxxxxxx&queue=999&extension=101&callid={ID_Call}&event={event}

Trong đó:

  1. {domain_crm} : Do CRM cung cấp 
  2. phone : Số điện thoại gọi đến
  3. queue : Nhóm trực của số nội bộ ( Nếu Có )
  4. extension : Số nội bộ của agent
  5. callid : ID của cuộc gọi
  6. event : Trạng thái cuộc gọi ( ANSWER, RINGING )
  • KẾT THÚC CUỘC GỌI

Đây là sự kiện báo cho CRM biết là kết thúc cuộc gọi :

https://{domain_crm}/api/callcenter/hangup?callid={ID_Call}

Trong đó :

  1. {domain_crm} : do CRM cung cấp
  2. callid : ID của cuộc gọi
  • THÔNG TIN CUỘC GỌI

Khi kết thúc cuộc gọi thì tổng đài có thể trả về thông tin chi tiết cuộc gọi:

https://{domain_crm}/api/callcenter/calldata?callid={ID_Call}&calldate={calldate}&duration={duration}&billsec={billsec}&status={status}&extension={extension}&phone={phone}&recordingfile={recordingfile}

Trong đó :

  1. {domain_crm} : Do CRM cung cấp
  2. callid : ID của cuộc gọi
  3. calldate : Thời gian bắt đầu thực hiện cuộc gọi ( định dạng y-m-d h:m:s )
  4. duration : Thời gian bắt đầu cuộc gọi
  5. billsec : Thời gian bắt đầu thoại
  6. status : Trạng thái cuộc gọi ( ANSWERED, BUSY, …)
  7. extension : Số nội bộ của agent
  8. phone : Số điện thoại khách hàng
  9. recordingfile : Đường dẫn file ghi âm cuộc gọi
  • CUỘC GỌI NHỠ

https://{domain_crm}/api/callcenter/calldata?callid={ID_Call}&holdtime=30&status=ABANDON&queue={queue}&phone={phone}

Trong đó :

  1. {domain_crm} : Do CRM cung cấp
  2. callid : ID của cuộc gọi
  3. holdtime : Thời gian chờ của khách
  4. status : Trạng thái cuộc gọi ( ABANDON )
  5. queue : Tên nhóm trực
  6. phone : Số điện thoại khách hàng
  • AGENT KHÔNG TRẢ LỜI

https://{domain_crm}/api/callcenter/calldata?callid={ID_Call}&status=NOANSWER&queue={queue }&extension={extension}&phone={phone}

Trong đó :

  1. {domain_crm} : Do CRM cung cấp
  2. callid : ID của cuộc gọi
  3. status : Trạng thái cuộc gọi ( NOANSWER )
  4. queue : Tên nhóm trực
  5. extension : Số nội bộ của agent
  6. phone : Số điện thoại khách hàng
  • SỰ KIỆN GỌI RA

Đồng bộ dữ liệu cho CRM biết có cuộc gọi ra từ Tổng Đài :

https://{domain_crm}/api/callcenter/init?extension={extension}&phone={phone}&callid={ID_Call}&event={status}

Trong đó :

  1. {domain_crm} : Do CRM cung cấp
  2. extension : Số nội bộ của agent
  3. phone : Số điện thoại gọi ra
  4. callid : ID cuộc gọi
  5. event : RINGING, ANSWERED.
  • SỰ KIỆN CẬP NHẬT TRẠNG THÁI CUỘC GỌI CỦA AGENT

CRM thiết kế link cho CallCenter gửi trạng thái Agent

  • Method : POST hoặc GET ( tùy thuộc vào CRM )
  • Content-Type : application/json
  • Body : 

{

    “id”: “Mã công ty”,

    “extension” : “Số extension”,

    “status” : “Trạng thái extension” (*)

}

(*) Giá trị trạng thái Extension

Giá trịMô tả
offAgent (phone) chưa online
onAgent (phone) sẵn sàng
pauseAgent (phone) tạm nghỉ
ringAgent (phone) đang ring
talkAgent (phone) đang talk

Ví Dụ :

https://{domain_crm}/api/callcenter/Agent/ChangeStatus

API TỪ TỔNG ĐÀI

  • SỰ KIỆN CLICK2CALL

CRM chạy đường dẫn này method GET :

https://{domain_callcenter}/api/CallControl/dial/from_number/{extension}/to_number/{phone}/key/{key}/domain/{domain}

Trong đó : 

  1. {domain_callcenter} : Do tổng đài cung cấp.
  2. api/CallControl/dial : Tên phương thức gọi API của hệ thống.
  3. extension : Số nội bộ do hệ thống CRM cung cấp. ( vd : 100 )
  4. phone : Số khách hàng do hệ thống CRM cung cấp.
  5. key : Khóa của công ty do tổng đài cung cấp.
  6. domain : Tên miền của công ty do tổng đài cung cấp.
  • KIỂM TRA TRẠNG THÁI EXTENSION

CRM chạy đường dẫn này method POST bằng dữ liệu JSON :

https://{domain_callcenter}/api/Agent/status/format/json

—-

Data :

{

         “key” : “98589afb123863cf4d5cd4ec2c41072”,

         “list” : 

[

         {“ext” : “100”},

         {“ext” : “200”}

]

}

Trong đó :

  1. {domain_callcenter} : Do tổng đài cung cấp.
  2. api/Agent/status/format/json : Tên phương thức gọi API của hệ thống.
  3. key : Khóa của công ty do tổng đài cung cấp.
  4. ext : Extension muốn kiểm tra.
  • SỰ KIỆN SPY CALL

CRM chạy đường dẫn này method POST bằng dữ liệu JSON :

https://{domain_callcenter}/api/Agent/spy/format/json

—-

Data :

{

         “key” : “98589afb123863cf4d5cd4ec2c41072”,

         “src” : “100”,

         “dst” : “101”,

         “mode” : “whisper”

}

Trong đó :

  1. {domain_callcenter} : Do tổng đài cung cấp.
  2. api/Agent/spy/format/json : Tên phương thức gọi API của hệ thống.
  3. key : Khóa của công ty tổng đài cung cấp.
  4. src : Extension người thực hiện.
  5. dst : Extension người bị nghe.
  6. mode :
      • whisper : chỉ nghe.
      • threeway : nói với cả hai.
      • caller : nói với người gọi ( caller )
      • callee : nói với người nghe
  • SỰ KIỆN LẤY DANH SÁCH EXTENSION TRONG QUEUE

CRM chạy đường dẫn này method POST bằng dữ liệu JSON :

https://{domain_callcenter}/api/Agent/all_members/format/json

—-

Data :

{

         “key” : “98589afb123863cf4d5cd4ec2c41072”

}

Trong đó :

  1. {domain_callcenter} : Do tổng đài cung cấp.
  2. api/Agent/all_members/format/json : Tên phương thức gọi API của hệ thống.
  3. key : Khóa của công ty do tổng đài cung cấp.
  • KIỂM TRA TRẠNG THÁI EXTENSION TRONG QUEUE

CRM chạy đường dẫn này method POST bằng dữ liệu JSON :

https://{domain_callcenter}/api/Agent/update_status

—

Data :

{

         “key” : “98589afb123863cf4d5cd4ec2c41072”,

         “exten” : “100”,

         “status” : “0”

}

Trong đó :

  1. {domain_callcenter} : Do tổng đài cung cấp.
  2. api/Agent/update_status : Tên phương thức gọi API của hệ thống.
  3. key : Khóa của công ty do tổng đài cung cấp.
  4. exten : Số extension muốn kiểm tra.
  5. status : Trạng thái của extension. ( 0 : unpaused , 1 : paused )
  • LẤY DỮ LIỆU CUỘC GỌI

CRM chạy đường dẫn này method POST bằng dữ liệu JSON :

https://{domain_callcenter}/api/Reports/calllog/format/json

—

Data :

{

         “key” : “98589afb123863cf4d5cd4ec2c41072”,

         “callid” : “fb80cc79-e179-1234-92d7-04748b9bb475”,

         “startdate” : “2022-09-23”,

         “enddate” : “2022-09-23”

}

Trong đó :

  1. {domain_callcenter} : Do tổng đài cung cấp.
  2. api/Report/calllog/format/json : Tên phương thức gọi API của hệ thống.
  3. key : Khóa của công ty do tổng đài cung cấp.
  4. callid : ID của cuộc gọi.
  5. startdate – enddate : Ngày thực hiện cuộc gọi ( Format : YYYY-MM-DD )

Chia sẻ nếu thấy hữu ích: