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

< / >

APIs Campaign

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

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.
Se reemplaza {{campaign_id}} por el número de identificación de la campaña.
Se debe hacer uso del header wolkvox-token: {{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.
Límite de registros que se pueden bajar por consumo: 60,000 registros.
Límite de registros que se pueden subir por consumo: 10,000 registros.
Límite de días consultados en fechas: 31 días.
Límite de peso del resultado: 256 MB.
Límite de tiempo de consumo del API: 60 segundos.
Límite de consumo simultáneo de un token: 2 solicitudes simultáneas.
Límite diario de tokens: Número de licencias multiplicado por 1000 tokens diarios.

Request

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
tel4	Cuarta opción de número de teléfono	String
tel5	Quinta opción de número de teléfono	String
tel6	Sexta opción de número de teléfono	String
tel7	Séptima opción de número de teléfono	String
tel8	Octava opción de número de teléfono	String
tel9	Novena opción de número de teléfono	String
tel10	Décima opción de número de teléfono	String
agent_id	Este campo solo está disponible en campañas de tipo “preview” y permite asignar a un agente en específico, los registros de la campaña que se está agregando.	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 => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=add_record&type_campaign=preview&campaign_id={{campaign_id}}&campaign_status={{campaign_status}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '[{
            "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": "",
            "tel4": "",
            "tel5": "",
            "tel6": "",
            "tel7": "",
            "tel8": "",
            "tel9": "",
            "tel10": "",
            "agent_id": " "
    
}]',
  CURLOPT_HTTPHEADER => 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&type_campaign=preview&campaign_id={{campaign_id}}&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": "",
            "tel4": "",
            "tel5": "",
            "tel6": "",
            "tel7": "",
            "tel8": "",
            "tel9": "",
            "tel10": "",
            "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": "",
            "tel4": "",
            "tel5": "",
            "tel6": "",
            "tel7": "",
            "tel8": "",
            "tel9": "",
            "tel10": "",
            "agent_id": " "
    
}]');
Request request = new Request.Builder()
  .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}}")
  .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&type_campaign=preview&campaign_id={{campaign_id}}&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": "",
            "tel4": "",
            "tel5": "",
            "tel6": "",
            "tel7": "",
            "tel8": "",
            "tel9": "",
            "tel10": "",
            "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": " "
        }
    ]
}

wolkvox
worldwide

COLOMBIA

Medellín +57 (604) 322 98 80
Bogotá +57 (601) 381 90 40
Cali +57 (602) 891 28 46
Barranquilla +57 (605) 316 10 34

ARGENTINA

Buenos Aires
+54 (11) 5217 5933

BRASIL

Sao Paulo
+55 (11) 521 75 933

CHILE

Santiago de Chile
+56 (2) 240 533 89

ESPAÑA

Madrid
+34 (910) 601 691

UNITED STATES

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

GUATEMALA

Ciudad de Guatemala
+502 (2) 3141344

MÉXICO

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

REPÚBLICA DOMINICANA

Santo Domingo
+1 (829) 249 69 68

PERÚ

Lima
+51 (1) 644 91 39

Línea ética / Ethics line

[email protected]

Habla con el Oficial / Contact Compliance Officer

[email protected]

Trabaja con nosotros

|

Política seguridad de la información

|

Política tratamiento de datos personales

|

Políticas de Transferencia de la Información

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

¿POR QUÉ WOLKVOX

PLATAFORMA OMNICANAL

CHATBOTS Y 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

ESPAÑA
Madrid +34 (910) 601 691

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

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

ESTADOS UNIDOS
New York +1 (914) 373 71 36

REPÚBLICA DOMINICANA
Santo Domingo +1 (829) 249 69 68

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

GUATEMALA
Ciudad de Guatemala +502 (2) 314 1344

PERÚ
Lima +51 (1) 644 91 39

Trabaja con nosotros

Política seguridad de la información

Política tratamiento de datos personales

Políticas de Transferencia de la Información

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