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

URL:

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

Description:

This API allows you to access the usage history of the “Final Menu Option” component. Remember that the “Menu Option” component is used in routing points of type “voice” and “chat” to track which options the user is navigating through in the flow. You can also track which options the user is navigating through.

Benefit:

This API provides valuable information about user interactions and helps optimize the customer experience.

How it works:

REQUEST

NAMEDESCRIPTIONTYPE
apiType of required report.String
date_iniStart Date (YYYYmmddHHiiss)String
date_endEnd Date (YYYYmmddHHiiss)String

RESPONSE

NAMEDESCRIPTIONTYPE
codeResponse Status Code.Int
errorIndicates whether there was any kind of error during the execution of the request.String
msgProvides a descriptive message about the result of the request.String
dataIt is the set of data obtained after a successful request.String
rp_idRouting Point Identifier.String
conn_idInteraction Identifier.String
customer_idCustomer Identification Number.String
channelChannel through which the interaction took place. It can yield the values “voice”, “chat-web”, “chat-whatsapp”, “chat-facebook”, or “chat-telegram”.String
telephoneCustomer’s phone number.String
attemptNumber of attempts made in the routing point.String
dateInteraction date.String
second_eventThis is the second in which the indicated menu option was accessed.String
cod_opc_menuSelected menu option.String

Possible error codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=diagram_13&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  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: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "1172 records were found",
    "data": [
        {
            "rp_id": "",
            "conn_id": "",
            "customer_id": "",
            "channel": "",
            "attempt": "",
            "telephone": "",
            "date": "",
            "second_event": "",
            "cod_opc_menu": ""
        }
    ]
}
				
			

URL:

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

Description:

This API allows you to access the usage history of the “Final Menu Option” component. Remember that the “Menu Option” component is used in routing points of type “voice” and “chat” to track which options the user is navigating through in the flow. You can also track which options the user is navigating through.

Benefit:

This API provides valuable information about user interactions and helps optimize the customer experience.

How it works:

NAMEDESCRIPTIONTYPE
apiType of required report.String
date_iniStart Date (YYYYmmddHHiiss)String
date_endEnd Date (YYYYmmddHHiiss)String

NAMEDESCRIPTIONTYPE
codeResponse Status Code.Int
errorIndicates whether there was any kind of error during the execution of the request.String
msgProvides a descriptive message about the result of the request.String
dataIt is the set of data obtained after a successful request.String
rp_idRouting Point Identifier.String
conn_idInteraction Identifier.String
customer_idCustomer Identification Number.String
channelChannel through which the interaction took place. It can yield the values “voice”, “chat-web”, “chat-whatsapp”, “chat-facebook”, or “chat-telegram”.String
telephoneCustomer’s phone number.String
attemptNumber of attempts made in the routing point.String
dateInteraction date.String
second_eventThis is the second in which the indicated menu option was accessed.String
cod_opc_menuSelected menu option.String

Possible error codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=diagram_13&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  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: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "1172 records were found",
    "data": [
        {
            "rp_id": "",
            "conn_id": "",
            "customer_id": "",
            "channel": "",
            "attempt": "",
            "telephone": "",
            "date": "",
            "second_event": "",
            "cod_opc_menu": ""
        }
    ]
}
				
			

URL:

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

Description:

This API allows you to access the usage history of the “Final Menu Option” component. Remember that the “Menu Option” component is used in routing points of type “voice” and “chat” to track which options the user is navigating through in the flow. You can also track which options the user is navigating through.

Benefit:

This API provides valuable information about user interactions and helps optimize the customer experience.

How it works:

NAMEDESCRIPTIONTYPE
apiType of required report.String
date_iniStart Date (YYYYmmddHHiiss)String
date_endEnd Date (YYYYmmddHHiiss)String

NAMEDESCRIPTIONTYPE
codeResponse Status Code.Int
errorIndicates whether there was any kind of error during the execution of the request.String
msgProvides a descriptive message about the result of the request.String
dataIt is the set of data obtained after a successful request.String
rp_idRouting Point Identifier.String
conn_idInteraction Identifier.String
customer_idCustomer Identification Number.String
channelChannel through which the interaction took place. It can yield the values “voice”, “chat-web”, “chat-whatsapp”, “chat-facebook”, or “chat-telegram”.String
telephoneCustomer’s phone number.String
attemptNumber of attempts made in the routing point.String
dateInteraction date.String
second_eventThis is the second in which the indicated menu option was accessed.String
cod_opc_menuSelected menu option.String

Possible error codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=diagram_13&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  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: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "1172 records were found",
    "data": [
        {
            "rp_id": "",
            "conn_id": "",
            "customer_id": "",
            "channel": "",
            "attempt": "",
            "telephone": "",
            "date": "",
            "second_event": "",
            "cod_opc_menu": ""
        }
    ]
}
				
			

< / >

APIs

13. CDR Menu options

URL:

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

Description:

This API allows you to access the usage history of the “Final Menu Option” component. Remember that the “Menu Option” component is used in routing points of type “voice” and “chat” to track which options the user is navigating through in the flow. You can also track which options the user is navigating through.

Benefit:

This API provides valuable information about user interactions and helps optimize the customer experience.

How it works:

  • The consumption of this API is done through the GET method.
  • To consume this API, you must replace {{wolkvox_server}} in the URL with the operation’s server nomenclature.
  • You must use the `wolkvox-token` header to make use of the authorization token.
  • Please note that the same token cannot be consumed simultaneously. Therefore, you can schedule the next API to be consumed when the result of the previous one is successful.
  • In terms of time, for monitoring your operation, you can make a request for information every 5 minutes.

NAMEDESCRIPTIONTYPE
apiType of required report.String
date_iniStart Date (YYYYmmddHHiiss)String
date_endEnd Date (YYYYmmddHHiiss)String

NAMEDESCRIPTIONTYPE
codeResponse Status Code.Int
errorIndicates whether there was any kind of error during the execution of the request.String
msgProvides a descriptive message about the result of the request.String
dataIt is the set of data obtained after a successful request.String
rp_idRouting Point Identifier.String
conn_idInteraction Identifier.String
customer_idCustomer Identification Number.String
channelChannel through which the interaction took place. It can yield the values “voice”, “chat-web”, “chat-whatsapp”, “chat-facebook”, or “chat-telegram”.String
telephoneCustomer’s phone number.String
attemptNumber of attempts made in the routing point.String
dateInteraction date.String
second_eventThis is the second in which the indicated menu option was accessed.String
cod_opc_menuSelected menu option.String

Possible error codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=diagram_13&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  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: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "1172 records were found",
    "data": [
        {
            "rp_id": "",
            "conn_id": "",
            "customer_id": "",
            "channel": "",
            "attempt": "",
            "telephone": "",
            "date": "",
            "second_event": "",
            "cod_opc_menu": ""
        }
    ]
}
				
			
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