Search
Close this search box.

< / >

APIs

13. Closed chats by Channel

URL:

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

Description:

This report allows you to query the chats that have been closed in each chat channel used in your operation.

Benefit:

By consulting this report, users can gain a clear and specific insight into the performance of each channel, which can be valuable for the analysis and continuous improvement of customer service. This type of information can help identify patterns, assess the effectiveness of each channel, and make informed decisions to optimize chat management and user experience.

How it works?

  • The consumption of this API is done using the GET method.
  • To consume this API, you must replace {{wolkvox_server}} in the URL with the nomenclature of the operation’s server.
  • The wolkvox-token header: {{token}} must be used to use the authorization token.
  • Please note that the same token cannot be consumed simultaneously, so you can schedule the next API consumption when the result of the previous one is successful.
  • In terms of timing, to monitor your operation, you can consume the information every 5 minutes.
  • 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 required report. String
date_ini Start date (YYYYmmddHHiiss). String
date_end End date (YYYYmmddHHiiss). String

Response

NAME DESCRIPTION TYPE
code Response status code. String
error Detailed information about any error that may have occurred during the API execution. String
msg Informative message describing the response. String
data Array containing details of closed chats by channel. String
channel Name of the chat channel. Can yield the values: ‘facebook’, ‘instagram’, ‘web’, or ‘whatsapp’. String
interaction Number of interactions or closed chats in the corresponding channel. String
Possible error codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=chat_13&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": "x records were found",
    "data": [
        {
            "chanel": "facebook",
            "interaction": ""
        },
        {
            "chanel": "instagram",
            "interaction": ""
        },
        {
            "chanel": "web",
            "interaction": ""
        },
        {
            "chanel": "whatsapp",
            "interaction": ""
        }
    ]
}
				
			
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