Document API

CRM sẽ thiết kế link Webhook theo dạng URL hoặc JSON để nhận API :

Dưới đây là các ví dụ theo dạng URL tham khảo :

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://{CRM_URL}/api/callcenter/call_in?phone=0938363739&queue=999&extension=101&callid=5e012a75-121b-4c10-bdb4-c4b235b6a677&event=ANSWER&did=19002028

Trong đó:

  1. {CRM_URL} : 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 ( RING, ANSWER )
  7. did : Số điện thoại tổng đài

 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://{CRM_URL}/api/callcenter/hangup?callid=5e012a75-121b-4c10-bdb4-c4b235b6a677

Trong đó :

  1. {CRM_URL} : 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://{CRM_URL}/api/callcenter/calldata?callid=5e012a75-121b-4c10-bdb4-c4b235b6a677&calldate=2024-03-01 13:15:40&duration=50&billsec=37&status=ANSWER&did=19002028&extension=101&phone=0938363739&direction=Inbound&recordingfile=https://portal.voicecloud.vn/play_audio/data/5e012a75-121b-4c10-bdb4-c4b235b6a677

Trong đó :

  1. {CRM_URL} : 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 ( ANSWER, BUSY, …)
  7. did : Số điện thoại tổng đài
  8. extension : Số nội bộ của agent
  9. phone : Số điện thoại khách hàng
  10. direction : Hướng cuộc gọi ( Inbound hoặc Outbound )
  11. recordingfile : Đường dẫn file ghi âm cuộc gọi

CUỘC GỌI NHỠ

https://{CRM_URL}/api/callcenter/calldata?callid=5e012a75-121b-4c10-bdb4-c4b235b6a677&holdtime=60&status=ABANDON&queue=999&phone=0938363739

Trong đó :

  1. {CRM_URL} : Do CRM cung cấp
  2. callid : ID của cuộc gọi
  3. holdtime : Thời gian chờ của khách ( giây )
  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://{CRM_URL}/api/callcenter/calldata?callid=5e012a75-121b-4c10-bdb4-c4b235b6a677&status=NOANSWER&queue=999&extension=101&phone=0938363739

Trong đó :

  1. {CRM_URL} : 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

CUỘC GỌI RA

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

https://{CRM_URL}/api/callcenter/init?extension=101&phone=0938363739&callid=5e012a75-121b-4c10-bdb4-c4b235b6a677&event=ANSWER

Trong đó :

  1. {CRM_URL} : 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 của cuộc gọi
  5. event : Trạng thái cuộc gọi ( RING, ANSWER )

CẬP NHẬT TRẠNG THÁI REAL-TIME CỦA AGENT

https://{CRM_URL}/api/Agent/ChangeStatus?extension=101&status=talk

Trong đó :

  1. {CRM_URL} : Do CRM cung cấp
  2. extension : Số nội bộ của agent
  3. status : Trạng thái của agent (*)

(*) 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

API TỪ TỔNG ĐÀI 

SỰ KIỆN CLICK2CALL

CRM chạy đường dẫn này method GET kiểu dữ liệu URL :

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

Trong đó : 

  1. {PBX_URL} : 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ộ muốn gọi. ( ví dụ : 101 )
  4. phone : Số khách hàng muốn gọi. ( ví dụ : 0938363739 )
  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 kiểu dữ liệu JSON :

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

—-

Data :
{
  "key" : "98589afb123863cf4d5cd4ec2c41072",
  "list" :
   [
    {"ext" : "100"},
    {"ext" : "200"}
   ]
}

Trong đó :

  1. {PBX_URL} : 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 kiểu dữ liệu JSON :

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

—-

Data :
{
 "key" : "98589afb123863cf4d5cd4ec2c41072",
 "src" : "100",
 "dst" : "101",
 "mode" : "whisper"
}

Trong đó :

  1. {PBX_URL} : 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 do 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 kiểu dữ liệu JSON :

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

—-

Data :
{
 "key" : "98589afb123863cf4d5cd4ec2c41072"
}

Trong đó :

  1. {PBX_URL} : 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.

THAY ĐỔI TRẠNG THÁI EXTENSION TRONG QUEUE

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

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

—

Data :
{
 "key" : "98589afb123863cf4d5cd4ec2c41072",
 "exten" : "100",
 "status" : "0"
}

Trong đó :

  1. {PBX_URL} : 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 thay đổi.
  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 kiểu dữ liệu JSON :

https://{DATA_URL}/internal/Reports/cdr/format/json

—

Data :
{
 "key" : "98589afb123863cf4d5cd4ec2c41072",
 "callid" : "fb80cc79-e179-1234-92d7-04748b9bb475",
 "startdate" : "2022-09-23",
 "enddate" : "2022-09-23"
}

Trong đó :

  1. {DATA_URL} : Do tổng đài cung cấp.
  2. internal/Reports/cdr/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 : Khoảng thời gian. ( Format : YYYY-MM-DD )
Đánh giá của bạn: