Search
Close this search box.

< / >

APIs Reports Manager

10. Official WhatsApp Billing En

URL:

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

Description:

This report allows you to know the consumption of the WhatsApp Business line service taking into account the chat identification, date, phone and the use of templates. This report does not allow to consult the cost of use.

Benefit:

This report allows you to identify if the interaction is inbound or outbound through the use of HSM templates and verify the Resolution in First Contact through this channel.

How it works:

  • This API consumption is done by GET method.
  • To consume this API you must replace in the url {{wolkvox_server}} by the nomenclature of the operation server.
  • You must use the wolkvoxtoken header to use the authorization token.
  • Keep in mind that the same token cannot be consumed simultaneously, so you can program the next API to be consumed when the result of the previous one is successful.
  • In terms of time, to track 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
destination Country to which WhatsApp is sent String

Response

NAME DESCRIPTION TYPE
conn_id Corresponds to the call identification number String
session_id It displays the following format of information: Customer ID.Operation.Connector ID. String
date Indicates the date in the format yearmonthdayhour String
customer_phone Refers to the customer‘s phone number String
template Indicates if there was use of a template (no/yes) String
destiny  Indicates the destination of the call 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_10&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;

				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "conn_id": "",
            "session_id": "",
            "date": "",
            "customer_phone": "",
            "template": ""
        }
    ]
}
				
			
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