Search
Close this search box.

< / >

APIs Customer

1. Agent detail report (agents_detail)

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/customer.php?api=agents_detail&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

Description:

This report delivers a detailed summary of the calls attended by an agent in the operation, allowing to consult the id and type of call, name of the agent, skill and associated campaign; It also presents the destination and the data associated with the customer.

Benefit:

Assess customer satisfaction taking into account the particular performance of the agents that are part of the operation, since by knowing the customer‘s voice you can act in a timely manner.

How it works:

  • This API is consumed by GET method.
  • To consume this API you must replace in the url {{wolkvox_server}} by the nomenclature of the operation server.
  • The wolkvoxtoken header must be used to make use of the authorization token.
  • Keep in mind that the same token cannot be consumed simultaneously, so you can program that the next API is consumed when the result of the previous one is successful.
  • In terms of time, to follow up your operation you can make a consumption every 5 minutes of the information.
  • Limit of records that can be downloaded per consumption: 60,000 records.
  • Limit of records that can be uploaded per consumption: 10,000 records.
  • Limit of days queried in dates: 31 days.
  • Limit of result weight: 256 MB.
  • API consumption time limit: 60 seconds.
  • Concurrent consumption limit of a token: 2 simultaneous requests.
  • Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

NAME DESCRIPTION TYPE
api API required String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date(YYYYmmddHHiiss) String

Response

NAME DESCRIPTION TYPE
operation Indicates the name of the operation String
conn_id Corresponds to the call identification number String
type_call It is the type of call (inbound, outbound and internal) String
date Indicates the date in the format yearmonthdayHour String
agent_id Refers to the numeric identification of each of the Wolkvox Agent users String
agent_name Name of the agent String
skill It is the numeric identification of the skill String
duration Indicates the duration of the interaction in seconds String
cod_act It is the ID of the typification or coding code used by the agent for a general task. It can return the value “TIMEOUTACW” if the operation has active timing for the typing process, and the agent exceeded the time limit to categorize the interaction. String
cod_act_2 It is the ID of the typification or coding code used by the agent for a specific task. It can return the value “TIMEOUTACW” if the operation has active timing for the typing process, and the agent exceeded the time limit to categorize the interaction. String
telephone Indicates the telephone number to which the call was made String
hung_up It shows who hung up the call, whether it was the agent (agent) or the customer (customer). String
comment Text type comment of the interaction String
screecbox It indicates if the interaction is being monitored (yes) or not (no). String
agent_status Details the agent‘s status String
customer_id Corresponds to the customer identification number String
destiny Indicates the destination of the call String
time Indicates the total elapsed time String
campaign_id Refers to the numerical identification of each of the users of the campaign String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/customer.php?api=agents_detail&date_ini={{date_ini}}&date_end={{date_end}}',
  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_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "operation": "",
            "conn_id": "",
            "type_call": "",
            "date": "",
            "agent_id": "",
            "agent_name": "",
            "skill": "",
            "duration": "",
            "cod_act": "",
            "cod_act_2": "",
            "telephone": "",
            "hung_up": "",
            "comment": "",
            "screecbox": "",
            "agent_status": "",
            "customer_id": "",
            "destiny": "",
            "time": "",
            "campaign_id": ""
        }
    ]
}

				
			
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