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

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=find_record&campaign_id={{campaign_id}}&customer_phone={{customer_phone}}&customer_id={{customer_id}}

Description:

This API allows you to search for customer records in your Wolkvox campaigns for integrations and automations in your additional services.

Benefit: This report allows you to know by means of a client’s ID or telephone number, if he/she is in a specific campaign or in all campaigns.

Type of request: GET

How it works:

REQUEST

NAMEDESCRIPTIONTYPE
apiType of report requiredString
campaign_idIdentifies the campaign numberString
customer_phoneRefers to the customer phoneString
customer_idCorresponds to the customer identification numberString

RESPONSE

NAMEDESCRIPTIONTYPE
customer_nameCustomer’s first nameString
customer_last_nameLast name of the customerString
customer_idCorresponds to the customer identification numberString
opt#Additional field to enter additional campaign information (preview / predictive)String
tel1Phone number 1String
tel2Phone number 2String
tel3Phone number 3String
dateIndicates the date with format year-month-day-timeString
callsIndicates the number of calls (inbound, outbound and internal)String
conn_idCorresponds to the identification number of the callString
resultIs the result of the interactionString
campaign_idNumber identification of the campaignString

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=find_record&campaign_id={{campaign_id}}&customer_phone={{customer_phone}}&customer_id={{customer_id}}',
  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": "1 records were found",
    "data": [
        {
            "customer_name": "",
            "customer_last_name": "",
            "customer_id": "",
            "opt1": "",
            "opt2": "",
            "opt3": "",
            "opt4": "",
            "opt5": "",
            "opt6": "",
            "opt7": "",
            "opt8": "",
            "opt9": "",
            "opt10": "",
            "opt11": "",
            "opt12": "",
            "tel1": "",
            "tel2": "",
            "tel3": "",
            "date": "",
            "calls": "",
            "conn_id": "",
            "result": "",
            "campaign_id": ""
        }
    ]
}
				
			

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=find_record&campaign_id={{campaign_id}}&customer_phone={{customer_phone}}&customer_id={{customer_id}}

Description:

This API allows you to search for customer records in your Wolkvox campaigns for integrations and automations in your additional services.

Benefit: This report allows you to know by means of a client’s ID or telephone number, if he/she is in a specific campaign or in all campaigns.

Type of request: GET

How it works:

NAMEDESCRIPTIONTYPE
apiType of report requiredString
campaign_idIdentifies the campaign numberString
customer_phoneRefers to the customer phoneString
customer_idCorresponds to the customer identification numberString

NAMEDESCRIPTIONTYPE
customer_nameCustomer’s first nameString
customer_last_nameLast name of the customerString
customer_idCorresponds to the customer identification numberString
opt#Additional field to enter additional campaign information (preview / predictive)String
tel1Phone number 1String
tel2Phone number 2String
tel3Phone number 3String
dateIndicates the date with format year-month-day-timeString
callsIndicates the number of calls (inbound, outbound and internal)String
conn_idCorresponds to the identification number of the callString
resultIs the result of the interactionString
campaign_idNumber identification of the campaignString

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=find_record&campaign_id={{campaign_id}}&customer_phone={{customer_phone}}&customer_id={{customer_id}}',
  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": "1 records were found",
    "data": [
        {
            "customer_name": "",
            "customer_last_name": "",
            "customer_id": "",
            "opt1": "",
            "opt2": "",
            "opt3": "",
            "opt4": "",
            "opt5": "",
            "opt6": "",
            "opt7": "",
            "opt8": "",
            "opt9": "",
            "opt10": "",
            "opt11": "",
            "opt12": "",
            "tel1": "",
            "tel2": "",
            "tel3": "",
            "date": "",
            "calls": "",
            "conn_id": "",
            "result": "",
            "campaign_id": ""
        }
    ]
}
				
			

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=find_record&campaign_id={{campaign_id}}&customer_phone={{customer_phone}}&customer_id={{customer_id}}

Description:

This API allows you to search for customer records in your Wolkvox campaigns for integrations and automations in your additional services.

Benefit: This report allows you to know by means of a client’s ID or telephone number, if he/she is in a specific campaign or in all campaigns.

Type of request: GET

How it works:

NAMEDESCRIPTIONTYPE
apiType of report requiredString
campaign_idIdentifies the campaign numberString
customer_phoneRefers to the customer phoneString
customer_idCorresponds to the customer identification numberString

NAMEDESCRIPTIONTYPE
customer_nameCustomer’s first nameString
customer_last_nameLast name of the customerString
customer_idCorresponds to the customer identification numberString
opt#Additional field to enter additional campaign information (preview / predictive)String
tel1Phone number 1String
tel2Phone number 2String
tel3Phone number 3String
dateIndicates the date with format year-month-day-timeString
callsIndicates the number of calls (inbound, outbound and internal)String
conn_idCorresponds to the identification number of the callString
resultIs the result of the interactionString
campaign_idNumber identification of the campaignString

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=find_record&campaign_id={{campaign_id}}&customer_phone={{customer_phone}}&customer_id={{customer_id}}',
  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": "1 records were found",
    "data": [
        {
            "customer_name": "",
            "customer_last_name": "",
            "customer_id": "",
            "opt1": "",
            "opt2": "",
            "opt3": "",
            "opt4": "",
            "opt5": "",
            "opt6": "",
            "opt7": "",
            "opt8": "",
            "opt9": "",
            "opt10": "",
            "opt11": "",
            "opt12": "",
            "tel1": "",
            "tel2": "",
            "tel3": "",
            "date": "",
            "calls": "",
            "conn_id": "",
            "result": "",
            "campaign_id": ""
        }
    ]
}
				
			

< / >

APIs Campaign

12. Search Campaign Registration En

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=find_record&campaign_id={{campaign_id}}&customer_phone={{customer_phone}}&customer_id={{customer_id}}

Description:

This API allows you to search for customer records in your Wolkvox campaigns for integrations and automations in your additional services.

Benefit: This report allows you to know by means of a client’s ID or telephone number, if he/she is in a specific campaign or in all campaigns.

Type of request: GET

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.

NAMEDESCRIPTIONTYPE
apiType of report requiredString
campaign_idIdentifies the campaign numberString
customer_phoneRefers to the customer phoneString
customer_idCorresponds to the customer identification numberString

NAMEDESCRIPTIONTYPE
customer_nameCustomer’s first nameString
customer_last_nameLast name of the customerString
customer_idCorresponds to the customer identification numberString
opt#Additional field to enter additional campaign information (preview / predictive)String
tel1Phone number 1String
tel2Phone number 2String
tel3Phone number 3String
dateIndicates the date with format year-month-day-timeString
callsIndicates the number of calls (inbound, outbound and internal)String
conn_idCorresponds to the identification number of the callString
resultIs the result of the interactionString
campaign_idNumber identification of the campaignString

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=find_record&campaign_id={{campaign_id}}&customer_phone={{customer_phone}}&customer_id={{customer_id}}',
  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": "1 records were found",
    "data": [
        {
            "customer_name": "",
            "customer_last_name": "",
            "customer_id": "",
            "opt1": "",
            "opt2": "",
            "opt3": "",
            "opt4": "",
            "opt5": "",
            "opt6": "",
            "opt7": "",
            "opt8": "",
            "opt9": "",
            "opt10": "",
            "opt11": "",
            "opt12": "",
            "tel1": "",
            "tel2": "",
            "tel3": "",
            "date": "",
            "calls": "",
            "conn_id": "",
            "result": "",
            "campaign_id": ""
        }
    ]
}
				
			
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