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

< / >

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.
REQUEST
NAME DESCRIPTION TYPE
api Type of report required String
campaign_id Identifies the campaign number String
customer_phone Refers to the customer phone String
customer_id Corresponds to the customer identification number String
RESPONSE
NAME DESCRIPTION TYPE
customer_name Customer’s first name String
customer_last_name Last name of the customer String
customer_id Corresponds to the customer identification number String
opt# Additional field to enter additional campaign information (preview / predictive) String
tel1 Phone number 1 String
tel2 Phone number 2 String
tel3 Phone number 3 String
date Indicates the date with format year-month-day-time String
calls Indicates the number of calls (inbound, outbound and internal) String
conn_id Corresponds to the identification number of the call String
result Is the result of the interaction String
campaign_id Number identification of the campaign String
Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL =&gt; 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=find_record&amp;campaign_id={{campaign_id}}&amp;customer_phone={{customer_phone}}&amp;customer_id={{customer_id}}',
  CURLOPT_RETURNTRANSFER =&gt; true,
  CURLOPT_ENCODING =&gt; '',
  CURLOPT_MAXREDIRS =&gt; 10,
  CURLOPT_TIMEOUT =&gt; 0,
  CURLOPT_FOLLOWLOCATION =&gt; true,
  CURLOPT_HTTP_VERSION =&gt; CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST =&gt; 'GET',
  CURLOPT_HTTPHEADER =&gt; 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": ""
        }
    ]
}
				
			

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales