8. NLP grouped by type - Wolkvox

< / >

APIs Reports Manager

8. NLP grouped by type

URL:

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

Description:

This report provides in detail a report about the use of NLP or artificial intelligence components in your operation. This report provides information by component type.

Benefit:

With this report you can know in detail your usage of artificial intelligence components in your operation.

How it works:

The consumption of this API is done by GET method.
To consume this API you must replace in the url {ip_ipdialbox} by the server nomenclature of the operation and the {token} generated from wolkvox Manager to obtain the information in a secure way.
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	Error code.	Int
error	Name of error.	String
msg	Explanation of error.	String
data	Indicates the date in year-month-day-time format.	String
nlp type	Displays the component used in the record. This field can yield the following values: – nlp-MrWizard-rtvoice (real-time analysis by Mr. Wizard in voice channels). – nlp-voice-keywords (keyword analysis in voice channels). – nlp-voice-sentiment (sentiment analysis in voice channels). – nlp-voice-summary (summaries in voice channels). – nlp-MrWizard-voice (Mr. Wizard analysis in voice channels). – nlp-text-keywords (keyword analysis in chat). – nlp-text-summary (summaries in chat channels). – nlp-voc-autoqa (customer voice analysis with Auto QA). – nlp-classifications (intentions component with artificial intelligence). – nlp-text-sentiment (sentiment analysis in chat channels). – nlp-voc-general (customer voice analysis with the General NLP component). – nlp-voc-autoqua-test (customer voice analysis in AutoQAiBot tests). – nlp-MrWizard-chat (Mr. Wizard analysis in chat channels). – nlp-Q&A (NLP Q&A questions and answers component). – unknown (when the system cannot identify the type of NLP).	String
nlp amount	Indicates the number of times the component type was used.	String
chars send	Indicates the number of characters sent.	String
chars answer	Indicates the number of characters received.	String
total chars	This is the column that indicates the total number of characters, i.e., the sum of characters sent plus those received.	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=cdr_8&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;

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

				
					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?api=cdr_8&date_ini={{date_ini}}&date_end={{date_end}}")
  .method("GET", body)
  .addHeader("wolkvox_server", "{{wolkvox_server}}")
  .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?api=cdr_8&date_ini={{date_ini}}&date_end={{date_end}}"

payload = {}
headers = {
  'wolkvox_server': '{{wolkvox_server}}',
  'wolkvox-token': '{{wolkvox-token}}'
}

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

print(response.text)

RESPONSE

				
					{
    "code": " ",
    "error":  ,
    "msg": " ",
    "data": [
        {
            "nlp type": " ",
            "nlp amount": " ",
            "chars send": " ",
            "chars answer": " ",
            "total chars": " "
        }
    ]
}

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

Nosotros

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