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

< / >

APIs Information

4. Campaigns

URL:

https://wv{{wolkvox_server}}wolkvox.com/api/v2/information.php?api=campaigns

Description:

This API provides information about the operation’s campaigns.

Benefit:

It provides basic information on each of the operation’s campaigns.

How it works:

  • The consumption of this API is done by GET method.
  • To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
  • The wolkvox-token header must be used to make use of the authorization token.
  • Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.
  • In terms of time, to keep track of your operation you can make a consumption every 5 minutes of the information.

REQUEST

NAME DESCRIPTION TYPE
api Type of report required String

RESPONSE

NAME DESCRIPTION TYPE
campaign_id Campaign ID. String
campaign_name Campaign name. String
campaign_description Description of the campaign. String
type_campaign Campaign type. It can return either “predictive” or “preview”. String
status Campaign status can return the value “Started” (active) or “Stopped” (inactive). String
records Number of campaign records. String
speed Campaign speed. String
dial_mode Details the dialing mode. It can show the value “autopilot,” “strategy,” and “phone1 – ring: 60(sec).” This last value can change since campaigns have up to 10 phones per record and a ring time that ranges from 10 to 60 seconds, all depending on the configuration in the campaign. String
last_use Date in year-month-day-time format of the last use of the skill. String
recycled Number of recycled records in the campaign. This indicates the quantity of campaign records that have been reused. String
turbo_dial Indicates whether the turbo dial service is active or not in the campaign. 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=campaigns',
  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: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "",
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "campaign_id": "",
            "campaign_name": "",
            "campaign_description": " ",
            "type_campaign": "",
            "status": "",
            "records": "",
            "speed": "",
            "dial_mode": "",
            "last_use": "",
            "recycled": "",
            "turbo_dial": ""
        }
    ]
}
				
			
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