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

< / >

APIs Campaign

4. Creación de campañas

URL:

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

Descripción:

Con esta API es posible crear campañas preview o predictiva en wolkvox manager desde plataformas externas.

Beneficio:

Utiliza esta API para tener más eficiencia en el proceso de creación de campañas preview o predictiva, en caso de tener una plataforma externa donde suministren la información necesaria.

Cómo funciona:

  • El consumo de esta API se realiza por método POST.
  • En el json se agregan los parámetros 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 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
NAMEDESCRIPTIONTYPE
type_campaign (URL)Tipo de campaña (Preview / Predictive)String
campaign_nameNombre de la campañaString
campaign_descriptionDescripción de la campañaString
start_timeHora de inicio de la campañaString
end_timeHora final de la campañaString
skill_idSe refiere a la identificación numerica del skillString
opt#Campo adicional donde se ingresa información adicional de la campañaString
enable_editionSi o no para habilitar la edición de camapañaString
RESPONSE
NAMEDESCRIPTIONTYPE
id_campaingCorresponde al número de identificación de la campañaString
name_campaingNombre de la campañaString
Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL =&gt; 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=create_campaign&amp;type_campaign={{type_campaign}}',
  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; 'POST',
  CURLOPT_POSTFIELDS =&gt;'{
    "campaign_name": "",
    "campaign_description": "",
    "start_time": "",
    "end_time": "",
    "skill_id": "",
    "opt1": "",
    "opt2": "",
    "opt3": "",
    "opt4": "",
    "opt5": "",
    "opt6": "",
    "opt7": "",
    "opt8": "",
    "opt9": "",
    "opt10": "",
    "opt11": "",
    "opt12": "",
    "enable_edition": ""
}',
  CURLOPT_HTTPHEADER =&gt; array(
    'wolkvox-token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 201,
    "error": null,
    "msg": "The # campaign_id has been created successfully",
    "data": [
        {
            "id_campaign": "",
            "name_campaign": ""
        }
    ]
}
				
			

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