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

< / >

APIs Information

7. Información de Servicios

URL:

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

 

Descripción:

Esta API permite tener un reporte básico acerca de los servicios integrados en la operación.

 

Beneficio:

Permite tener información básica del número de licencias, PBX y servicios activos.

 

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 simultanea, 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.

 

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.

Request

NAMEDESCRIPTIONTYPE
apiTipo de reporte requerido.String

Response

NAMEDESCRIPTIONTYPE
licensesNúmero de licencias activas.Number
pbxNúmero de usuarios PBX activos.Number
screen_recordingServicio de grabación de pantalla (yes/no).String
video_callServicio de videollamada (yes/no).String
stereo_recordingServicio de grabación de llamadas en estéreo (yes/no).String
gamificationServicio de gamificación (yes/no).String
text_analyticsServicio de análisis de texto (yes/no).String
speech_analyticsServicio de análisis de voz (yes/no).String
rsyncServicio de rsync o copias de seguridad en NAS u otros tipos de almacenamiento local (yes/no).String
wolkvox_storageIndica si el servicio de almacenamiento Wolkvox Storage está activado.String
blob_storageIndica si el almacenamiento en Blob Storage de Azure está activado.String
aws_s3Indica si el almacenamiento en AWS S3 está activado.String
intelligentdialIndica si el marcado inteligente está activado.String
biIndica si las herramientas de inteligencia de negocios (BI) están activadas.String
customer_protIndica si la protección al consumidor (como la ley 2300) está activada.String
mr_wizardIndica si el asistente inteligente Mr Wizard se encuentra activo en su operación.String
turbo_dialIndica si el sistema inteligente de marcación Turbo Dial está activado.String
ssoIndica si el inicio de sesión único (SSO) está activado.String
mailgunIndica si la integración con Mailgun está activada.String
whatsappIndica si existe alguna integración de un canal de WhatsApp en su operación.String
facebook_pageIndica si existe alguna integración de una página de Facebook en su operación.String
facebook_messengerIndica si existe alguna integración del servicio de mensajería de Facebook Messenger en su operación.String
instagram_pageIndica si existe alguna integración del servicio de mensajería de Instagram en su operación.String
instagram_chatIndica si existe alguna integración del servicio de mensajería de Instagram en su operación.String
sms_bidireccionalIndica si el servicio de SMS bidireccional está activado. Este servicio se encuentra disponible actualmente solo en territorio estadounidense.String
chat_webIndica si el servicio de chat web se encuentra activado en su operación.String
telegramIndica si algún canal de Telegram está integrado.String
crmIndica si el sistema de gestión de relaciones con clientes wolkvox CRM está activado.String
emailIndica si existe algún servicio de correo electrónico integrado en la operación.String
cobrowsingIndica si la funcionalidad de navegación conjunta (cobrowsing) está activada.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=services',
  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": "200",
    "error": null,
    "msg": "X records were found",
    "data": [
        {
            "licenses": "",
            "pbx": "",
            "screen_recording": "",
            "video_call": "",
            "stereo_recording": "",
            "gamification": "",
            "text_analytics": "",
            "speech_analytics": "",
            "rsync": "",
            "wolkvox_storage": "",
            "blob_storage": "",
            "aws_s3": "",
            "intelligentdial": "",
            "bi": "",
            "customer_prot": "",
            "mr_wizard": "",
            "turbo_dial": "",
            "sso": "",
            "mailgun": "",
            "whatsapp": "",
            "facebook_page": "",
            "facebook_messenger": "",
            "instagram_page": "",
            "instagram_chat": "",
            "sms_bidireccional": "",
            "chat_web": "",
            "telegram": "",
            "crm": "",
            "email": "",
            "cobrowsing": ""
        }
    ]
}
				
			

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