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

< / >

APIs Billing

10. Start campaign En

URL:

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

Description:

This API allows to launch a campaign, from an external platform.

Benefit:

This function serves to facilitate and speed up the process of activating or deactivating campaigns using, for example, a button from the platform where the management is being carried out.

How it works:

  • This API is consumed by PUT method.
  • To consume this API you must replace in the url {{wolkvox_server}} for the nomenclature of the server of the operation.
  • The wolkvoxtoken header must be used to make use of the authorization token.
  • Keep in mind that the same token cannot be consumed simultaneously, so you can program that the next API is consumed when the result of the previous one is successful.
  • Limit of records that can be downloaded per consumption: 60,000 records.
  • Limit of records that can be uploaded per consumption: 10,000 records.
  • Limit of days queried in dates: 31 days.
  • Limit of result weight: 256 MB.
  • API consumption time limit: 60 seconds.
  • Concurrent consumption limit of a token: 2 simultaneous requests.
  • Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

NAME DESCRIPTION TYPE
type_campaign (URL) Campaign type. This field can accept the values “preview” or “predictive”. String
campaign_id (URL)  Campaign ID. String

Response

NAME DESCRIPTION TYPE
code Response code int
error Error String
msg Response description String
 
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=start&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_HTTPHEADER => array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "The xxxxx campaign_id has been started successfully"
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data