The Five9 Configuration Web Services API provides developers access to Five9 User, Calling List, Contact, and Campaign Management capabilities. The Configuration Web Services API can be used to add new leads to lists, provision new Five9 users, manage campaigns within a 3rd-party application, and more.
| Method | Description |
| LIST MANAGEMENT |
| addToList | Imports records to the specified dialing list according to the specified import settings. May also add or update CRM records if corresponding options are chosen. Records are provided in xml format. |
| addToListCsv | Imports records to the specified dialing list according to the specified import settings. May also add or update CRM records if corresponding options are chosen. Records are provided in csv format. |
| createList | Creates dialing list. |
| getListImportResult | Provides detailed results of the list import. |
| isImportRunning | Checks whether data import is running. |
| getListsInfo | Provides dialing list names and sizes of all dialing lists in a domain. |
| deleteFromList | Deletes records from the specified list. List of records to be deleted is provided in xml format. |
| deleteFromListCsv | Deletes records from the specified list. List of records to be deleted is provided in comma separated value format. |
| deleteAllFromList | Removes all records from the specified list. |
| addNumbersToDnc | Adds numbers to do-not-call list. |
| checkDncForNumbers | Checks if numbers are part of the do-not-call list. |
| removeNumbersFromDnc | Removes numbers from the do-not-call list. |
| CAMPAIGN MANAGEMENT |
| resetCampaign | Instructs the campaign to redial every number again, with the exception of "Do Not Call" numbers. |
| startCampaign | Starts a Five9 campaign. |
| stopCampaign | Stops a Five9 campaign, and waits for all active calls to end. |
| forceStopCampaign | Stops a Five9 campaign, and immediately disconnects all active calls. |
| updateDispositions | Updates disposition values for the specified campaign. |
| updateDispositionsCsv | Updates disposition values for the specified campaign. Records are passed as a string containing comma-separated values. |
| getDispositionsImportResult | Provides details for the dispositions import session. |
| CONTACT MANAGEMENT |
| updateContacts | Updates records based on update settings. Record information is provided in xml format. |
| updateContactsCsv | Updates records based on update settings. Record information is provided in comma separated value format. |
| getCrmImportResult | Provides detailed results of the Contact records import. |
| deleteFromContacts | Deletes one or multiple record from Contact database. List of records to delete is provided in xml format. |
| deleteFromContactsCsv | Deletes one or multiple records from Contact database. List of records to delete is provided in comma separated value format. |
| USER MANAGEMENT |
| createUser | Creates a new user. |
| modifyUser | Modify user information. |
| deleteUser | Deletes a user. |
| userSkillModify | Modify the information related to a skill assigned to a user. |
| userSkillAdd | Add a skill to a user. |
| userSkillRemove | Remove a skill from a user. |
| getUserGeneralInfo | Provides user general information (user name, full name, email address, extension, whether user can change password and run reports). |
| getUsersGeneralInfo | Provides general information for users. |
| getUserInfo | Provides user general information, roles, and skills. |
| getUsersInfo | Provides general information, roles, and skills for users. |
| SKILL MANAGEMENT |
| createSkill | Creates a new skill.C |
| modifySkill | Modifies an existing skill. |
| deleteSkill | Deletes a skill. |
| getSkill | Provides skill information: name, description, message of the day, etc. |
| getSkillInfo | Provides skill information and a list of users that possess the specified skill. |
| getSkills | Provides skill information for each skill. |
| getSkillsInfo | Provides skill information and a list of users that possess a given skill. |
