{
"swagger": "2.0",
"info": {
"description": "Admin commands",
"version": "9.0",
"title": "AdminAPI"
},
"tags": [
{
"name": "AddressBook",
"description": " : Address Book Management (Updated in v23.0)"
},
{
"name": "Agents",
"description": " : Agent Management (Updated in v24.0)"
},
{
"name": "Contacts",
"description": " : General Contact Management"
},
{
"name": "General",
"description": " : General Admin Management (Updated in v24.0)"
},
{
"name": "Groups",
"description": " : Group Management"
},
{
"name": "List",
"description": " : Calling/DNC Group Management"
},
{
"name": "Commitments",
"description": " : Scheduled Callback Management"
},
{
"name": "Skills",
"description": " : Skill/Campaign Management"
},
{
"name": "WorkflowData",
"description": " : Management of Workflow Data Profiles"
}
],
"schemes": [ "https" ],
"paths": {
"/address-books": {
"$ref": "Admin/AddressBook#/address-books"
},
"/address-books/{addressBookId}": {
"$ref": "Admin/AddressBook#/address-books_addressbooksid"
},
"/address-books/{addressBookId}/agents/assigned": {
"$ref": "Admin/AddressBook#/address-books_addressbookid_agents_assigned"
},
"/address-books/{addressBookId}/agents/unassigned": {
"$ref": "Admin/AddressBook#/address-books_addressbookid_agents_unassigned"
},
"/address-books/{addressBookId}/assignment": {
"$ref": "Admin/AddressBook#/address-books_addressbooksid_assignment"
},
"/address-books/{addressBookId}/dynamic-entries": {
"$ref": "Admin/AddressBook#/address-books_addressbooksid_dynamic"
},
"/address-books/{addressBookId}/dynamic-entries/{externalId}": {
"$ref": "Admin/AddressBook#/address-books_addressbooksid_dynamic_external"
},
"/address-books/{addressBookId}/entries": {
"$ref": "Admin/AddressBook#/address-books_addressbooksid_entries"
},
"/address-books/{addressBookId}/entries/{addressBookEntryId}": {
"$ref": "Admin/AddressBook#/address-books_addressbooksid_entries_entryid"
},
"/agents/{agentId}/address-books": {
"$ref": "Admin/AddressBook#/agents_agentId_addressbooks"
},
"/agents": {
"$ref": "Admin/Agents#/agents"
},
"/agents/{agentId|userId}": {
"$ref": "Admin/Agents#/agents_agentId"
},
"/agents/{agentId}/state": {
"$ref": "Admin/Agents#/agents-agentId-state"
},
"/agents/skills": {
"$ref": "Admin/Agents#/agents_skills"
},
"/agents/{agentId}/groups": {
"$ref": "Admin/Agents#/agents_agentid_groups"
},
"/agents/{agentId|userId}/skills": {
"$ref": "Admin/Agents#/agents_agentId_skills"
},
"/agents/{agentId}/skills/unassigned": {
"$ref": "Admin/Agents#/agents-agentId-skills-unassigned"
},
"/agents/skill-data": {
"$ref": "Admin/Agents#/agents_skills_data"
},
"/agents/{agentId}/skill-data": {
"$ref": "Admin/Agents#/agents_agentId_skill_data"
},
"/agents/{agentId}/custom-event": {
"$ref": "Admin/Agents#/agents_agentId_custom-event"
},
"/agents/quick-replies": {
"$ref": "Admin/Agents#/agents_quick_replies"
},
"/agents/{agentId}/quick-replies": {
"$ref": "Admin/Agents#/agents_agentId_quick_replies"
},
"/agents/messages": {
"$ref": "Admin/Agents#/agents_messages"
},
"/agents/messages/{messageId}": {
"$ref": "Admin/Agents#/agents_messages_messageId"
},
"/agents/{agentId}/messages": {
"$ref": "Admin/Agents#/agents_agentId_messages"
},
"/agents/{agentId}/indicators": {
"$ref": "Admin/Agents#/agents_agentId_indicators"
},
"/agents/{agentId}/logout": {
"$ref": "Admin/Agents#/agents_agentId_logout"
},
"/agents/{agentId}/scheduled-callbacks": {
"$ref": "Admin/Commitments#/agents_agentId_scheduled_callbacks"
},
"/agent-patterns": {
"$ref": "Admin/Agents#/agent-patterns"
},
"/agent-patterns/{agentpatternId}/transform-phonenumbers": {
"$ref": "Admin/Agents#/agent-patterns_agentpatternid_transform-phonenumbers"
},
"/agents-states": {
"$ref": "Admin/Agents#/agents_states"
},
"/agents/extended": {
"$ref": "Admin/Agents#/agents_extended"
},
"/agents/issues": {
"$ref": "Admin/Agents#/agents_issues"
},
"/agent-messages/{messageGroupId}": {
"$ref": "Admin/Agents#/agent-messages_messagegroupid"
},
"/agents/skills-download": {
"$ref": "Admin/Agents#/agents_skills-download"
},
"/branding-profiles": {
"$ref": "Admin/General#/branding-profiles"
},
"/business-unit": {
"$ref": "Admin/General#/business_unit"
},
"/business-unit/outbound-routes": {
"$ref": "Admin/General#/business-unit_outbound-routes"
},
"/campaigns": {
"$ref": "Admin/Skills#/campaigns"
},
"/campaigns/{campaignId}": {
"$ref": "Admin/Skills#/campaigns_campaignId"
},
"/campaigns/{campaignId}/address-books": {
"$ref": "Admin/AddressBook#/campaigns_campaignid_addressbooks"
},
"/contacts/{contactId}/chat-transcript": {
"$ref": "Admin/Contacts#/contacts_contactId_chat_transcript"
},
"/contacts/{contactId}/historical-chat-transcript": {
"$ref": "Admin/Contacts#/contacts_contactid_historical-chat-transcript"
},
"/contacts/{contactId}/email-transcript": {
"$ref": "Admin/Contacts#/contacts-contactId-email-transcript"
},
"/contacts/{contactId}/files": {
"$ref": "Admin/Contacts#/contacts_contactId_files"
},
"/contacts/{contactId}/end": {
"$ref": "Admin/Contacts#/contacts_contactId_end"
},
"/contacts/{contactId}/monitor": {
"$ref": "Admin/Contacts#/contacts_contactId_monitor"
},
"/contacts/{contactId}/record": {
"$ref": "Admin/Contacts#/contacts_contactId_record"
},
"/contacts/{contactId}/set-disposition": {
"$ref": "Admin/Contacts#/contacts_contactid_set-disposition"
},
"/contacts/{contactId}/tags": {
"$ref": "Admin/Contacts#/contacts-contactId-tags"
},
"/contact-state-descriptions": {
"$ref": "Admin/Contacts#/contact_state_description"
},
"/contact-state-descriptions/{contactStateId}": {
"$ref": "Admin/Contacts#/contact_state_descriptions_stateId"
},
"/persistent-contacts/{contactId}": {
"$ref": "Admin/Contacts#/persistent-contacts_contactid"
},
"/agents/{agentId}/agent-settings": {
"$ref": "Admin/General#/agents_agentid_agent-settings"
},
"/countries": {
"$ref": "Admin/General#/countries"
},
"/countries/{countryId}/states": {
"$ref": "Admin/General#/countries-countryId-states"
},
"/data-definitions/data-types": {
"$ref": "Admin/General#/data-definitions-data-types"
},
"/dispositions": {
"$ref": "Admin/General#/dispositions"
},
"/dispositions/skills": {
"$ref": "Admin/Skills#/dispositions_skills"
},
"/dispositions/{dispositionId}": {
"$ref": "Admin/Skills#/dispositions_dispositionid"
},
"/dispositions/classifications": {
"$ref": "Admin/Skills#/dispositions_classifications"
},
"/dnc-groups": {
"$ref": "Admin/Lists#/dnc_groups"
},
"/dnc-groups/{groupId}": {
"$ref": "Admin/Lists#/dnc_groups_groupId"
},
"/dnc-groups/{groupId}/contributing-skills": {
"$ref": "Admin/Lists#/dnc_groups_groupId_contributing_skills"
},
"/dnc-groups/{groupId}/contributing-skills/{skillId}": {
"$ref": "Admin/Lists#/dnc_groups_groupId_contributing_skill"
},
"/dnc-groups/{groupId}/records": {
"$ref": "Admin/Lists#/dnc_groups_groupId_records"
},
"/dnc-groups/{groupId}/scrubbed-skills": {
"$ref": "Admin/Lists#/dnc_groups_groupId_scrubbed_skills"
},
"/dnc-groups/{groupId}/scrubbed-skills/{skillId}": {
"$ref": "Admin/Lists#/dnc_groups_groupId_scrubbed_skill"
},
"/dnc-groups/search": {
"$ref": "Admin/Lists#/dnc_groups_search"
},
"/dnis": {
"$ref": "Admin/Lists#/dnis"
},
"/dnis/{dnis}": {
"$ref": "Admin/Lists#/dnis_dnis"
},
"/files": {
"$ref": "Admin/General#/files"
},
"/files/external": {
"$ref": "Admin/General#/files_external"
},
"/folders": {
"$ref": "Admin/General#/folders"
},
"/feedback-categories-and-priorities": {
"$ref": "Admin/General#/feedback_categories_and_priorities"
},
"/groups": {
"$ref": "Admin/Groups#/groups"
},
"/groups/{groupId}": {
"$ref": "Admin/Groups#/groups_groupid"
},
"/groups/{groupId}/agents": {
"$ref": "Admin/Groups#/groups_groupid_agents"
},
"/hiring-sources": {
"$ref": "Admin/General#/hiring-sources"
},
"/hours-of-operation": {
"$ref": "Admin/General#/hours_of_operation"
},
"/hours-of-operation/{profileId}": {
"$ref": "Admin/General#/hours_of_operation_profileId"
},
"/interactions/{contactId}/signal": {
"$ref": "Admin/Contacts#/interactions_contactId_signal"
},
"/lists/call-lists": {
"$ref": "Admin/Lists#/lists_call_lists"
},
"/lists/call-lists/{listId}": {
"$ref": "Admin/Lists#/lists_call_lists_listId"
},
"/lists/call-lists/{listId}/attempts": {
"$ref": "Admin/Lists#/lists_call_lists_listId_attempts"
},
"/lists/call-lists/{listId}/upload": {
"$ref": "Admin/Lists#/lists_call-lists_listId_upload"
},
"/lists/call-lists/{sourceName}/removeProspects": {
"$ref": "Admin/Lists#/lists_call-lists_sourcename_removeprospects"
},
"/locations": {
"$ref": "Admin/General#/locations"
},
"/lists/call-lists/jobs": {
"$ref": "Admin/Lists#/lists_call-lists_jobs"
},
"/lists/call-lists/jobs/{jobId}": {
"$ref": "Admin/Lists#/lists_call-lists_jobs_jobid"
},
"/media-types": {
"$ref": "Admin/General#/media_types"
},
"/media-types/{mediaTypeId}": {
"$ref": "Admin/General#/media_types_mediaTypeId"
},
"/message-templates": {
"$ref": "Admin/General#/message-templates"
},
"/message-templates/{templateId}": {
"$ref": "Admin/General#/message-templates-templateId"
},
"/permissions": {
"$ref": "Admin/General#/permissions"
},
"/permissions/{agentId}": {
"$ref": "Admin/General#/permissions_agentId"
},
"/phone-codes": {
"$ref": "Admin/General#/phone-codes"
},
"/points-of-contact": {
"$ref": "Admin/General#/points_of_contact"
},
"/points-of-contact/{pointOfContactId}": {
"$ref": "Admin/General#/points_of_contact_pointOfContactId"
},
"/security-profiles": {
"$ref": "Admin/General#/security-profiles"
},
"/security-profiles/{profileId}": {
"$ref": "Admin/General#/security-profiles-profileId"
},
"/scripts": {
"$ref": "Admin/General#/scripts"
},
"/scripts/{scriptId}": {
"$ref": "Admin/General#/scripts_scriptid"
},
"/scripts/search": {
"$ref": "Admin/General#/scripts_search"
},
"/scripts/files": {
"$ref": "Admin/General#/scripts%2Ffiles"
},
"/scripts/files/search": {
"$ref": "Admin/General#/scripts%2Ffiles%2Fsearch"
},
"/scripts/kick": {
"$ref": "Admin/General#/scripts_kick"
},
"/scripts/historyByName": {
"$ref": "Admin/General#/scripts_historyByName"
},
"/scripts/{scriptId}/start": {
"$ref": "Admin/General#/script_scriptId_start"
},
"/scheduled-callbacks": {
"$ref": "Admin/Commitments#/scheduled_callbacks"
},
"/scheduled-callbacks/{callbackId}": {
"$ref": "Admin/Commitments#/scheduled_callbacks_callbackId"
},
"/server-time": {
"$ref": "Admin/General#/server_time"
},
"/skills/{skillId}/scheduled-callbacks": {
"$ref": "Admin/Commitments#/skills_skillId_scheduled_callbacks"
},
"/skills": {
"$ref": "Admin/Skills#/skills"
},
"/skills/parameters": {
"$ref": "Admin/Skills#/skills_parameters"
},
"/skills/{skillId}": {
"$ref": "Admin/Skills#/skills_skillId"
},
"/skills/{skillId}/parameters": {
"$ref": "Admin/Skills#/skills_skillid_parameters"
},
"/skills/{skillId}/thank-you-page": {
"$ref": "Admin/Skills#/skills_skillid_thank-you-page"
},
"/skills/{skillId}/address-books": {
"$ref": "Admin/AddressBook#/skills_skillid_addressbooks"
},
"/skills/{skillId}/start": {
"$ref": "Admin/Skills#/skills_skillId_start"
},
"/skills/{skillId}/stop": {
"$ref": "Admin/Skills#/skills_skillId_stop"
},
"/skills/agents": {
"$ref": "Admin/Skills#/skills_agents"
},
"/skills/{skillId}/agents": {
"$ref": "Admin/Skills#/skills_skillId_agents"
},
"/skills/{skillId}/agents/{agentId}": {
"$ref": "Admin/Skills#/skills_skillid_agents_agentid"
},
"/skills/{skillId}/agents/unassigned": {
"$ref": "Admin/Skills#/skills-skillId-agents-unassigned"
},
"/skills/call-data": {
"$ref": "Admin/Skills#/skills_call_data"
},
"/skills/{skillId}/call-data": {
"$ref": "Admin/Skills#/skills_skillId_call_data"
},
"/skills/{skillId}/dispositions": {
"$ref": "Admin/Skills#/skills_skillId_dispositions"
},
"/skills/{skillId}/dispositions/unassigned": {
"$ref": "Admin/Skills#/skills-skillId-dispositions-unassigned"
},
"/skills/{skillId}/tags": {
"$ref": "Admin/Skills#/skills-skillId-tags"
},
"/skills/{skillId}/parameters/general-settings": {
"$ref": "Admin/Skills#/skills_skillid_parameters_general-settings"
},
"/skills/{skillId}/parameters/cpa-management": {
"$ref": "Admin/Skills#/skills_skillid_parameters_cpa-management"
},
"/skills/{skillId}/parameters/xs-settings": {
"$ref": "Admin/Skills#/skills_skillid_parameters_xs-settings"
},
"/skills/{skillId}/parameters/delivery-preferences": {
"$ref": "Admin/Skills#/skills_skillid_parameters_delivery-preferences"
},
"/skills/{skillId}/parameters/retry-settings": {
"$ref": "Admin/Skills#/skills_skillid_parameters_retry-settings"
},
"/skills/{skillId}/parameters/schedule-settings": {
"$ref": "Admin/Skills#/skills_skillid_parameters_schedule-settings"
},
"/skills/{skillId}/parameters/cadence-settings": {
"$ref": "Admin/Skills#/skills_skillid_parameters_cadence-settings"
},
"/skills/{skillId}/parameters/time-zones": {
"$ref": "Admin/Skills#/skills_skillid_parameters_time-zones"
},
"/skills/{skillId}/parameters/list-management": {
"$ref": "Admin/Skills#/skills_skillid_parameters_list-management"
},
"/tags": {
"$ref": "Admin/General#/tags"
},
"/tags/{tagId}": {
"$ref": "Admin/General#/tags-tagId"
},
"/teams": {
"$ref": "Admin/Agents#/teams"
},
"/teams/{teamId}": {
"$ref": "Admin/Agents#/teams_teamId"
},
"/teams/agents": {
"$ref": "Admin/Agents#/teams-agents"
},
"/teams/{teamId}/address-books": {
"$ref": "Admin/AddressBook#/teams_teamid_addressbooks"
},
"/teams/{teamId}/agents": {
"$ref": "Admin/Agents#/teams-teamId-agents"
},
"/teams/{teamId}/unavailable-codes": {
"$ref": "Admin/Agents#/teams_teamId_unavailable_codes"
},
"/timezones": {
"$ref": "Admin/General#/timezones"
},
"/suppressed-contact": {
"$ref": "Admin/General#/suppressed-contact"
},
"/business-unit/time-zones": {
"$ref": "Admin/General#/business-unit_time-zones"
},
"/unavailable-codes": {
"$ref": "Admin/General#/unavailable_codes"
},
"/unavailable-codes/{unavailableCodeId}": {
"$ref": "Admin/Agents#/unavailable-codes_unavailablecodeId"
},
"/unavailable-codes/{unavailableCodeId}/teams": {
"$ref": "Admin/Agents#/unavailable-codes_unavailablecodeId_teams"
},
"/access-keys": {
"$ref": "Admin/Agents#/access-keys"
},
"/access-keys/{accessKeyId}": {
"$ref": "Admin/Agents#/access-keys_accesskeyId"
},
"/campaigns/{campaignId}/skills": {
"$ref": "Admin/Skills#/campaigns_campaignId_skills"
},
"/contacts/{contactId}/sms-historical-transcript": {
"$ref": "Admin/Contacts#/contacts_contactId_sms-historical-transcript"
},
"/contacts/sms-historical-contacts": {
"$ref": "Admin/Contacts#/contacts_sms-historical-contacts"
},
"/phone-numbers": {
"$ref": "Admin/General#/phone-numbers"
},
"/workflow-data/list/{activeFlag}": {
"$ref": "Admin/WorkflowData#/workflow-data_list_activeFlag"
},
"/workflow-data": {
"$ref": "Admin/WorkflowData#/workflow-data"
},
"/workflow-data/{workflowDataId}": {
"$ref": "Admin/WorkflowData#/workflow-data_workflowDataId"
},
"/workflow-data/{workflowDataId}/deactivate": {
"$ref": "Admin/WorkflowData#/workflow-data_workflowDataId_deactivate"
},
"/workflow-data/{workflowDataId}/activate": {
"$ref": "Admin/WorkflowData#/workflow-data_workflowDataId_activate"
},
"/suppressed-contact/{suppressedContactId}": {
"$ref": "Admin/General#/suppressed-contact_suppressedContactId"
}
}
}