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

< / >

APIs Campaign

6. Request campaign details

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=detail&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

Description:

Get detailed information about both predictive/progressive and preview campaigns. This data includes crucial insights for monitoring and tracking each campaign through the obtained history. It can be used to enhance the effectiveness of campaigns and deliver better service to customers.

Benefit:

It provides detailed and comprehensive access to campaign information, covering both predictive/progressive and preview campaigns. This resource offers crucial data for the thorough monitoring and tracking of each campaign, through the analysis of accumulated history. This information emerges as an invaluable tool to enhance the effectiveness of campaigns, enabling the delivery of an even more effective and personalized service to customers.

How it works:

  • 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.
  • Replace {{type_campaign}} in the URL with the campaign type assigned to the campaign from which you want to retrieve detailed information. It can take the value “predictive” or “preview”.
  • Replace {{campaign_id}} in the URL with the campaign identification code.
  • Replace {{YYYYmmddHHiiss}} in the URL with the start date (date_ini) and end date (date_end) in the format “YearMonthDayHourMinuteSecond”.

REQUEST

NAME DESCRIPTION TYPE
type_campaign (URL) Type of campaign String
campaign_id (URL) Refers to the numerical identification of the campaign. String
date_ini (URL) Initial Date (YYYYmmddHHiiss) String
date_end (URL) Final Date (YYYYmmddHHiiss) String

RESPONSE

NAME DESCRIPTION TYPE
customer_name Client’s name String
customer_last_name Customer’s last name String
id_type Type of identification String
customer_id Customer identification number String
age Age String
gender Gender String
country Country of residence String
state State of residence String
city City of residence String
zone Area of residence String
address Residence address String
opt# Additional field where you enter additional campaign information String
tel# Phone number (preview 3 tel# / predictive 10 tel#) String
tel_extra Extra phone String
agent_id Refers to the numerical identification of each wolkvox Agent user. String
date Indicates the date in year-month-day-time format String
calls Indicates the number of calls made String
conn_id Corresponds to the call identification number String
recall Recall date String
result It is the result obtained after the call to this contact. String
cod_act It is the ID of the typing code or coding used by the agent for a general task. String
cod_act_2 It is the ID of the typing or coding code used by the agent for a specific task. String
recall_count Indicates the number of recall calls String
comments Comments String

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=detail&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  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": "200",
    "error": null,
    "msg": "x records were found",
    "data": [
        {
            "customer_name": "",
            "customer_last_name": "",
            "id_type": "",
            "customer_id": "",
            "gender": "",
            "country": "",
            "state": "",
            "city": "",
            "zone": "",
            "address": "",
            "opt1": "",
            "opt2": "",
            "opt3": "",
            "opt4": "",
            "opt5": "",
            "opt6": "",
            "opt7": "",
            "opt8": "",
            "opt9": "",
            "opt10": "",
            "opt11": "",
            "opt12": "",
            "tel1": "",
            "tel2": "",
            "tel3": "",
            "tel4": "",
            "tel5": "",
            "tel6": "",
            "tel7": "",
            "tel8": "",
            "tel9": "",
            "tel10": "",
            "tel_extra": "",
            "agent_id": "",
            "date": "",
            "calls": "",
            "conn_id": "",
            "recall": "",
            "result": "",
            "cod_act": "",
            "cod_act_2": "",
            "recall_count": "",
            "comments": ""
        }
    ]
}
				
			
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