fbpx

< / >

APIs Interacciones y Chats

14. WhatsApp click detail

URL:

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

 

Description:

This API allows you to retrieve detailed information for each individual interaction in the “WhatsApp Click Detail” report. It provides essential data about interactions generated from ads or posts, making it easier to analyze and optimize campaigns.

 

Benefits:

  • Detailed Analysis: Enables in-depth analysis of each interaction, helping identify patterns and areas for improvement.
  • Campaign Optimization: Facilitates campaign optimization by providing specific performance data for each ad or post.
  • Easy Integration: The API can be easily integrated with other analytics and reporting tools, enhancing operational efficiency.
  • 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 of your operation.
  • You must include the header wolkvox-token: {{token}} to authenticate using your authorization token.
  • Replace {{date_ini}} with the start date and time of the query (format: YYYYMMDDHHMMSS, e.g., 20250201000000).
  • Replace {{date_end}} with the end date and time of the query (format: YYYYMMDDHHMMSS, e.g., 20250228235959).
  • Keep in mind that a single token cannot be used for simultaneous requests. You should schedule the next API call only after the previous one returns a successful result.
  • For operational tracking, you may request the data every 5 minutes.

 

API Limits:

  • Max records per request (download): 60,000
  • Max records per request (upload): 10,000
  • Date range limit: 31 days
  • Response size limit: 256 MB
  • Timeout limit: 60 seconds
  • Simultaneous requests per token: 2
  • Daily token usage limit: Number of licenses × 1,000 daily tokens

 

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

NAME DESCRIPTION TYPE
api Type of report required. String
date_ini Start date (YYYYmmddHHiiss). String
date_end End date (YYYYmmddHHiiss). String

Response

NAME DESCRIPTION TYPE
code Response status code. String
error Detailed information about any error that may have occurred during the API execution. String
msg Informational message describing the response. String
data Array containing the details of chats closed by channel. String
source_url URL of the ad or post that originated the interaction. String
source_type URL of the ad or post that originated the interaction. (Note: repeated line — should it be included once?) String
source_id Unique identifier of the ad or post. String
chat_id Unique identifier of the chat. String
rp_id Routing point where the interaction entered. String
agent_id Identifier of the agent who received the interaction. String
media_type Type of media in the ad (image or video). String
media_url Link to the image or video used in the ad. String
date Exact date and time the interaction was generated. String
cod_act Activity code used to classify the final result of the interaction recorded in wolkvox. 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_14&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": [
        {
            "source_url": "",
            "source_type": "",
            "source_id": "",
            "chat_id": "",
            "rp_id": "",
            "agent_id": "",
            "media_type": "",
            "media_url": "",
            "date": "",
            "cod_act": ""
        }
    ]
}
				
			

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