URL:
https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=codify&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}
Description:
This API allows you to encode predictive or preview records from an external application to prevent the dialer from calling the client.
Benefit:
For example, when the customer is contacted through a channel other than the call center or when the customer is called through a manual call and it is necessary to notify the predictive system that the customer has been contacted, with this API it is possible to do that process and in this way the customer is not contacted again.
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.
| REQUEST |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| type_campaign (URL) | Type of campaign | String |
| campaign_id (URL) | Refers to the numerical identification of the campaign. | String |
| cod_act | Primary result code for the record | String |
| cod_act_2 | Secondary result code for the record | String |
| comment | Comment | String |
| customer_id | Refers to the numerical identification of the customer. | String |
| RESPONSE |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| code | Response code | int |
| error | Error | String |
| msg | Description of the response | String |