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

< / >

APIs Reports Manager

9. Estado de los registros en las campañas de WhatsApp

URL: https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_9&campaign_id=all&date_ini={{date_ini}}&date_end={{date_end}}

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

NAMEDESCRIPTIONTYPE
apiTipo de reporte requerido.String
campaign_idIdentificació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_iniFecha Inicial (YYYYmmddHHiiss).String
date_endFecha Final (YYYYmmddHHiiss).String

Response

NAMEDESCRIPTIONTYPE
campaign_idNúmero de identificación de la campaña.String
telephoneNúmero de teléfono del cliente.String
statusEstado del registro. Puede arrojar los valores “accepted”, “delivered”, “submitted” y “failed”.String
errorsErrores encontrados al intentar contactar al registro.String
dateFecha y hora en la que se contactó al registro.String
last_updateÚltima fecha en la cual se contactó al registro.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=campaign_9&campaign_id=all&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-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "campaing_id": "",
            "telephone": "",
            "status": "",
            "errors": "",
            "date": "",
            "last_update": ""
        }
    ]
}

				
			

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