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

< / >

APIs Reports Manager

4. Detail interactions

URL:

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

Description:

This report allows you to consult the details of the interactions, specifying the information of the message (sender, who manages the attention, message and response), the skill, the date (creation and closing), the agent, evaluation and comments.

Benefit:

Identify the traceability of interaction care through detailed information and assess whether the way the conversation is managed is aligned with the quality attributes of the operation.

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
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

RESPONSE

NAME DESCRIPTION TYPE
channel Indicates the contact channel between the client and the agent. This column can yield one of the following values: Email, facebook_page, instagram, and twitter. String
agent_name Agent’s name String
skill_id It is the numerical identification of the skill group. String
case_id Corresponds to the case identification number String
subject Indicates the email subject for an email-type interaction, or the name of the person who wrote on the Facebook, Instagram, or Twitter wall. String
from Indicates the sender of the message, for emails if it’s an email address, or the ID number and name if it’s a Facebook, Instagram, or Twitter profile. String
to Indicates the recipient of the message, for emails if it’s an email address, or the ID number and name if it’s a Facebook, Instagram, or Twitter profile. String
body Refers to the body of the message String
answer Refers to the response the sender receives to his message. String
date_creation Indicates the date and time of creation of the message String
close_date Indicates the closing date of the interaction String
evaluation_survey Indicates the evaluation obtained by the interaction if the survey was answered. String
cod_act This is the ID of the typing or coding code used by the agent. String
cod_description Description of the typification code String
comments Interaction commentary text String
attachments Attachments String
status Indicates the status of the interaction. It can yield the values: open (open interaction), close (closed interaction), and archived (archived interaction). 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_4&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": [
        {
            "channel": "",
            "agent_name": "",
            "skill_id": "",
            "case_id": "",
            "subject": "",
            "from": "",
            "to": "",
            "body": "",
            "answer": "",
            "date_creation": "",
            "close_date": "",
            "evaluation_survey": "",
            "cod_act": "",
            "comments": "",
            "attachments": "",
            "status": ""
        }
    ]
}
				
			
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