fbpx

< / >

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 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.
REQUEST
NAME DESCRIPTION TYPE
type_campaign (URL) Telefono para añadir String
campaign_id (URL) Dias por los que el numero estara bloqueado String
customer_id Se refiere a la identificación numérica de el 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 =&gt; 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=remove_record&amp;type_campaign={{type_campaign}}&amp;campaign_id={{campaign_id}}',
  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; 'DELETE',
  CURLOPT_POSTFIELDS =&gt;'{
    "customer_id": ""
}',
  CURLOPT_HTTPHEADER =&gt; 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