Report
GET https://host:port/api/cacs/v1/call_result
Headers
Content-Type*
String
application/json
access_token*
String
Cung cấp bởi CloudPBX (Provided by CloudPBX)
Request Body
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
{
"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:
Body repuest example:
Tham số (Parameters):
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)
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”
Last updated