12. Search Campaign Registration En - Wolkvox

< / >

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.
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

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

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

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_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --globoff '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}}' \
--header 'wolkvox_server: {{wolkvox_server}}' \
--header 'wolkvox-token: {{wolkvox-token}}' \
--data ''

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .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}}")
  .method("GET", body)
  .addHeader("wolkvox_server", "{{wolkvox_server}}")
  .addHeader("wolkvox-token", "{{wolkvox-token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

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}}"

payload = ""
headers = {
  'wolkvox_server': '{{wolkvox_server}}',
  'wolkvox-token': '{{wolkvox-token}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

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": ""
        }
    ]
}

wolkvox
worldwide

UNITED STATES

Atlanta, GA +1 (470) 447-2610
Miami, FL +1 (470) 447-2610

ARGENTINA

Buenos Aires +54 (11) 5217 5933

BRAZIL

Sao Paulo +55 (11) 521 75 933

CHILE

Santiago de Chile +56 (2) 240 533 89

SPAIN

Madrid +34 (910) 601 691

COLOMBIA

Medellín +57 (604) 322 98 80

GUATEMALA

Ciudad de Guatemala +502 (2) 3141344

MEXICO

Ciudad de México +52 (55) 8526 36 34

DOMINICAN REPUBLIC

Santo Domingo +1 (829) 249 69 68

PERU

Lima +51 (1) 644 91 39

|

Information security policy

|

|

Information Transfer Policies

Copyright © 2023 MICROSYSLABS. 1820 N Corporate Lakes Blvd, unit 205. Weston, FL 33326

Nosotros

OMNICHANNEL PLATFORM

CHATBOTS AND VOICEBOTS

wolkvox worldwide

COLOMBIA
Medellín +57 (4) 322 98 80
Bogotá +57 (1) 381 90 40
Cali +57 (2) 891 28 46
Barranquilla +57 (5) 316 10 34

ARGENTINA
Buenos Aires +54 (11) 5217 5933

SPAIN
Madrid +34 (910) 601 691

MEXICO
Ciudad de México +52 (55) 8526 36 34

BRASIL
Brasilia +55 (61) 9836 4127
São Paulo +55 (12) 9811 155 83

UNITED STATES
New York +1 (914) 373 71 36

DOMINICAN REPUBLIC
Santo Domingo +1 (829) 249 69 68

CHILE
Santiago de Chile +56 (2) 240 533 89

GUATEMALA
Ciudad de Guatemala +502 (2) 314 1344

PERU
Lima +51 (1) 644 91 39

Information security policy

Information Transfer Policies

Copyright © 2023 MICROSYSLABS S.A.S.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia