fbpx

< / >

APIs Reports Manager

5. Pre-call detail (per call)

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_5&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

Description:

This report allows you to know the details of the Preview campaigns taking into account the details of the call (type, ID, duration, result, who ends the interaction and agent that manages), the customer (full name, phone number), campaign (ID, date) and comments of the call or the customer.

Benefit:

It allows to know the performance of preview campaigns in detail on a call-by-call basis.

How it works:

  • The consumption of this API is done by GET method.
  • To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
  • The wolkvox-token header must be used to make use of the authorization token.
  • Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.
  • In terms of time, to keep track of your operation you can make a consumption every 5 minutes of the information.

NAMEDESCRIPTIONTYPE
apiType of report requiredString
campaign_idNumber identification of the campaignString
date_iniInitial Date (YYYYmmddHHiiss)String
date_endFinal Date (YYYYmmddHHiiss)String

NAMEDESCRIPTIONTYPE
type_of_rowIndicates the type of dialingString
campaign_idCorresponds to the campaign identification numberString
customer_nameClient’s nameString
customer_last_nameCustomer’s last nameString
resultIt is the result of the interactionString
last_code_actIndicates the coding of the last call to the client.String
comments_customer_regThese are customer comments recorded in the preview calls.String
customer_idCorresponds to the customer’s identification numberString
agent_idRefers to the numerical identification of each wolkvox Agent user.String
conn_idCorresponds to the call identification numberString
telephoneIndicates the phone number to which the call was madeString
hang_upIndicates who ended the interactionString
type_interactionIndicates the type of call, can be inbound or outboundString
call_resultRefers to the result of the callString
dateIndicates the date in year-month -day-time formatString
timeIndicates the duration of the callString
cod_actThis is the ID of the typing or coding code used by the agent.String
commentsThese are the agent’s comments on preview callsString

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_5&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "type_of_row": "",
            "campaign_id": "",
            "customer_name": "",
            "customer_last_name": "",
            "result": "",
            "last_code_act": "",
            "comments_customer_reg": "",
            "customer_id": "",
            "agent_id": "",
            "conn_id": "",
            "telephone": "",
            "hang_up": "",
            "type_interaction": "",
            "call_result": "",
            "date": "",
            "time": "",
            "cod_act": "",
            "comments": ""
        }
    ]
}

				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data