9. Mailing details - Wolkvox

< / >

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.
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
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;

				
					curl --location 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?date_ini={{date_ini}}&date_end={{date_end}}&api=cdr_9' 
--header 'wolkvox-token: {{wolkvox_token}}' 
--data ''

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?date_ini={{date_ini}}&date_end={{date_end}}&api=cdr_9")
  .method("GET", body)
  .addHeader("wolkvox-token", "{{wolkvox_token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

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

payload = ""
headers = {
  'wolkvox-token': '{{wolkvox_token}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

RESPONSE

				
					{
    "code": " ",
    "error":  ,
    "msg": " ",
    "data": [
        {
            "channel": " ",
            "date": " ",
            "from": " ",
            "to": " ",
            "subject": " ",
            "body": " "
        }
    ]
}

wolkvox
worldwide

UNITED STATES

Atlanta, GA +1 (470) 447-2610
Miami, FL +1 (470) 447-2610

ARGENTINA

Buenos Aires +54 (11) 5217 5933

BRAZIL

Sao Paulo +55 (11) 521 75 933

CHILE

Santiago de Chile +56 (2) 240 533 89

SPAIN

Madrid +34 (910) 601 691

COLOMBIA

Medellín +57 (604) 322 98 80

GUATEMALA

Ciudad de Guatemala +502 (2) 3141344

MEXICO

Ciudad de México +52 (55) 8526 36 34

DOMINICAN REPUBLIC

Santo Domingo +1 (829) 249 69 68

PERU

Lima +51 (1) 644 91 39

|

Information security policy

|

|

Information Transfer Policies

Copyright © 2023 MICROSYSLABS. 1820 N Corporate Lakes Blvd, unit 205. Weston, FL 33326

OMNICHANNEL PLATFORM

CHATBOTS AND VOICEBOTS

wolkvox worldwide

COLOMBIA
Medellín +57 (4) 322 98 80
Bogotá +57 (1) 381 90 40
Cali +57 (2) 891 28 46
Barranquilla +57 (5) 316 10 34

ARGENTINA
Buenos Aires +54 (11) 5217 5933

SPAIN
Madrid +34 (910) 601 691

MEXICO
Ciudad de México +52 (55) 8526 36 34

BRASIL
Brasilia +55 (61) 9836 4127
São Paulo +55 (12) 9811 155 83

UNITED STATES
New York +1 (914) 373 71 36

DOMINICAN REPUBLIC
Santo Domingo +1 (829) 249 69 68

CHILE
Santiago de Chile +56 (2) 240 533 89

GUATEMALA
Ciudad de Guatemala +502 (2) 314 1344

PERU
Lima +51 (1) 644 91 39

Information security policy

Information Transfer Policies

Copyright © 2023 MICROSYSLABS S.A.S.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia