2.2 Inserting records in the campaign (preview) En - Wolkvox

< / >

APIs -- seleccione una opción --

2.2 Inserting records in the campaign (preview) En

URL: https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=add_record&type_campaign=preview&campaign_id={{campaign_id}}&campaign_status={{campaign_status}} Description: This API allows you to insert records automatically and remotely or from external platforms, in an existing campaign in wolkvox manager. Benefit: This API is very useful when you have, for example, external forms to capture leads, when the user registers automatically the information will be sent to the campaign and the call or message will be sent as parameterized. How it works:

The consumption of this API is done by POST method.
In the json the parameters are added according to the operation or process to be performed.
To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
The {{type_campaign}} field is replaced by the campaign type.
The {{campaign_id}} is replaced by the campaign ID number.
The {{campaign_status}} field must be replaced by the current status of the campaign.
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.

NAME	DESCRIPTION	TYPE
customer_name	Customer’s first name	String
customer_last_name	Last name of customer	String
id_type	Identification type	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
opt1	Additional field #1 where you can enter additional information of the campaign	String
opt2	Additional field #2 where you can enter additional information of the campaign	String
opt3	Additional field #3 where you can enter additional information of the campaign	String
opt4	Additional field #4 where you can enter additional information of the campaign	String
opt5	Additional field #5 where you can enter additional information of the campaign	String
opt6	Additional field #6 where you can enter additional information of the campaign	String
opt7	Additional field #7 where you can enter additional information of the campaign	String
opt8	Additional field #8 where you can enter additional information of the campaign	String
opt9	Additional field #9 where you can enter additional information of the campaign	String
opt10	Additional field #10 where you can enter additional information of the campaign	String
opt11	Additional field #11 where you can enter additional information of the campaign	String
opt12	Additional field #12 where you can enter additional information of the campaign	String
tel1	First option of telephone number	String
tel2	Second option of telephone number	String
tel3	Third option of telephone number	String
agent_id	This field only appears when consulting preview type campaigns and refers to the extension number of each of the wolkvox users Agent	String

RESPONSE

NAME	DESCRIPTION	TYPE
total_registers	Total de registros añadidos	int

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=add_record&amp;type_campaign=preview&amp;campaign_id={{campaign_id}}&amp;campaign_status={{campaign_status}}',
  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; 'POST',
  CURLOPT_POSTFIELDS =&gt; '[{
            "customer_name": " ",
            "customer_last_name": " ",
            "id_type": " ",
            "customer_id": " ",
            "age": " ",
            "gender": " ",
            "country": " ",
            "state": "",
            "city": "",
            "zone": "",
            "address": "",
            "opt1": "",
            "opt2": "",
            "opt3": "",
            "opt4": "",
            "opt5": "",
            "opt6": "",
            "opt7": "",
            "opt8": "",
            "opt9": "",
            "opt10": "",
            "opt11": "",
            "opt12": "",
            "tel1": " ",
            "tel2": "",
            "tel3": "",
            "agent_id": " "
    
}]',
  CURLOPT_HTTPHEADER =&gt; array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --request POST 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=add_record&amp;type_campaign=preview&amp;campaign_id={{campaign_id}}&amp;campaign_status={{campaign_status}}' 
--header 'wolkvox-token: {{campaign_status}}' 
--data-raw '[{
            "customer_name": " ",
            "customer_last_name": " ",
            "id_type": " ",
            "customer_id": " ",
            "age": " ",
            "gender": " ",
            "country": " ",
            "state": "",
            "city": "",
            "zone": "",
            "address": "",
            "opt1": "",
            "opt2": "",
            "opt3": "",
            "opt4": "",
            "opt5": "",
            "opt6": "",
            "opt7": "",
            "opt8": "",
            "opt9": "",
            "opt10": "",
            "opt11": "",
            "opt12": "",
            "tel1": " ",
            "tel2": "",
            "tel3": "",
            "agent_id": " "
}]'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, '[{
            "customer_name": " ",
            "customer_last_name": " ",
            "id_type": " ",
            "customer_id": " ",
            "age": " ",
            "gender": " ",
            "country": " ",
            "state": "",
            "city": "",
            "zone": "",
            "address": "",
            "opt1": "",
            "opt2": "",
            "opt3": "",
            "opt4": "",
            "opt5": "",
            "opt6": "",
            "opt7": "",
            "opt8": "",
            "opt9": "",
            "opt10": "",
            "opt11": "",
            "opt12": "",
            "tel1": " ",
            "tel2": "",
            "tel3": "",
            "agent_id": " "
    
}]');
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=add_record&amp;type_campaign=preview&amp;campaign_id={{campaign_id}}&amp;campaign_status={{campaign_status}}")
  .method("POST", body)
  .addHeader("wolkvox-token", "{{token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

url = "https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=add_record&amp;type_campaign=preview&amp;campaign_id={{campaign_id}}&amp;campaign_status={{campaign_status}}"

payload = json.dumps([{
            "customer_name": " ",
            "customer_last_name": " ",
            "id_type": " ",
            "customer_id": " ",
            "age": " ",
            "gender": " ",
            "country": " ",
            "state": "",
            "city": "",
            "zone": "",
            "address": "",
            "opt1": "",
            "opt2": "",
            "opt3": "",
            "opt4": "",
            "opt5": "",
            "opt6": "",
            "opt7": "",
            "opt8": "",
            "opt9": "",
            "opt10": "",
            "opt11": "",
            "opt12": "",
            "tel1": " ",
            "tel2": "",
            "tel3": "",
            "agent_id": " "
}])
headers = {
  'wolkvox-token': '{{token}}'
}

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

print(response. Text)

RESPONSE

				
					{
    "code": "201",
    "error": null,
    "msg": "All records has been added successfully",
    "data": [
        {
            "total_registers": " "
        }
    ]
}