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

URL:

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

Description:

This report allows to know in depth the management of the chat channels attended by human agents, detailing the details of the chat (chat ID, date, duration, coding, skill and channel), of the customer (ID, name, email, phone, characters sent), the agent (ID, name, characters sent) and efficiency meters (ASA and Last Participant).

Benefit:

Provides a complete view of the nonautomated chat interaction between customer and advisor.

How it works:

REQUEST

REQUEST
NAMEDESCRIPTIONTYPE
apiType of report requiredString
date_iniInitial Date (YYYYmmddHHiiss)String
date_endFinal Date (YYYYmmddHHiiss)String
agent_dniAgent’s IDString

RESPONSE

RESPONSE
NAMEDESCRIPTIONTYPE
conn_idCorresponds to the chat identification number.String
channelRefers to the channel used in the interaction.String
dateIndicates the date with yearmonthdayhour format.String
customer_nameCustomer name.String
customer_emailIt is the customer‘s email.String
customer_phoneIt is the customer‘s phone.String
customer_charsIndicates the numerical amount of characters typed by the customer.String
agent_idRefers to the numerical identification of each of the Wolkvox Agents.String
agent_nameAgent name.String
agent_charsIndicates the numerical amount of characters typed by the agentString
time_on_agentIndicates the time the agent used in the attention.String
chat_durationIndicates interaction duration in seconds.String
cod_actIt is the ID of the typification or coding used by the agent.String
description_cod_actIndicates the description of the typification code.String
commentsComment type text of the interaction.String
customer_idCorresponds to the identification number of the customer.String
skill_idIt is the numerical identification of the skill group.String
ASAThe time that passes from when the chat is initiated by the customer and answered by the advisor.String
last_participant_who_spokeIndicates the last participant who interacted.String
extra_fieldAdditional field to save information.String
commentComment type text of the interaction.String
user_idUser identification.String
feelingRecognized feeling.String
agent_anwersNumber of times the agent writes to the customer.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=chat_1&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": [
        {
            "conn_id": "",
            "channel": "",
            "date": "",
            "customer_name": "",
            "customer_email": "",
            "customer_phone": "",
            "customer_chars": "",
            "agent_id": "",
            "agent_name": "",
            "agent_chars": "",
            "time_on_agent": "",
            "chat_duration": "",
            "cod_act": "",
            "description_cod_act": "",
            "comments": "test",
            "customer_id": "",
            "skill_id": "",
            "ASA": "",
            "last_participant_who_spoke": "",
            "extra_field": "",
            "comment": "",
            "user_id": "",
            "feeling": "",
            "agent_anwers ": ""
        }
    ]
}
				
			

URL:

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

Description:

This report allows to know in depth the management of the chat channels attended by human agents, detailing the details of the chat (chat ID, date, duration, coding, skill and channel), of the customer (ID, name, email, phone, characters sent), the agent (ID, name, characters sent) and efficiency meters (ASA and Last Participant).

Benefit:

Provides a complete view of the nonautomated chat interaction between customer and advisor.

How it works:

REQUEST
NAMEDESCRIPTIONTYPE
apiType of report requiredString
date_iniInitial Date (YYYYmmddHHiiss)String
date_endFinal Date (YYYYmmddHHiiss)String
agent_dniAgent’s IDString

