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

< / >

APIs Campaign

5. Codificar registro desde aplicación externa

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=codify&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}

Descripción:

Esta API permite codificar registros del predictivo o preview desde una aplicación externa para evitar que el marcador llame al cliente.

Beneficio:

Por ejemplo cuando se contacta al cliente por un canal diferente al call center o cuando se llama al cliente por medio de una llamada manual y es necesario avisarle al sistema predictivo que el cliente fue contactado, con esta API es posible hacer ese proceso y de esta forma no se contacta nuevamente al cliente.

Cómo funciona:

  • El consumo de esta API se realiza por método PUT.
  • En el json se agregan los parametros de acuerdo a la operación o proceso a realizar.
  • 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.

REQUEST

NAME DESCRIPTION TYPE
type_campaign  Tipo de campaña. Este campo puede aceptar los valores “preview” o “predictive”. String
campaign_id Se refiere a la identificación numérica de la campaña String
cod_act Código de tipificación primario para el registro. String
cod_act_2 Código de tipificación secundario para el registro. Solo aplica para cuando se tiene activa la opción de segundo código de tipificación en wolkvox Manager. String
comment Comentario de conclusión de la interacción. String
customer_id Se refiere a la identificación numérica de el cliente. String

RESPONSE

NAME DESCRIPTION TYPE
code Código de respuesta. int
error Error. String
msg Descripción de la respuesta. String

Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=codify&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>'{
    "cod_act": "",
    "cod_act_2": "",
    "comment": "",
    "customer_id": ""
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "customer_id xxxxxxxxxxxx has been coded"
}
				
			

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