fbpx

< / >

APIs Campaign

7. Reschedule call

URL:

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

Description:

With this API it is possible to reprogram the call to a record of a predictive dialing campaign from an external application.

Benefit:

This API allows you to reprogram calls to a record for example from an external application such as a CRM, which facilitates and speeds up the contact management process.

How it works:

  • The consumption of this API is done by PUT method.
  • In the json the parameters are added according to the operation or process to be performed.
  • To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
  • The wolkvox-token header must be used to make use of the authorization token.
  • Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.

NAMEDESCRIPTIONTYPE
type_campaign (URL)Phone to addString
campaign_id (URL)Days for which the number will be blockedString
recall_dateDate to call backString
recall_telephoneTelephone for souvenir callString
customer_idRefers to the numerical identification of the customer.String

NAMEDESCRIPTIONTYPE
codeResponse codeint
errorErrorString
msgDescription of the responseString

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=recall&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 =>'{
    "recall_date": "",
    "recall_telephone": "",
    "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 xxxxxxx has been updated and will be call back on xxxxxx to phone xxxxx"
}
				
			
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