11. Parar campaña - Wolkvox

< / >

APIs Campaign

11. Parar campaña

URL:

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

Descripción:

Esta API permite pausar una campaña, desde una plataforma externa.

Beneficio:

Esta función sirve para facilitar y agilizar el proceso de activar o desactivar campañas usando por ejemplo un botón desde la plataforma donde se esté realizando la gestión.

Cómo funciona:

El consumo de esta API se realiza por método PUT.
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.
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

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

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

				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=stop&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 => 'PUT',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location -g --request PUT 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=stop&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}' 
--header 'wolkvox-token: {{token}}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=stop&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}")
  .method("PUT", body)
  .addHeader("wolkvox-token", "{{token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

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

payload={}
headers = {
  'wolkvox-token': '{{token}}'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "The xxxxx campaign_id has been stopped successfully"
}

wolkvox
worldwide

COLOMBIA

Medellín +57 (604) 322 98 80
Bogotá +57 (601) 381 90 40
Cali +57 (602) 891 28 46
Barranquilla +57 (605) 316 10 34

ARGENTINA

Buenos Aires
+54 (11) 5217 5933

BRASIL

Sao Paulo
+55 (11) 521 75 933

CHILE

Santiago de Chile
+56 (2) 240 533 89

ESPAÑA

Madrid
+34 (910) 601 691

UNITED STATES

Atlanta, GA +1 (470) 447-2610
Miami, FL +1 (470) 447-2610

GUATEMALA

Ciudad de Guatemala
+502 (2) 3141344

MÉXICO

Ciudad de México
+52 (55) 8526 36 34

REPÚBLICA DOMINICANA

Santo Domingo
+1 (829) 249 69 68

PERÚ

Lima
+51 (1) 644 91 39

Línea ética / Ethics line

[email protected]

Habla con el Oficial / Contact Compliance Officer

[email protected]

Trabaja con nosotros

|

Política seguridad de la información

|

Política tratamiento de datos personales

|

Políticas de Transferencia de la Información

Copyright © 2023 MICROSYSLABS S.A.S. Todos los derechos reservados. Cra 30 # 4A-45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia

¿POR QUÉ WOLKVOX

PLATAFORMA OMNICANAL

CHATBOTS Y VOICEBOTS

wolkvox worldwide

COLOMBIA
Medellín +57 (4) 322 98 80
Bogotá +57 (1) 381 90 40
Cali +57 (2) 891 28 46
Barranquilla +57 (5) 316 10 34

ARGENTINA
Buenos Aires +54 (11) 5217 5933

ESPAÑA
Madrid +34 (910) 601 691

MÉXICO
Ciudad de México +52 (55) 8526 36 34

BRASIL
Brasilia +55 (61) 9836 4127
São Paulo +55 (12) 9811 155 83

ESTADOS UNIDOS
New York +1 (914) 373 71 36

REPÚBLICA DOMINICANA
Santo Domingo +1 (829) 249 69 68

CHILE
Santiago de Chile +56 (2) 240 533 89

GUATEMALA
Ciudad de Guatemala +502 (2) 314 1344

PERÚ
Lima +51 (1) 644 91 39

Trabaja con nosotros

Política seguridad de la información

Política tratamiento de datos personales

Políticas de Transferencia de la Información

Copyright © 2022 MICROSYSLABS S.A.S.
Todos los derechos reservados.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia