CAMPAIGN/CONTACT/ADD Command
The campaign/contact/add command allows you to add a new contact in a campaign.
Command structure
To start the request, a http request must be sent to the url:
https://client.voipit.ro/<numarCont>/campaign/contact/add
The following parameters will be sent, using the POST method:
- password
- The API password for the account.
- campaignId
- The ID of the campaign (can be viewed in the campaign info page, using the Information tab).
- phoneNumber
- (20 characters maximum) The phone number to be added to the campaign.
- description
- (optional) (2000 characters maximum) a description for the contact, to be viewed by the call center agent, before starting the call.
- deleteDuplicates
- (optional) (default "thisCampaign") one of the values: "thisCampaign", "allCampaigns". If "thisCampaign" is defined then any contact having the same phone number, inside the selected campaign, will be deleted. If "allCampaigns" value is provided then any contact having the same phone number inside any campaign (on the entire account) will be deleted.
The phone number must obey the following rules:
- minimum 10 characters;
- maximum 20 characters;
- only digits and, optionally, one "+" character;
- if the number has 10 characters, then the first one must be 0;
- the "+" character can only be used if the number contains at least 10 more digits;
- the "+" character can only be used on the first position.
Server response
If the request was processed successfully then a JSON package will be sent back:
{ "type" : "ok" }