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

< / >

APIs Billing

14. Filtrar campaña

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=start&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:

Esta API permite filtrar campañas de manera eficiente, permitiendo a los usuarios aplicar criterios de búsqueda personalizados sobre los registros de las campañas.

Beneficio:

Podrás personalizar las búsquedas dentro de las campañas, mejorando la eficiencia en la gestión y recuperación de datos relevantes para la operación del contact center. Esto facilita una toma de decisiones más informada y una experiencia de usuario mejorada al trabajar con campañas específicas.

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.
  • Los posibles valores para “filter_Active” son “yes” o “no”.
  • Los posibles valores para “connector” son “and” o “or”.
  • Los posibles valores para “field” dentro de “filters” son “customer_name”, “customer_last_name”, “id_type”, “customer_id”, “age”, “gender”, “country”, “state”, “city”, “zone”, “address”, “opt1”, “opt2”, “opt3”, “opt4”, “opt5”, “opt6”, “opt7”, “opt8”, “opt9”, “opt10”, “opt11”, “opt12”, “tel1”, “tel2”, “tel3”, “tel4”, “tel5”, “tel6”, “tel7”, “tel8”, “tel9”, “tel10”, “tel_extra”, “email” y “result”.
  • Los posibles valores para “operator” dentro de “filters” son “<“, “>”, “>=”, “<=”, “!=”, “=”, “is” y “like”.
  • 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
filter_active Indica si el filtro está activo o no. String
connector Define el conector lógico para combinar múltiples filtros. Si no se especifica, el valor predeterminado es AND. String
filters Lista de filtros, donde cada filtro contiene: “field” que es el campo por el que se desea filtrar. “operator” que es el operador lógico para el filtro. “value” que es el valor por el cual se desea filtrar. 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 => 'https://wv{{wolkvox-server}}.wolkvox.com/api/v2/campaign.php?api=campaign_filter&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_POSTFIELDS =>'{
    "filter_active": "",
    "connector": "",
    "filters": [
        {
            "field": [
                ""
            ],
            "operator": [
                ""
            ],
            "value": ""
        },
        {
            "field": [
                ""
            ],
            "operator": [
                ""
            ],
            "value": ""
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{wolkvox-token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
  "code": ,
  "error": ,
  "msg": "Campaign filter successfully updated",
  "data": {
    "total_records": "",
    "pending_records": "",
    "applied_filter": ""
  }
}
				
			

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