fbpx

< / >

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 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 = 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={{type_campaign}}&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": "",
            "tel4": "",
            "tel5": "",
            "tel6": "",
            "tel7": "",
            "tel8": "",
            "tel9": "",
            "tel10": "",
            "tel_extra": "",
            "email": "",
            "recall_date": " ",
            "recall_telephone": " "
    
}]',
  CURLOPT_HTTPHEADER =&gt; array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

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

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales