fbpx
Search
Close this search box.
Search
Close this search box.

< / >

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.

REQUEST

NAME DESCRIPTION TYPE
api Type of report required String
campaign_id Number identification of the campaign String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

RESPONSE

NAME DESCRIPTION TYPE
type_of_row It indicates the type of dialing. This column can display the value “preview” (preview campaign call) or “call” (manual call). String
campaign_id Corresponds to the campaign identification number String
customer_name Client’s name String
customer_last_name Customer’s last name String
result Indicates the dialing result. Its values could be, owner answers (rpc) or clean. String
last_code_act Indicates the coding of the last call to the client. String
comments_customer_reg These are customer comments recorded in the preview calls. String
customer_id Corresponds to the customer’s identification number String
agent_id Refers to the numerical identification of each wolkvox Agent user. String
conn_id Corresponds to the call identification number String
telephone Indicates the phone number to which the call was made String
hang_up Indicates who ended the interaction String
type_interaction It is the type of call, and its values could be conference (conference call), inbound (incoming call), internal call (internal call), internal call_inb (incoming internal call), internal call_que (internal call from a queue), out_pre (outbound call in predictive campaign), outbound_ma (manual outbound call), and transfer (transfer call). String
call_result This is the result of the call. It can display the value “answer” to indicate that the call was answered. String
date Indicates the date in year-month -day-time format String
time Indicates the duration of the call String
cod_act This is the ID of the typing or coding code used by the agent. String
comments These are the agent’s comments on preview calls String

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