URL:
https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=add_record&type_campaign=predictive&campaign_id={{campaign_id}}&campaign_status={{campaign_status}}
Description:
This API allows you to insert records automatically and remotely or from external platforms, in an existing campaign in wolkvox manager.
Benefit:
This API is very useful when you have, for example, external forms to capture leads, when the user registers automatically the information will be sent to the campaign and the call or message will be sent as parameterized.
How it works:
- The consumption of this API is done by POST 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 {{type_campaign}} field is replaced by the campaign type.
- The {{campaign_id}} is replaced by the campaign ID number.
- The {{campaign_status}} field must be replaced by the current status of the campaign.
- 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.
NAME | DESCRIPTION | TYPE |
---|---|---|
customer_name | Customer’s first name | String |
customer_last_name | Last name of customer | String |
id_type | Identification type | String |
customer_id | Customer identification number | String |
age | Age | String |
gender | Gender | String |
country | Country of residence | String |
state | State of residence | String |
city | City of residence | String |
zone | Area of residence | String |
address | Residence address | String |
opt1 | Additional field to enter additional campaign information | String |
opt2 | Additional field to enter additional campaign information | String |
opt3 | Additional field to enter additional campaign information | String |
opt4 | Additional field to enter additional campaign information | String |
opt5 | Additional field to enter additional campaign information | String |
opt6 | Additional field to enter additional campaign information | String |
opt7 | Additional field to enter additional campaign information | String |
opt8 | Additional field to enter additional campaign information | String |
opt9 | Additional field to enter additional campaign information | String |
opt10 | Additional field to enter additional campaign information | String |
opt11 | Additional field to enter additional campaign information | String |
opt12 | Additional field to enter additional campaign information | String |
tel1 | Phone number | String |
tel_extra | Extra phone | String |
Customer’s email | String | |
recall_date | Is the date of the recall format (yyyymmddhhmmss) | String |
recall_telephone | Recall phone number | String |
RESPONSE |
NAME | DESCRIPTION | TYPE |
---|---|---|
total_registers | Total records added | int |