Search
Close this search box.

< / >

APIs Reports Manager

2. Conversations

URL:

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

Description:

This report shows the content of the chat conversations managed by the advisors, indicating specifically the messages shared during the service, the date of the conversation and the identification of the client and advisor.

Benefit:

By knowing the content of the messages shared by customers, you can verify if the chat service is aligned with the quality standards of the operation, if you obtained a response on first contact and identify for which procedures customers prefer chat channels.

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.
  • 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 Type of report required String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

Response

NAME DESCRIPTION TYPE
conn_id Corresponds to the call identification number. String
agent_name Name of the agent. String
customer_name Name of the customer. String
channel Indicates the contact channel of the interaction. This column can yield one of the following values: Facebook, Instagram, web, and WhatsApp. String
from Indicates the sender of the message, which can be either AGENT (agent) or CUSTOMER (customer). String
from_name Indicates the name of the sender. String
to_name Indicates the name of the message recipient. It can display “chat bot” when a message from a customer has been sent to a chat bot. String
date Indicates the date in year-month-day-time format. String
message Details the messages sent and received by the agent and customer. String
customer_id Corresponds to the customer identification number. String
customer_phone Customer’s phone number. 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_2&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": [
        {
            "conn_id": "",
            "agent_name": "",
            "customer_name": "",
            "conversation": [
                {
                    "channel": "",
                    "from": "",
                    "from_name": "",
                    "to_name": "",
                    "date": "",
                    "message": "",
                    "customer_id": "",
                    "feeling": ""
                    "customer_phone": ""
                }
            ]
        }
    ]
}
				
			
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