WHY WOLKVOX? OMNICHANNEL PLATFORM WOLKVOX CRM CHATBOTS AND VOICEBOTS MANUALS

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

7. NLP Detail

< / >

APIs Reports Manager

7. NLP Detail

URL:

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

Description:

This report delivers in detail a report about the use of NLP or artificial intelligence components in your operation.

Benefit:

With this report you can know in detail your use 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 operation’s server nomenclature 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 type of NLP 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 (AI-powered intentions component). – nlp-text-sentiment (sentiment analysis in chat channels). – nlp-voc-general (customer voice analysis with 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 fails to identify the NLP type).	String
nlp channel	Displays the type of channel through which the activity originated. The value obtained depends on the result obtained in the “type_nlp” field: – “chat-web”, “chat-whatsapp”, and “voice” for the result nlp-voc-autoqua. – “configurationbox-bot:RoutingPointID-ani:CustomerNumber”, “instagram-bot:RoutingPointID-ani:”, “facebook-bot:RoutingPointID-ani:”, “web-bot:RoutingPointID-ani:CustomerNumber”, “whatsapp-bot:RoutingPointID-ani:ANI Obtained” and “unknown” for the unknown result. – “idagent:AgentID” for the results nlp-MrWizard-, nlp-MrWizard-chat, and nlp-MrWizard-voice. – “keywords-chat-chat_id:ChatID” for the result nlp-text-keywords. – “keywords-voice-idcall:CallID” for the result nlp-voice-keywords. – “sentiment-chat-chatid:ChatID” for the result nlp-text-sentiment. – “sentiment-voice-idcall:CallID” for the result nlp-voice-sentiment. – “summary-chat-chatid:ChatID” for the result nlp-text-summary. – “summary-voice-idcall:CallID” for the result nlp-voice-summary. – “Test-QAutoQAiBot” for the result nlp-voc-autoqa-test. – “voc-id:VocID” for the result nlp-voc-general. – “voice” for nlp-MrWizard-rtvoice.	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
date nlp	Displays the date on which the record occurred.	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_7&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_7&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_7&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_7&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 channel": " ",
            "chars send": " ",
            "chars answer": " ",
            "total chars": " ",
            "date nlp": " "
        }
    ]
}

APPLICATIONS

MULTICHANNEL DIALER

WOLKVOX STUDIO

ARTIFICIAL INTELLIGENCE

VOICE OF THE CUSTOMER

QUALITY AND PRODUCTIVITY

ANALYTICS

TELEPHONY

INTEGRATIONS

BY INDUSTRY

BY COMPANY TYPE

SMART TEAMS

AUTOMATION AND ARTIFICIAL INTELLIGENCE

DIGITAL TRANSFORMATION

APPLICATIONS

MULTICHANNEL DIALER

WOLKVOX STUDIO

ARTIFICIAL INTELLIGENCE

VOICE OF THE CUSTOMER

QUALITY AND PRODUCTIVITY

ANALYTICS

TELEPHONY

INTEGRATIONS

BY INDUSTRY

BY COMPANY TYPE

SMART TEAMS

AUTOMATION AND ARTIFICIAL INTELLIGENCE

DIGITAL TRANSFORMATION

< / >

APIs Reports Manager

7. NLP Detail

Request

Response

RESPONSE

UNITED STATES

ARGENTINA

BRAZIL

CHILE

SPAIN

COLOMBIA

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU

AUTOMATION AND
ARTIFICIAL INTELLIGENCE

AUTOMATION AND
ARTIFICIAL INTELLIGENCE