URL:
https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=find_record&campaign_id={{campaign_id}}&customer_phone={{customer_phone}}&customer_id={{customer_id}}
Descripción:
Esta API te permite hacer búsqueda de registros de clientes en tus campañas de Wolkvox para integraciones y automatizaciones en tus servicios adicionales.
Beneficio:
Este reporte te permite conocer por medio de la identificación o teléfono de un cliente, si este se encuentra en una campaña en específico o en todas las campañas.
Tipo de petición:
GET
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.
| REQUEST |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| api | Tipo de reporte requerido | String |
| campaign_id | Identificacion numerica de la campaña | String |
| customer_phone | Hace referencia al teléfono del cliente | String |
| customer_id | Corresponde al número de identificación del cliente | String |
| RESPONSE |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| customer_name | Nombre del cliente | String |
| customer_last_name | Apellido del cliente | String |
| customer_id | Corresponde al número de identificación del cliente | String |
| opt# | Campo adicional donde se ingresa información adicional de la campaña (preview / predictive) | String |
| tel1 | Numero de teléfono 1 | String |
| tel2 | Numero de teléfono 2 | String |
| tel3 | Numero de teléfono 3 | String |
| date | Indica la fecha con formato año-mes -día-Hora | String |
| calls | Indica la cantidad de llamadas (inbound, outbound e internal) | String |
| conn_id | Corresponde al número de identificación de la llamada | String |
| result | Es el resultado de la interacción | String |
| campaign_id | Identificacion numerica de la campaña | String |