fbpx

< / >

APIs Information

4. Campaigns

URL:

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

Descripción:

Esta API Permite tener información acerca de las campañas de la operación.

Beneficio:

Permite tener información básica de cada una de las campañas de la operación.

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
NAMEDESCRIPTIONTYPE
apiTipo de reporte requeridoString
RESPONSE
NAMEDESCRIPTIONTYPE
campaign_idID de la campañaString
campaign_nameNombre de la campañaString
campaign_descriptionDescripción de la campaña String
type_campaignTipo de la campañaString
statusEstado de la campaña (encendida – apagada)String
recordsNúmero de registros de la campañaString
speedVelocidad de la campañaString
dial_modeModo de marcaciónString
last_useFecha en formato año-mes-día-hora de el ultimo uso de la skillString
Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL =&gt; 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=campaigns',
  CURLOPT_RETURNTRANSFER =&gt; true,
  CURLOPT_ENCODING =&gt; '',
  CURLOPT_MAXREDIRS =&gt; 10,
  CURLOPT_TIMEOUT =&gt; 0,
  CURLOPT_FOLLOWLOCATION =&gt; true,
  CURLOPT_HTTP_VERSION =&gt; CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST =&gt; 'GET',
  CURLOPT_HTTPHEADER =&gt; array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "",
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "campaign_id": "",
            "campaign_name": "",
            "campaign_description": " ",
            "type_campaign": "",
            "status": "",
            "records": "",
            "speed": "",
            "dial_mode": "",
            "last_use": ""
        }
    ]
}
				
			

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