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

< / >

APIs

9. Listar códigos de actividad

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=activity_codes

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 tener información acerca de los códigos de actividad activos en su operación.

Beneficio:

Permite tener información básica como: número o nombre del código de actividad, descripción del código de actividad, si está establecido o no como un hit y/o rpc, si se encuentra disponible para tipificar chats y a cuál grupo de códigos de actividad pertenece.

Cómo funciona:

  • El consumo de esta API se realiza por método GET.
  • 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 simultánea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
  • En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.
  • 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
apiTipo de reporte requerido.String

Response

NAMEDESCRIPTIONTYPE
code_actNombre o número de identificación del código de actividad.String
description_cod_actDescripción del código de actividad.String
hitIndica si el código de actividad está registrado como “hit” (yes/no).String
rpcIndica si el código de actividad registra la llamada como “rpc” (yes/no).String
chatIndica si el código de actividad se puede usar en la tipificación de chats (yes/no).String
studioIndica si el código de actividad se puede usar para el diseño de flujos en wolkvox Studio(yes/no).String
voiceIndica si el código de actividad se puede usar en la tipificación de llamadas(yes/no).String
type_codeMuestra cuál es el grupo de códigos de actividad al cual pertenece. Arroja el valor “cod_act1” si pertenece al grupo de códigos de actividad #1 y “cod_act2” si pertenece al grupo de códigos de actividad #2String
interactionsIndica si el código de actividad se puede usar en la tipificación de interacciones(yes/no), como por ejemplo Facebook, Instagram y correo electrónico.String
Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=activity_codes',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "0",
    "error": null,
    "msg": " records were found",
    "data": [
        {
            "cod_act": " ",
            "description_cod_act": " ",
            "hit": " ",
            "rpc": " ",
            "chat": " ",
            "studio": "",
            "voice": "",
            "type_code": " ",
            "interactions": ""
        },
        {
            "cod_act": " ",
            "description_cod_act": " ",
            "hit": " ",
            "rpc": " ",
            "chat": " ",
            "studio": "",
            "voice": "",
            "type_code": " ",
            "interactions": ""
        }
    ]
}
				
			

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