fbpx

< / >

APIs Interacciones y Chats

15. WhatsApp click summary

URL:

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

 

Description:

This API provides an overview of interaction performance in the “WhatsApp Click Summary” report. It offers aggregated data on how chats originating from ads and posts are managed, enabling a quick and efficient evaluation of campaign performance.

 

Benefits:

  • Overview: Provides a consolidated view of interaction performance, making it easier to make quick decisions.
  • Operational Efficiency: Quickly identifies areas for improvement in chat handling, whether managed by bots or human agents.
  • Resource Optimization: Helps optimize resource allocation by showing how many chats are handled by bots versus those requiring human intervention.
  • Security: The use of an authorization token ensures that only authorized users can access the data.

 

How it works:

  • This API uses the GET method.
  • To use this API, replace {{wolkvox_server}} in the URL with the server name corresponding to your operation.
  • You must include the header wolkvox-token: {{token}} to authorize the request using your token.
  • Replace {{date_ini}} with the start date and time for the query (format: YYYYMMDDHHMMSS, e.g., 20250201000000).
  • Replace {{date_end}} with the end date and time for the query (format: YYYYMMDDHHMMSS, e.g., 20250228235959).
  • Keep in mind that a single token cannot be used for simultaneous requests. You should program the next API call to execute only after the previous one returns a successful result.
  • For operational tracking, you can request data every 5 minutes.

 

Code Examples:

In our Postman workspace ([click here] to access it), you have access to code examples that facilitate integration with our APIs in different programming languages such as cURL, Python, JavaScript, and more.

This feature is ideal for quick integrations and allows you to adapt the API calls to your system’s programming language.

How to Use the Code Examples:

  1. Navigate to our Postman workspace.
  2. Select the API you want to consult.
  3. Edit the necessary API parameters according to your goals.
  4. In the “Code” tab, select your preferred programming language.
  5. You will get an auto-generated code snippet, ready to use with the parameters and authentication previously configured.

 

Request

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

Response

NAMEDESCRIPTIONTYPE
codeResponse status code.String
errorDetailed information about any error that may have occurred during API execution.String
msgInformational message describing the response.String
dataArray containing the details of chats closed by channel.String
ad_chatbotNumber of chats from ads handled by bots.String
ad_agentsNumber of chats from ads handled by human agents.String
post_chatbotNumber of chats from posts handled by bots.String
post_agentsNumber of chats from posts handled by human agents.String
total_chatbotTotal number of chats handled exclusively by bots.String
total_agentsTotal number of chats that required human agent intervention.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=chat_15&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": [
        {
            "ad_chatbot": "",
            "ad_agents": "",
            "post_chatbot": "",
            "post_agents": "",
            "total_chatbot": "",
            "total_agents": ""
        }
    ]
}
				
			

Usamos cookies, se continuar a navegar assumimos que concorda. Pode ler mais sobre a utilização de cookies nas nossas políticas de privacidade e tratamento de dados pessoais

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