fbpx

< / >

APIs Campaign

3. Borrar todos los registros de una campaña

URL:

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

Descripción:

Con esta API es posible borrar todos los registros en una campaña de manera masiva.

Beneficio:

Esta función permite borrar de forma fácil todos los registros de una campaña, para luego volver a hacer uso de la misma con la parametrización que esta tenga y así hacer luego un cargue masivo de registros.

Cómo funciona:

  • El consumo de esta API se realiza por método DELETE.
  • 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) Tipo de campaña String
campaign_id (URL) Se refiere a la identificación numérica de la campaña 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=clear_campaign&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_HTTPHEADER =&gt; array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "All records has been deleted of campaign_id xxxxx 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