2.1 Inserción de registros en la campaña (predictiva) - Wolkvox

< / >

APIs Campaign

2.1 Inserción de registros en la campaña (predictiva)

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=add_record&type_campaign=predictive&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 donde se ingresa información adicional de la campaña	String
opt2	Campo adicional donde se ingresa información adicional de la campaña	String
opt3	Campo adicional donde se ingresa información adicional de la campaña	String
opt4	Campo adicional donde se ingresa información adicional de la campaña	String
opt5	Campo adicional donde se ingresa información adicional de la campaña	String
opt6	Campo adicional donde se ingresa información adicional de la campaña	String
opt7	Campo adicional donde se ingresa información adicional de la campaña	String
opt8	Campo adicional donde se ingresa información adicional de la campaña	String
opt9	Campo adicional donde se ingresa información adicional de la campaña	String
opt10	Campo adicional donde se ingresa información adicional de la campaña	String
opt11	Campo adicional donde se ingresa información adicional de la campaña	String
opt12	Campo adicional donde se ingresa información adicional de la campaña	String
tel1	Número de teléfono principal	String
tel2	Segundo número de teléfono	String
tel3	Tercer número de teléfono	String
tel4	Cuarto número de teléfono	String
tel5	Quinto número de teléfono	String
tel6	Sexto número de teléfono	String
tel7	Séptimo número de teléfono	String
tel8	Octavo número de teléfono	String
tel9	Noveno número de teléfono	String
tel10	Décimo número de teléfono	String
tel_extra	Teléfono extra	String
email	Correo electrónico del cliente	String
recall_date	Es la fecha de la re-llamada formato (yyyymmddhhmmss)	String
recall_telephone	Teléfono de re-llamada	String

RESPONSE

NAME	DESCRIPTION	TYPE
total_registers	Total de registros añadidos	int

Posibles códigos de respuesta

				
					curl --location -g --request POST 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=add_record&amp;type_campaign={{type_campaign}}&amp;campaign_id={{campaign_id}}' 
--header 'wolkvox-token: {{token}}' 
--header 'Content-Type: application/json' 
--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": "",
    "tel_extra": "",
    "email": "",
    "recall_date": "",
    "recall_telephone": ""

}]'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
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": "",
    "tel_extra": "",
    "email": "",
    "recall_date": "",
    "recall_telephone": ""
    
}]');
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=add_record&amp;type_campaign={{type_campaign}}&amp;campaign_id={{campaign_id}}")
  .method("POST", body)
  .addHeader("wolkvox-token", "{{token}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

				
					import requests
import json

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

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": "",
    "tel_extra": "",
    "email": "",
    "recall_date": "",
    "recall_telephone": ""
   
}])
headers = {
  'wolkvox-token': '{{token}}',
  'Content-Type': 'application/json'
}

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