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

< / >

APIs

14. Retrieve notifications from Wolkvox Manager

URL:

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

Description:

This API allows you to retrieve the text of each notification created using the “wolkvox Notification” component.

Benefit:

Enables process automation, greater transparency, increased integration, and detailed analysis.

How it works:

  • The API is consumed using the GET method.
  • To consume this API, you must replace {{wolkvox_server}} in the URL with the server nomenclature of the operation.
  • You must use the wolkvox-token: {{token}} in the Header to use the authorization token.
  • Please note that the same token cannot be consumed simultaneously, so you can schedule the next API consumption when the result of the previous one is successful.
  • In terms of timing, to monitor your operation, you can consume the information every 5 minutes.

REQUEST

NAMEDESCRIPTIONTYPE
apiType of required report.String
wolkvox-tokenAccess token.String

RESPONSE

NAMEDESCRIPTIONTYPE
codeResponse status code.String
errorError message, if any.String
msgInformative message about the response.String
dataArray of objects containing information about each notification.array
dateDate and time of the notification in the format ‘YYYY-MM-DD HH:MM:SS’String
notificationNotification text.String

Possible response codes
				
					$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "X records were found",
    "data": [
        {
            "date": "",
            "notification": ""
        },
        {
            "date": "",
            "notification": ""
        }
    ]
}
				
			
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