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

< / >

APIs Information

4. Campaigns

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: {{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

NAMEDESCRIPTIONTYPE
apiTipo de reporte requerido.String

Response

NAMEDESCRIPTIONTYPE
campaign_idID de la campaña.String
campaign_nameNombre de la campaña.String
campaign_descriptionDescripción de la campaña.String
type_campaignTipo de la campaña. Puede arrojar el valor “predictive” o “preview”.String
statusEstado de la campaña puede arrojar el valor “Started” (encendida) o “Stopped” (detenida).String
recordsNúmero de registros de la campaña.String
speedVelocidad de la campaña.String
dial_modeDetalla del modo de marcación. Puede arrojar el valor “autopilot”, “strategy” y “phone1 – ring: 60(seg)”. Este último valor puede cambiar ya que las campañas tienen hasta 10 teléfonos por registro y un tiempo de ring que va de 10 hasta 60 segundos, todo depende de lo configurado en la campaña.String
last_useFecha en formato año-mes-día-hora de el ultimo uso de la skill.String
recycledCantidad de registros reciclados en la campaña. Esto indica la cantidad de registros de la campaña que se han vuelto a utilizar.String
turbo_dialIndica si el servicio de turbo dial está activo o no en la campaña.String
skill_idNúmero de identificación del skill relacionado con la llamada.String
Posibles códigos de respuesta

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": "",
            "recycled": "",
            "turbo_dial": "",
            "skill_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