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

< / >

APIs Billing

3. Borrar todos los registros de una campaña

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

Ejemplos de código:

En nuestro workspace de Postman (da clic aquí para ir), tienes acceso a ejemplos de código que facilitan la integración con nuestras APIs en diferentes lenguajes de programación, como cURL, Python, JavaScript, y más.

Esta funcionalidad es ideal para integraciones rápidas y permite adaptar los llamados a la API según el lenguaje de programación de tu sistema.

Cómo Usar los Ejemplos de Código:

  1. Navega a nuestro workspace en Postman.
  2. Selecciona la API que deseas consultar.
  3. Edita los parámetros necesarios de la API según tus objetivos.
  4. En la pestaña de “Code”, selecciona el lenguaje de tu preferencia.
  5. Obtendrás un fragmento de código autogenerado, listo para usarse con los parámetros y autenticación configurados anteriormente.

 

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: {{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.
  • Puedes filtrar la eliminación de registros por resultado. Puede aceptar los siguientes valores: “no-answer”, “answer-machine”, “abandon”, “busy”, “congestion”, “unknown”, “failed”, “do-not-call”, “chanunavail” y “answer”.
  • Límite de registros que se pueden bajar por consumo: 60,000 registros.
  • Límite de registros que se pueden subir por consumo: 10,000 registros.
  • Límite de días consultados en fechas: 31 días.
  • Límite de peso del resultado: 256 MB.
  • Límite de tiempo de consumo del API: 60 segundos.
  • Límite de consumo simultáneo de un token: 2 solicitudes simultáneas.
  • Límite diario de tokens: Número de licencias multiplicado por 1000 tokens diarios.

Request

NAMEDESCRIPTIONTYPE
type_campaignTipo de campaña. Este campo puede aceptar los valores “preview” o “predictive”.String
campaign_idSe refiere a la identificación numérica de la campañaString
resultEste campo opcional en la URL de la API permite eliminar los registros que tengan un valor específico en su columna de resultado. Puede aceptar los siguientes valores: “no-answer”, “answer-machine”, “abandon”, “busy”, “congestion”, “unknown”, “failed”, “do-not-call”, “chanunavail” y “answer”.String

Response

NAMEDESCRIPTIONTYPE
codeCódigo de respuestaint
errorErrorString
msgDescripción de la respuestaString
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=clear_campaign&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_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-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

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