RESPONSE
NAMEDESCRIPTIONTYPE
conn_idCorresponds to the chat identification number.String
channelRefers to the channel used in the interaction.String
dateIndicates the date with yearmonthdayhour format.String
customer_nameCustomer name.String
customer_emailIt is the customer‘s email.String
customer_phoneIt is the customer‘s phone.String
customer_charsIndicates the numerical amount of characters typed by the customer.String
agent_idRefers to the numerical identification of each of the Wolkvox Agents.String
agent_nameAgent name.String
agent_charsIndicates the numerical amount of characters typed by the agentString
time_on_agentIndicates the time the agent used in the attention.String
chat_durationIndicates interaction duration in seconds.String
cod_actIt is the ID of the typification or coding used by the agent.String
description_cod_actIndicates the description of the typification code.String
commentsComment type text of the interaction.String
customer_idCorresponds to the identification number of the customer.String
skill_idIt is the numerical identification of the skill group.String
ASAThe time that passes from when the chat is initiated by the customer and answered by the advisor.String
last_participant_who_spokeIndicates the last participant who interacted.String
extra_fieldAdditional field to save information.String
commentComment type text of the interaction.String
user_idUser identification.String
feelingRecognized feeling.String
agent_anwersNumber of times the agent writes to the customer.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=chat_1&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": [
        {
            "conn_id": "",
            "channel": "",
            "date": "",
            "customer_name": "",
            "customer_email": "",
            "customer_phone": "",
            "customer_chars": "",
            "agent_id": "",
            "agent_name": "",
            "agent_chars": "",
            "time_on_agent": "",
            "chat_duration": "",
            "cod_act": "",
            "description_cod_act": "",
            "comments": "test",
            "customer_id": "",
            "skill_id": "",
            "ASA": "",
            "last_participant_who_spoke": "",
            "extra_field": "",
            "comment": "",
            "user_id": "",
            "feeling": "",
            "agent_anwers ": ""
        }
    ]
}
				
			

< / >

APIs Reports Manager

1. Chats En

URL:

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

Description:

This report allows to know in depth the management of the chat channels attended by human agents, detailing the details of the chat (chat ID, date, duration, coding, skill and channel), of the customer (ID, name, email, phone, characters sent), the agent (ID, name, characters sent) and efficiency meters (ASA and Last Participant).

Benefit:

Provides a complete view of the nonautomated chat interaction between customer and advisor.

How it works:

  • This API is consumed by GET method.
  • To consume this API you must replace in the url {ip_ipdialbox} for the nomenclature of the operation server and the {token} generated from wolkvox Manager to obtain the information securely.
  • 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 track your operation you can make a consumption every 5 minutes of the information.

REQUEST
NAMEDESCRIPTIONTYPE
apiType of report requiredString
date_iniInitial Date (YYYYmmddHHiiss)String
date_endFinal Date (YYYYmmddHHiiss)String
agent_dniAgent’s IDString

RESPONSE
NAMEDESCRIPTIONTYPE
conn_idCorresponds to the chat identification number.String
channelRefers to the channel used in the interaction.String
dateIndicates the date with yearmonthdayhour format.String
customer_nameCustomer name.String
customer_emailIt is the customer‘s email.String
customer_phoneIt is the customer‘s phone.String
customer_charsIndicates the numerical amount of characters typed by the customer.String
agent_idRefers to the numerical identification of each of the Wolkvox Agents.String
agent_nameAgent name.String
agent_charsIndicates the numerical amount of characters typed by the agentString
time_on_agentIndicates the time the agent used in the attention.String
chat_durationIndicates interaction duration in seconds.String
cod_actIt is the ID of the typification or coding used by the agent.String
description_cod_actIndicates the description of the typification code.String
commentsComment type text of the interaction.String
customer_idCorresponds to the identification number of the customer.String
skill_idIt is the numerical identification of the skill group.String
ASAThe time that passes from when the chat is initiated by the customer and answered by the advisor.String
last_participant_who_spokeIndicates the last participant who interacted.String
extra_fieldAdditional field to save information.String
commentComment type text of the interaction.String
user_idUser identification.String
feelingRecognized feeling.String
agent_anwersNumber of times the agent writes to the customer.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=chat_1&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": [
        {
            "conn_id": "",
            "channel": "",
            "date": "",
            "customer_name": "",
            "customer_email": "",
            "customer_phone": "",
            "customer_chars": "",
            "agent_id": "",
            "agent_name": "",
            "agent_chars": "",
            "time_on_agent": "",
            "chat_duration": "",
            "cod_act": "",
            "description_cod_act": "",
            "comments": "test",
            "customer_id": "",
            "skill_id": "",
            "ASA": "",
            "last_participant_who_spoke": "",
            "extra_field": "",
            "comment": "",
            "user_id": "",
            "feeling": "",
            "agent_anwers ": ""
        }
    ]
}
				
			
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