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

< / >

APIs Reports Manager

9. Mailing details

URL:

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

Description:

This report allows to consult the detail of the emails sent through the “Send email” component in routing points and through strategies in campaigns.

Benefit:

Get detailed information about sent emails, including dates and time of sending, recipients and other important information to perform monitoring and tracking of sent emails by consuming an API.

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
code Response code. Int
error Name of agent. String
msg Number of messages found.  String
channel Displays the routing point (email-route-xxxxx) or campaign (campaign-xxxxx) through which the email was sent. String
date Date of shipment. String
from Indicates the sender’s e-mail address. String
to Indicates the recipient’s e-mail address. String
subject It refers to the subject of the email. String
body Refers to the body of the email. 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?date_ini={{date_ini}}&date_end={{date_end}}&api=cdr_9',
  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: {{wolkvox_token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": " ",
    "error":  ,
    "msg": " ",
    "data": [
        {
            "channel": " ",
            "date": " ",
            "from": " ",
            "to": " ",
            "subject": " ",
            "body": " "
        }
    ]
}
				
			
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