2.2 Inserción de registros en la campaña (preview) - Wolkvox

< / >

APIs -- seleccione una opción --

2.2 Inserción de registros en la campaña (preview)

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

Descripción:

Esta API permite insertar registros de forma automática y de manera remota o desde plataformas externas, en una campaña existente en wolkvox manager.

Beneficio:

Esta API es de gran utilidad cuando se tienen por ejemplo formularios externos de captación de leads, al usuario registrarse automática se enviará la información a la campaña y se hará la llamada o envío de mensaje según se tenga parametrizado.

Cómo funciona:

El consumo de esta API se realiza por método POST.
En el json se agregan los parámetros de acuerdo a la operación o proceso a realizar.
Para consumir esta API debe reemplazar en la url {{wolkvox_server}} por la nomenclatura del servidor de la operación.
El campo {{type_campaign}} se reemplaza por el tipo de campaña.
Se reemplaza {{campaign_id}} por el número de identificación de la campaña.
El campo {{campaign_status}} debe reemplazarse por el estado actual de la campaña.
Se debe hacer uso del header wolkvox-token para hacer uso de el token de autorización.
Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.

NAME	DESCRIPTION	TYPE
customer_name	Nombre del cliente	String
customer_last_name	Apellido del cliente	String
id_type	Tipo de identificación	String
customer_id	Número de identificación del cliente	String
age	Edad	String
gender	Género	String
country	País de residencia	String
state	Estado de residencia	String
city	Ciudad de residencia	String
zone	Zona de residencia	String
address	Dirección de residencia	String
opt1	Campo adicional #1 donde se puede ingresar información complementaria de la campaña	String
opt2	Campo adicional #2 donde se puede ingresar información complementaria de la campaña	String
opt3	Campo adicional #3 donde se puede ingresar información complementaria de la campaña	String
opt4	Campo adicional #4 donde se puede ingresar información complementaria de la campaña	String
opt5	Campo adicional #5 donde se puede ingresar información complementaria de la campaña	String
opt6	Campo adicional #6 donde se puede ingresar información complementaria de la campaña	String
opt7	Campo adicional #7 donde se puede ingresar información complementaria de la campaña	String
opt8	Campo adicional #8 donde se puede ingresar información complementaria de la campaña	String
opt9	Campo adicional #9 donde se puede ingresar información complementaria de la campaña	String
opt10	Campo adicional #10 donde se puede ingresar información complementaria de la campaña	String
opt11	Campo adicional #11 donde se puede ingresar información complementaria de la campaña	String
opt12	Campo adicional #12 donde se puede ingresar información complementaria de la campaña	String
tel1	Primera opción de número de teléfono	String
tel2	Segunda opción de número de teléfono	String
tel3	Tercera opción de número de teléfono	String
agent_id	Este campo solo aparece al consultar campañas de tipo preview y se refiere al número de extensión de cada uno de los usuarios de wolkvox Agente	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": " "
        }
    ]
}