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

< / >

APIs Campaign

4. Creación de campañas

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

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 crear campañas preview o predictiva en wolkvox manager desde plataformas externas.

Beneficio:

Utiliza esta API para tener más eficiencia en el proceso de creación de campañas preview o predictiva, en caso de tener una plataforma externa donde suministren la información necesaria.

Cómo funciona:

  • El consumo de esta API se realiza por método POST.
  • 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.
  • 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_name Nombre de la campaña. String
campaign_description Descripción de la campaña. String
start_time Hora de inicio de la campaña en formato {{hhiiss}}. Este campo solo aplica para campañas de tipo “predictive” ya que las de tipo “preview” no tienen tiempo de ejecución. String
end_time Hora final de la campaña en formato {{hhiiss}}. Este campo solo aplica para campañas de tipo “predictive” ya que las de tipo “preview” no tienen tiempo de ejecución. String
skill_id Se refiere a la identificación numérica del skill. String
opt# Da un título a cada campo adicional donde se ingresa información extra de los clientes objetivo en la campaña. String
amd Este campo opcional (para campañas de tipo predictiva) permite especificar la configuración del AMD (Answering Machine Detection) según el país de destino donde se encuentran los clientes subidos a la campaña. Las opciones disponibles son: “ARG”, “CHL”, “COL”, “CRI”, “ECU”, “ESP”, “GTM”, “HND”, “ITA”, “MEX”, “NIC”, “PAN” y “PER”. Si no se define este campo, la campaña será creada con AMD default. String
enable_edition Permite habilitar la edición de la campaña, este campo recibe los valores “yes” y “no”. String

Response

NAME DESCRIPTION TYPE
id_campaing Corresponde al número de identificación de la campaña String
name_campaing Nombre de la campaña 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=create_campaign&type_campaign={{type_campaign}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "campaign_name": "{{campaign_name}}",
    "campaign_description": "{{campaign_description}}",
    "start_time": "{{start_time}}",
    "end_time": "{{end_time}}",
    "skill_id": "{{skill_id}}",
    "opt1": "{{opt1}}",
    "opt2": "{{opt2}}",
    "opt3": "{{opt3}}",
    "opt4": "{{opt4}}",
    "opt5": "{{opt5}}",
    "opt6": "{{opt6}}",
    "opt7": "{{opt7}}",
    "opt8": "{{opt8}}",
    "opt9": "{{opt9}}",
    "opt10": "{{opt10}}",
    "opt11": "{{opt11}}",
    "opt12": "opt12",
    "enable_edition": "{{enable_edition}}"
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 201,
    "error": null,
    "msg": "The # campaign_id has been created successfully",
    "data": [
        {
            "id_campaign": "",
            "name_campaign": ""
        }
    ]
}
				
			

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