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

< / >

APIs Reports Manager

9. Status of records in WhatsApp campaigns

URL: https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_9&campaign_id=all&date_ini={{date_ini}}&date_end={{date_end}}

Description:

With this API, you will be able to obtain the report of the status of each record added to your WhatsApp campaign.

Benefit:

Perform a detailed monitoring of WhatsApp campaigns.

How it works:

  • The consumption of this API is done via 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 header to utilize the authorization token.
  • Please note that the same token cannot be consumed simultaneously, so you can schedule the next API consumption after the successful completion of the previous one.
  • In terms of timing, for operational tracking, you can consume the information every 5 minutes.
  • 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

NAMEDESCRIPTIONTYPE
apiType of report required.String
campaign_idNumeric identification of the campaign. It can receive the value “all” to obtain the report of all campaigns of the operation.String
date_iniStart date (YYYYmmddHHiiss).String
date_endEnd date (YYYYmmddHHiiss).String

Response

NAMEDESCRIPTIONTYPE
campaign_idCampaign identification number.String
telephoneCustomer’s phone number.String
statusRecord status. It can yield the values “accepted,” “delivered,” “submitted,” and “failed”String
errorsErrors encountered when trying to contact the record.String
dateDate and time when the record was contacted.String
last_updateLast date the record was contacted.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=campaign_9&campaign_id=all&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": "1 records were found",
    "data": [
        {
            "campaing_id": "",
            "telephone": "",
            "status": "",
            "errors": "",
            "date": "",
            "last_update": ""
        }
    ]
}

				
			
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