Report

GET https://host:port/api/cacs/v1/call_result

Headers

Name	Type	Description
Content-Type*	String	application/json
access_token*	String	Cung cấp bởi CloudPBX (Provided by CloudPBX)

Request Body

Name	Type	Description
campaign_key*	String	campaign_key
start_date*	String	start_date
end_date*	String	end_date
status*	String	array_of_status
ref_id*	String	reference_id

200: OK success

{
	"result": "success",
	"message": "Have <number_of_records> records found",
	“records”: [{
		“campaign_id”: “<id_of_campaign>”,
		“campaign_name”: “<campaign_name>”,
		“campaign_lead_id”: “<campaign_lead_id>”,
		“ref_id”: “<ref_id>”,
		“phone_number”: “<phone_number>”,
		“lead_name”: “<lead_name>”,
		“call”: “<total_call_of_campaign_lead_id>”,
		“data”: [{
			“session”: “<session_of_call>”,
			“wait_time”: “<wait_time>”,
			“talk_time”: “<talk_time>”,
			“phone_number”: “<phone_number>”,
			“date_time”: “<date_time>”,
			“status”: “<state_of_call>”,
			“retry”: “<number_call_back>”,
			“key_press”: “<key_press>”
		}, 
		{…}]
}, 
{…}]
}

Example:

   {{
	"result": "success",
	"message": "Have 3 records found",
	“records”: [{
		“campaign_id”: “101”,
		“campaign_name”: “CSKH”,
		“campaign_lead_id”: “503525”,
		“ref_id”: “”,
		“phone_number”: “0901234567”,
		“lead_name”: “James”,
		“call”: “2”,
		“data”: [{
			“session”: “1673347019.102878”,
			“wait_time”: “52”,
			“talk_time”: “0”,
			“phone_number”: “0901234567”,
			“date_time”: “2023-01-10 17:36:59”,
			“status”: “NOANSWER”,
			“retry”: “0”,
			“key_press”: “”	
		}, 
		{
			“session”: “1673347931.102881”,
			“wait_time”: “38”,
			“talk_time”: “35”,
			“phone_number”: “0901234567”,
			“date_time”: “2023-01-10 17:52:11”,
			“status”: “ANSWER”,
			“retry”: “1”,
			“key_press”: “1|Agree”	
}]
}, 
{
		“campaign_id”: “101”,
		“campaign_name”: “CSKH”,
		“campaign_lead_id”: “503555”,
		“ref_id”: “”,
		“phone_number”: “0909876543”,
		“lead_name”: “Tony B”,
		“call”: “1”,
		“data”: [{
			“session”: “1673347019.102877”,
			“wait_time”: “7”,
			“talk_time”: “23”,
			“phone_number”: “0909876543”,
			“date_time”: “2023-01-10 17:36:59”,
			“status”: “ANSWER”,
			“retry”: “0”,
			“key_press”: “0|Disagree”	
		}]	
}]
}

400: Bad Request Fail

401: Unauthorized Invalid token

Body repuest example:

{
“campaign_key”:  “askeiqlaoslskshny”,   
“start_time”: “2023-01-10”,
“end_time”: “2023-01-10”,
“status”: “ANSWER, NOANSWER, BUSY, FAILED”,
“ref_id”: “LA123846w37”
}  

Tham số (Parameters):

Tham số (Parameters)	Kiểu (Type)	Mô tả (Description)
access_token(*)	Chuỗi, tối đa 50 ký tự (String, max. 50 character)	Thông tin xác thực giữa CloudPBX và Khách hàng, cung cấp bởi CloudPbx (Authentication information between CloudPBX and Customer, provided by CloudPBX)
campaign_key(*)	Chuỗi, tối đa 32 ký tự (String, max. 32 character)	Mã chiến dịch, bắt buộc, cung cấp bởi Cloudpbx (Campaign key, required, provided by CloudPBX)
start_date (*) end_date (*)	Chuỗi, tối đa 19 ký tự (String, max. 19 character)	Bắt buộc (Required) Định dạng (Format): “yyyy-mm-dd” or “yyyy-mm-dd H:i:s” Ví dụ (Ex): “2022-08-01” or “2022-08-01 23:59:59” Khoảng thời gian là 31 ngày, tính từ ngày bắt đầu tới ngày kết thúc (Period 31 days, from ‘start_date’ to ‘end_date’)
status	Chuỗi, tối đa 40 ký tự (String, max. 40 character)	Trạng thái cuộc gọi, không bắt buộc, cách nhau bằng dấu phẩy (Call status, not required, separated by commas)
ref_id	Chuỗi, tối đa 32 ký tự (String, max. 32 character)	Mã định danh khách hàng, trường không bắt buộc (Reference id, value is not required)

Danh sách lỗi (Errors list)

Tham số (Parameter)	Không khai báo (Not declared)	Thông tin chưa chính xác (Incorect information)
access_token	“Missing header #access_token#. Please check it again”	“Header #access_token# does not match. Please check it again”
campaign_key	“Missing parameter #campaign_key#. Please check it again”	“Parameter #campaign_key# does not match. Please check it again”
start_date end_date	“Missing parameter #start_date# or #end_date#. Please check it again”	“Parameter #start_date# is wrong format. Please check it again” “Parameter #start_date# is over maximum length. Please check it again” “Parameter #end_date# is wrong format. Please check it again” “Parameter #end_date# is over maximum length. Please check it again” “Parameter #start_date# or #end_date# is wrong format#. Please check it again” “Parameter #start_date# is larger than #end_date##. Please check it again” “Invalid time. Over 31 days”
ref_id		“Data is not found with <ref_id>. Please check it again”