Search
Close this search box.

< / >

APIs

12. Interactions sent by agent En

URL:

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

Description:

This report allows you to consult the outbound interactions carried out by the agent via email, specifying the main characteristics of the message (sender, sender, subject, email body and date).

Benefit:

This report allows to identify the number of interactions carried out by the agent, in order to identify its main characteristics and perform its respective traceability.

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 Refers to the numeric ID that is assigned to each of the wolkvox agent users String
agent_id Refers to the numeric ID that is assigned to each of the wolkvox agent users String
agent_name Agent name String
channel Interaction Channel. This column only yields the value “email”. String
from indicates the sender’s email String
to indicates the recipient’s email String
subject Details the subject of the interaction String
body Refers to the body of the message String
date Indicates the date and time of creation of the interaction String
cod_act Typing code String
description_cod_act Description of the typing code 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_12&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_id": "",
            "agent_name": "",
            "channel": "",
            "from": "",
            "to": "",
            "subject": "",
            "body": "",
            "date": ""
        }
    ]
}
				
			
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