Click To Call

API dùng để thực hiện click-to-call.

Sau khi thực hiện click-to-call, hệ thống sẽ gọi vào số extension của domain, sau khi extension pickup cuộc gọi thì có một cuộc gọi đẩy ra số mobile dựa vào parameter của API.

Click To Call

POST [URL]/api/click2call

Headers

Name	Type	Description
Authorization	string	Bearer 'Access Token'

Request Body

Name	Type	Description
extension	string	Số máy lẻ nhân viên thực hiện cuộc gọi
hotline	string	Số Hotline (hay số SIP)
phone_number	string	Số điện thoại gọi tới

200

{
    "status_code": 9999,
    "instance_id": "stg",
    "instance_version": "1.2.163",
    "payload": {
        "call_uuid": "b4dae7fe-9d09-4491-918f-2b391fd5feef" // id cuộc gọi
    },
    "key_enabled": false
}

Error

{
	"status_code": -9999,
	"instance_id": "stg",
	"instance_version": "1.2.163",
	"payload": {
		"status": "fail",
		"error": "data_is_required",
		"message": "Please check your input param"
	},
	"key_enabled": false
}

Mô tả mã lỗi trong trường hợp gọi API không thành công

ERROR CODE (payload.error)	MESAGE (payload.message)	DESCRIPTION
data_is_required	Please check your input param	Dữ liệu là bắt buộc
tenant_invalid	Your tenant not found	Doanh nghiệp không hợp lệ
user_not_registered	User not registered extension with Softphone, IP Phone, Web	Số máy lẻ không được ghi danh tổng đài
number_call_out_invalid	Your hotline invalid	Số hotline gọi ra không hợp lệ hoặc không có
extension_invalid	Extension not found or disabled	Số máy lẻ không hợp lệ
user_busy	User busy	Số điện thoại gọi tới bận
do_not_call	Do not call	Số điện thoại gọi tới đăng ký donotcall (đăng ký không làm phiền ở nhà mạng)
	Unknown	Lỗi khác