fbpx
Search
Close this search box.
Search
Close this search box.

< / >

APIs Campaign

8. Borrar registro

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=remove_record&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}

Descripción:

Esta API permite borrar un registro de la base de datos de una campaña predictiva, desde una plataforma externa.

Beneficio:

Esta función es útil cuando se tiene una campaña funcionando pero el cliente se contacta por otro canal.

Cómo funciona:

  • El consumo de esta API se realiza por método DELETE.
  • 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 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.
  • La búsqueda del registro a eliminar se hace con base al número de identificación del cliente o el valor colocado en “customer_id” cuando se subió el registro.

REQUEST

NAME DESCRIPTION TYPE
type_campaign Tipo de campaña. Este campo puede aceptar los valores “preview” o “predictive”. String
campaign_id Número de identificación de la campaña. String
customer_id Número de identificación del cliente. String

RESPONSE

NAME DESCRIPTION TYPE
code Código de respuesta int
error Error String
msg Descripción de la respuesta String

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=remove_record&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_POSTFIELDS =>'{
    "customer_id": ""
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "customer_id xxxxxxxxxx has been deleted successfully"
}
				
			

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

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