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:
- Navega a nuestro workspace en Postman.
- Selecciona la API que deseas consultar.
- Edita los parámetros necesarios de la API según tus objetivos.
- En la pestaña de “Code”, selecciona el lenguaje de tu preferencia.
- 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 podrás obtener el reporte del estado de cada registro agregado a su campaña de WhatsApp.
Beneficio:
Realiza un monitoreo detallado de las campañas de WhatsApp.
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 del token de autorización.
- Tenga en cuenta que un mismo token no puede ser consumido 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
NAME | DESCRIPTION | TYPE |
---|---|---|
api | Tipo de reporte requerido. | String |
campaign_id | Identificación numérica de la campaña. Puede recibir el valor “all” para obtener el reporte de todas las campañas de la operación. | String |
date_ini | Fecha Inicial (YYYYmmddHHiiss). | String |
date_end | Fecha Final (YYYYmmddHHiiss). | String |
Response
NAME | DESCRIPTION | TYPE |
---|---|---|
campaign_id | Número de identificación de la campaña. | String |
telephone | Número de teléfono del cliente. | String |
status | Estado del registro. Puede arrojar los valores “accepted”, “delivered”, “submitted” y “failed”. | String |
errors | Errores encontrados al intentar contactar al registro. | String |
date | Fecha y hora en la que se contactó al registro. | String |
last_update | Última fecha en la cual se contactó al registro. | String |