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

< / >

APIs Reports Manager

3. SMS- detalle

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=cdr_3&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

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:

Este reporte entrega información detallada de mensajería outbound por SMS (mensaje de texto) o WhatsApp indicando el canal usado, el teléfono, destino, fecha de la comunicación y el mensaje, además de la identificación numérica del cliente y el agente.

Beneficio:

Este reporte permite conocer el detalle de la comunicación por mensajería (SMS – WhatsApp) incluyendo el texto del mensaje enviado.

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

Request

NAME DESCRIPTION TYPE
api Tipo de reporte requerido. String
date_ini Fecha Inicial (YYYYmmddHHiiss). String
date_end Fecha Final (YYYYmmddHHiiss). String

Response

NAME DESCRIPTION TYPE
agent_id Número de extensión del agente. String
agent_name Nombre del agente. String
date Indica la fecha con formato año-mes -día-Hora. String
destiny Indica el destino del mensaje. String
telephone Indica el número telefónico al que se envió el mensaje. String
message Es el mensaje exacto que fue enviado por mensajería (SMS – Apps).         String
channel Canal usado para el envío del mensaje. Puede arrojar los valores “Whatsapp” (más el tipo e identificador del conector) para el caso de menajes enviados vía WhatsApp y “SMS” en caso de haber usado la herramienta de mensajes de texto. String
customer_id Corresponde al número de identificación del cliente.       String
conn_id Corresponde al número de identificación de la llamada. String
Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=cdr_3&date_ini={{date_ini}}&date_end={{date_end}}',
  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": "1 records were found",
    "data": [
        {
            "agent_id": "",
            "agent_name": "",
            "date": "",
            "destiny": "",
            "telephone": "",
            "message": "",
            "channel": "",
            "customer_id": "",
            "conn_id": ""
        }
    ]
} 

				
			

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