Campaigns

This API provides methods to manage the contact campaigns available to the user

APIDescription
GET api/Campaigns

Returns a collection of the campaigns available to the user

GET api/Campaigns/{id}

Returns the campaign corresponding to the specified {id}

GET api/Campaigns/{id}/DirectoryEntries

Returns a collection of directory entries corresponding to the specified {id} campaign

GET api/Campaigns/{id}/Outcomes/{date}

Returns the final outcomes that have been set on the directory entries of the campaign since the date specified

GET api/Campaigns/{id}/Tags

Returns the tags of the campaign

POST api/Campaigns

Creates a new campaign

POST api/Campaigns/{id}/CloseRequest

Marks as "CRM closed" all the directory entries connected to the campaign

POST api/Campaigns/{id}/DirectoryEntries

Appends the specified directory entries to the campaign

POST api/Campaigns/{id}/Tags

Appends the tags to the campaign.

PUT api/Campaigns/{id}

Updates the campaign. All the fields will take their new values from the submitted campaign

PUT api/Campaigns/{id}/DirectoryEntries

Updates the directory entries list connected to the campaign. If an item in the supplied list of directory entries is already connected to the campaign, its values are updated; otherwise, it is added to the directory entries of the campaign

PUT api/Campaigns/{id}/PauseRequest

Marks as "Pause" the campaign

PUT api/Campaigns/{id}/RestartRequest

Marks as "No Pause" the campaign

PUT api/Campaigns/{id}/Tags

Updates the tags list of the campaign. If an item in the supplied list of tags is already connected to the campaign, its value is updated; otherwise, it is added to the tags of the campaign

DELETE api/Campaigns/{id}

Deletes the campaign. All the directory entries and the calls connected to the campaign will also be deleted

DirectoryEntries

This API provides methods to manage the directory entries (i.e. the persons to contact) of the campaigns available to the user

APIDescription
GET api/DirectoryEntries

Returns a collection of the directory entries of all the campaigns available to the user

GET api/DirectoryEntries/{id}

Returns the directory entry corresponding to the specified {id}

POST api/DirectoryEntries

Adds directory entries to the campaigns. The GUID of the campaign to which append each directory entry is specified among the directory entry data.

POST api/DirectoryEntry

Add directory entry to the campaigns. The GUID of the campaign to which append each directory entry is specified among the directory entry data.

PUT api/DirectoryEntries

Create or Edit DirectoryEntries

PUT api/DirectoryEntry

Create or Edit DirectoryEntry

DELETE api/DirectoryEntries/{id}

Deletes the directory entry. All the calls connected to the directory entry will also be deleted

Outcomes

This API provides methods to extract the call outcomes from the system. The outcomes may be "final", i.e. the system will not make further attemps to call that directory entry; or "in progress", i.e. the system will try again to call that directory entry because the configured maximum number of attempts has not been reached yet.

APIDescription
GET api/Outcomes/{date}/{includePositive}

Returns the final outcomes that have been set on the directory entries of all the campaigns since the date specified

POST api/Outcomes

Returns the final outcomes that have been set on the directory entries of the specified campaigns since the date specified in the filter

Tags

This API provides methods to manage the tag assigned to the campaigns available to the user

APIDescription
GET api/Tags

Returns all the tags defined for the campaigns available to the user

GET api/Tags/{id}

Returns the tag corresponding to the specified {id}

DELETE api/Tags/{id}

Deletes the tag.

TelephoneExtensions

This API provides methods to configure the telephone extensions used by the operators

APIDescription
GET api/TelephoneExtensions

Returns a collection of all the configured telephone extensions

GET api/TelephoneExtensions/{id}

Returns the configuration of the telephone extension corresponding to the specified {id}

POST api/TelephoneExtensions

Creates a new telephone extension

PUT api/TelephoneExtensions/{id}

Updates or creates the telephone extension for the operator specified by {id}. If the operator has no telephone extension, a new record will be created in the system; otherwise, the existing telephone extension will be updated.

DELETE api/TelephoneExtensions/{id}

Deletes the telephone extension.