Package com.mypurecloud.sdk.v2.api
Class RoutingApi
java.lang.Object
com.mypurecloud.sdk.v2.api.RoutingApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidDelete single benefit assessment.deleteRoutingAssessment(ApiRequest<Void> request) Delete single benefit assessment.voiddeleteRoutingAssessment(String assessmentId) Delete single benefit assessment.deleteRoutingAssessmentWithHttpInfo(String assessmentId) Delete single benefit assessment.voidDelete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.voiddeleteRoutingDirectroutingbackupSettingsMe(DeleteRoutingDirectroutingbackupSettingsMeRequest request) Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.voidDelete a domaindeleteRoutingEmailDomain(ApiRequest<Void> request) Delete a domainvoiddeleteRoutingEmailDomain(String domainId) Delete a domainvoidDelete a routedeleteRoutingEmailDomainRoute(ApiRequest<Void> request) Delete a routevoiddeleteRoutingEmailDomainRoute(String domainName, String routeId) Delete a routedeleteRoutingEmailDomainRouteWithHttpInfo(String domainName, String routeId) Delete a routedeleteRoutingEmailDomainWithHttpInfo(String domainId) Delete a domainvoidDelete an outbound domaindeleteRoutingEmailOutboundDomain(ApiRequest<Void> request) Delete an outbound domainvoiddeleteRoutingEmailOutboundDomain(String domainId) Delete an outbound domainDelete an outbound domainvoidDelete an email setting.Delete an email setting.voiddeleteRoutingEmailSettingEmailSettingId(String emailSettingId) Delete an email setting.deleteRoutingEmailSettingEmailSettingIdWithHttpInfo(String emailSettingId) Delete an email setting.voidDelete a routing languagedeleteRoutingLanguage(ApiRequest<Void> request) Delete a routing languagevoiddeleteRoutingLanguage(String languageId) Delete a routing languagedeleteRoutingLanguageWithHttpInfo(String languageId) Delete a routing languagevoidDelete single predictor.deleteRoutingPredictor(ApiRequest<Void> request) Delete single predictor.voiddeleteRoutingPredictor(String predictorId) Delete single predictor.voiddeleteRoutingPredictorsKeyperformanceindicator(DeleteRoutingPredictorsKeyperformanceindicatorRequest request) Delete a custom Key Performance Indicator.Delete a custom Key Performance Indicator.voidDelete a custom Key Performance Indicator.Delete a custom Key Performance Indicator.deleteRoutingPredictorWithHttpInfo(String predictorId) Delete single predictor.voidDelete a queuedeleteRoutingQueue(ApiRequest<Void> request) Delete a queuevoiddeleteRoutingQueue(String queueId, Boolean forceDelete) Delete a queuevoidDelete a queue member.deleteRoutingQueueMember(ApiRequest<Void> request) Delete a queue member.voiddeleteRoutingQueueMember(String queueId, String memberId) Delete a queue member.deleteRoutingQueueMemberWithHttpInfo(String queueId, String memberId) Delete a queue member.voidDeprecated.deleteRoutingQueueUser(ApiRequest<Void> request) Deprecated.voiddeleteRoutingQueueUser(String queueId, String memberId) Deprecated.deleteRoutingQueueUserWithHttpInfo(String queueId, String memberId) Deprecated.deleteRoutingQueueWithHttpInfo(String queueId, Boolean forceDelete) Delete a queuevoidDelete a wrap-up code from a queuedeleteRoutingQueueWrapupcode(ApiRequest<Void> request) Delete a wrap-up code from a queuevoiddeleteRoutingQueueWrapupcode(String queueId, String codeId) Delete a wrap-up code from a queuedeleteRoutingQueueWrapupcodeWithHttpInfo(String queueId, String codeId) Delete a wrap-up code from a queuevoidDelete an organization's routing settingsvoidDelete an organization's routing settingsdeleteRoutingSettings(ApiRequest<Void> request) Delete an organization's routing settingsDelete an organization's routing settingsvoidDelete Routing SkilldeleteRoutingSkill(ApiRequest<Void> request) Delete Routing SkillvoiddeleteRoutingSkill(String skillId) Delete Routing SkillvoidArchive a skill expression to remove it from the set of active expressionsdeleteRoutingSkillexpression(ApiRequest<Void> request) Archive a skill expression to remove it from the set of active expressionsvoiddeleteRoutingSkillexpression(String expressionId) Archive a skill expression to remove it from the set of active expressionsvoidArchive a set of skill expressions to remove them from the set of active expressionsdeleteRoutingSkillexpressions(ApiRequest<Void> request) Archive a set of skill expressions to remove them from the set of active expressionsvoidArchive a set of skill expressions to remove them from the set of active expressionsArchive a set of skill expressions to remove them from the set of active expressionsdeleteRoutingSkillexpressionWithHttpInfo(String expressionId) Archive a skill expression to remove it from the set of active expressionsvoidRemove skill group definitiondeleteRoutingSkillgroup(ApiRequest<Void> request) Remove skill group definitionvoiddeleteRoutingSkillgroup(String skillGroupId) Remove skill group definitiondeleteRoutingSkillgroupWithHttpInfo(String skillGroupId) Remove skill group definitiondeleteRoutingSkillWithHttpInfo(String skillId) Delete Routing SkillvoidDelete an Address by Id for SMSdeleteRoutingSmsAddress(ApiRequest<Void> request) Delete an Address by Id for SMSvoiddeleteRoutingSmsAddress(String addressId) Delete an Address by Id for SMSdeleteRoutingSmsAddressWithHttpInfo(String addressId) Delete an Address by Id for SMSvoidDelete a phone number provisioned for SMS.deleteRoutingSmsPhonenumber(ApiRequest<Void> request) Delete a phone number provisioned for SMS.voiddeleteRoutingSmsPhonenumber(String phoneNumberId) Delete a phone number provisioned for SMS.deleteRoutingSmsPhonenumberWithHttpInfo(String phoneNumberId) Delete a phone number provisioned for SMS.voiddeleteRoutingUserDirectroutingbackupSettings(DeleteRoutingUserDirectroutingbackupSettingsRequest request) Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.voidDelete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.voidDelete the user's max utilization settings and revert to the organization-wide default.deleteRoutingUserUtilization(ApiRequest<Void> request) Delete the user's max utilization settings and revert to the organization-wide default.voiddeleteRoutingUserUtilization(String userId) Delete the user's max utilization settings and revert to the organization-wide default.Delete the user's max utilization settings and revert to the organization-wide default.voidDelete the organization-wide max utilization settings and revert to the system default.voidDelete the organization-wide max utilization settings and revert to the system default.deleteRoutingUtilization(ApiRequest<Void> request) Delete the organization-wide max utilization settings and revert to the system default.voidDelete a utilization labeldeleteRoutingUtilizationLabel(ApiRequest<Void> request) Delete a utilization labelvoiddeleteRoutingUtilizationLabel(String labelId, Boolean forceDelete) Delete a utilization labeldeleteRoutingUtilizationLabelWithHttpInfo(String labelId, Boolean forceDelete) Delete a utilization labelDelete the organization-wide max utilization settings and revert to the system default.voidDelete wrap-up codedeleteRoutingWrapupcode(ApiRequest<Void> request) Delete wrap-up codevoiddeleteRoutingWrapupcode(String codeId) Delete wrap-up codeDelete wrap-up codevoidRemove a routing language from a userdeleteUserRoutinglanguage(ApiRequest<Void> request) Remove a routing language from a uservoiddeleteUserRoutinglanguage(String userId, String languageId) Remove a routing language from a userdeleteUserRoutinglanguageWithHttpInfo(String userId, String languageId) Remove a routing language from a uservoidRemove a routing skill from a userdeleteUserRoutingskill(ApiRequest<Void> request) Remove a routing skill from a uservoiddeleteUserRoutingskill(String userId, String skillId) Remove a routing skill from a userdeleteUserRoutingskillWithHttpInfo(String userId, String skillId) Remove a routing skill from a userRetrieve a single benefit assessment.getRoutingAssessment(ApiRequest<Void> request) Retrieve a single benefit assessment.getRoutingAssessment(String assessmentId) Retrieve a single benefit assessment.Retrieve all benefit assessments.getRoutingAssessments(ApiRequest<Void> request) Retrieve all benefit assessments.getRoutingAssessments(String before, String after, String limit, String pageSize, List<String> queueId) Retrieve all benefit assessments.Retrieve a single benefit assessments job.getRoutingAssessmentsJob(ApiRequest<Void> request) Retrieve a single benefit assessments job.getRoutingAssessmentsJob(String jobId) Retrieve a single benefit assessments job.Retrieve all benefit assessment jobs.getRoutingAssessmentsJobs(ApiRequest<Void> request) Retrieve all benefit assessment jobs.getRoutingAssessmentsJobs(List<String> divisionId) Retrieve all benefit assessment jobs.getRoutingAssessmentsJobsWithHttpInfo(List<String> divisionId) Retrieve all benefit assessment jobs.Retrieve a single benefit assessments job.getRoutingAssessmentsWithHttpInfo(String before, String after, String limit, String pageSize, List<String> queueId) Retrieve all benefit assessments.getRoutingAssessmentWithHttpInfo(String assessmentId) Retrieve a single benefit assessment.Get available media typesGet available media typesgetRoutingAvailablemediatypes(ApiRequest<Void> request) Get available media typesGet available media typesGet the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get domaingetRoutingEmailDomain(ApiRequest<Void> request) Get domaingetRoutingEmailDomain(String domainId, String expand) Get domainGet domain dkim settingsgetRoutingEmailDomainDkim(ApiRequest<Void> request) Get domain dkim settingsgetRoutingEmailDomainDkim(String domainId) Get domain dkim settingsgetRoutingEmailDomainDkimWithHttpInfo(String domainId) Get domain dkim settingsGet domain mail from settingsgetRoutingEmailDomainMailfrom(ApiRequest<Void> request) Get domain mail from settingsgetRoutingEmailDomainMailfrom(String domainId) Get domain mail from settingsGet domain mail from settingsGet a routegetRoutingEmailDomainRoute(ApiRequest<Void> request) Get a routegetRoutingEmailDomainRoute(String domainName, String routeId, List<String> expand) Get a routegetRoutingEmailDomainRouteIdentityresolution(GetRoutingEmailDomainRouteIdentityresolutionRequest request) Get a route identity resolution setting.Get a route identity resolution setting.getRoutingEmailDomainRouteIdentityresolution(String domainName, String routeId) Get a route identity resolution setting.getRoutingEmailDomainRouteIdentityresolutionWithHttpInfo(String domainName, String routeId) Get a route identity resolution setting.Get routesgetRoutingEmailDomainRoutes(ApiRequest<Void> request) Get routesgetRoutingEmailDomainRoutes(String domainName, Integer pageSize, Integer pageNumber, String pattern, List<String> expand) Get routesgetRoutingEmailDomainRoutesWithHttpInfo(String domainName, Integer pageSize, Integer pageNumber, String pattern, List<String> expand) Get routesgetRoutingEmailDomainRouteWithHttpInfo(String domainName, String routeId, List<String> expand) Get a routeGet domainsgetRoutingEmailDomains(ApiRequest<Void> request) Get domainsgetRoutingEmailDomains(Integer pageSize, Integer pageNumber, Boolean excludeStatus, String filter, String expand) Get domainsgetRoutingEmailDomainsWithHttpInfo(Integer pageSize, Integer pageNumber, Boolean excludeStatus, String filter, String expand) Get domainsGet domain verification settingsgetRoutingEmailDomainVerification(ApiRequest<Void> request) Get domain verification settingsgetRoutingEmailDomainVerification(String domainId) Get domain verification settingsGet domain verification settingsgetRoutingEmailDomainWithHttpInfo(String domainId, String expand) Get domainGet domaingetRoutingEmailOutboundDomain(ApiRequest<Void> request) Get domaingetRoutingEmailOutboundDomain(String domainId, String expand) Get domainGet activation status (cname + dkim) of an outbound domainGet activation status (cname + dkim) of an outbound domainGet activation status (cname + dkim) of an outbound domainGet activation status (cname + dkim) of an outbound domainGet outbound domainsgetRoutingEmailOutboundDomains(ApiRequest<Void> request) Get outbound domainsgetRoutingEmailOutboundDomains(Integer pageSize, Integer pageNumber, String filter, String expand) Get outbound domainsgetRoutingEmailOutboundDomainsWithHttpInfo(Integer pageSize, Integer pageNumber, String filter, String expand) Get outbound domainsgetRoutingEmailOutboundDomainWithHttpInfo(String domainId, String expand) Get domainGet a paged list of email routing settings.getRoutingEmailSetting(ApiRequest<Void> request) Get a paged list of email routing settings.getRoutingEmailSetting(Integer pageSize, Integer pageNumber) Get a paged list of email routing settings.Get email setting.Get email setting.getRoutingEmailSettingEmailSettingId(String emailSettingId) Get email setting.getRoutingEmailSettingEmailSettingIdWithHttpInfo(String emailSettingId) Get email setting.getRoutingEmailSettingWithHttpInfo(Integer pageSize, Integer pageNumber) Get a paged list of email routing settings.Get email setupGet email setupgetRoutingEmailSetup(ApiRequest<Void> request) Get email setupGet email setupGet a routing languagegetRoutingLanguage(ApiRequest<Void> request) Get a routing languagegetRoutingLanguage(String languageId) Get a routing languageGet the list of supported languages.getRoutingLanguages(ApiRequest<Void> request) Get the list of supported languages.getRoutingLanguages(Integer pageSize, Integer pageNumber, String sortOrder, String name, List<String> id) Get the list of supported languages.getRoutingLanguagesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortOrder, String name, List<String> id) Get the list of supported languages.getRoutingLanguageWithHttpInfo(String languageId) Get a routing languageGet a recipientgetRoutingMessageRecipient(ApiRequest<Void> request) Get a recipientgetRoutingMessageRecipient(String recipientId) Get a recipientGet recipientsgetRoutingMessageRecipients(ApiRequest<Void> request) Get recipientsgetRoutingMessageRecipients(String messengerType, String name, Integer pageSize, Integer pageNumber) Get recipientsgetRoutingMessageRecipientsWithHttpInfo(String messengerType, String name, Integer pageSize, Integer pageNumber) Get recipientsgetRoutingMessageRecipientWithHttpInfo(String recipientId) Get a recipientRetrieve a single predictor.getRoutingPredictor(ApiRequest<Void> request) Retrieve a single predictor.getRoutingPredictor(String predictorId) Retrieve a single predictor.Retrieve Predictor Model Features.getRoutingPredictorModelFeatures(ApiRequest<Void> request) Retrieve Predictor Model Features.getRoutingPredictorModelFeatures(String predictorId, String modelId) Retrieve Predictor Model Features.getRoutingPredictorModelFeaturesWithHttpInfo(String predictorId, String modelId) Retrieve Predictor Model Features.Retrieve Predictor Models and Top Features.getRoutingPredictorModels(ApiRequest<Void> request) Retrieve Predictor Models and Top Features.getRoutingPredictorModels(String predictorId) Retrieve Predictor Models and Top Features.getRoutingPredictorModelsWithHttpInfo(String predictorId) Retrieve Predictor Models and Top Features.Retrieve all predictors.getRoutingPredictors(ApiRequest<Void> request) Retrieve all predictors.getRoutingPredictors(String before, String after, String limit, String pageSize, List<String> queueId, String kpiId, String state) Retrieve all predictors.getRoutingPredictorsKeyperformanceindicator(GetRoutingPredictorsKeyperformanceindicatorRequest request) Retrieve a single Key Performance Indicator.Retrieve a single Key Performance Indicator.getRoutingPredictorsKeyperformanceindicator(String kpiId, List<String> expand) Retrieve a single Key Performance Indicator.getRoutingPredictorsKeyperformanceindicators(GetRoutingPredictorsKeyperformanceindicatorsRequest request) Get a list of Key Performance IndicatorsGet a list of Key Performance IndicatorsgetRoutingPredictorsKeyperformanceindicators(String kpiGroup, List<String> expand) Get a list of Key Performance IndicatorsgetRoutingPredictorsKeyperformanceindicatorsWithHttpInfo(String kpiGroup, List<String> expand) Get a list of Key Performance IndicatorsGet a list of Key Performance Indicators Types available.getRoutingPredictorsKeyperformanceindicatortypes(GetRoutingPredictorsKeyperformanceindicatortypesRequest request) Get a list of Key Performance Indicators Types available.Get a list of Key Performance Indicators Types available.Get a list of Key Performance Indicators Types available.getRoutingPredictorsKeyperformanceindicatorWithHttpInfo(String kpiId, List<String> expand) Retrieve a single Key Performance Indicator.getRoutingPredictorsWithHttpInfo(String before, String after, String limit, String pageSize, List<String> queueId, String kpiId, String state) Retrieve all predictors.getRoutingPredictorWithHttpInfo(String predictorId) Retrieve a single predictor.getRoutingQueue(GetRoutingQueueRequest request) Get details about this queue.getRoutingQueue(ApiRequest<Void> request) Get details about this queue.getRoutingQueue(String queueId, List<String> expand) Get details about this queue.Get an assistant associated with a queue.getRoutingQueueAssistant(ApiRequest<Void> request) Get an assistant associated with a queue.getRoutingQueueAssistant(String queueId, List<String> expand, String languageVariation, Boolean fallbackToPrimaryAssistant) Get an assistant associated with a queue.getRoutingQueueAssistantWithHttpInfo(String queueId, List<String> expand, String languageVariation, Boolean fallbackToPrimaryAssistant) Get an assistant associated with a queue.Get a Comparison Period.getRoutingQueueComparisonperiod(ApiRequest<Void> request) Get a Comparison Period.getRoutingQueueComparisonperiod(String queueId, String comparisonPeriodId) Get a Comparison Period.Get list of comparison periodsgetRoutingQueueComparisonperiods(ApiRequest<Void> request) Get list of comparison periodsgetRoutingQueueComparisonperiods(String queueId) Get list of comparison periodsGet list of comparison periodsgetRoutingQueueComparisonperiodWithHttpInfo(String queueId, String comparisonPeriodId) Get a Comparison Period.Get Estimated Wait TimegetRoutingQueueEstimatedwaittime(ApiRequest<Void> request) Get Estimated Wait TimegetRoutingQueueEstimatedwaittime(String queueId, String conversationId) Get Estimated Wait TimegetRoutingQueueEstimatedwaittimeWithHttpInfo(String queueId, String conversationId) Get Estimated Wait TimeGet Queue IdentityResolution Settings.getRoutingQueueIdentityresolution(ApiRequest<Void> request) Get Queue IdentityResolution Settings.getRoutingQueueIdentityresolution(String queueId) Get Queue IdentityResolution Settings.Get Queue IdentityResolution Settings.Get Estimated Wait TimeGet Estimated Wait TimegetRoutingQueueMediatypeEstimatedwaittime(String queueId, String mediaType, String labelId) Get Estimated Wait TimegetRoutingQueueMediatypeEstimatedwaittimeWithHttpInfo(String queueId, String mediaType, String labelId) Get Estimated Wait TimeGet the members of this queue.getRoutingQueueMembers(ApiRequest<Void> request) Get the members of this queue.getRoutingQueueMembers(String queueId, Integer pageNumber, Integer pageSize, String sortOrder, List<String> expand, String name, List<String> profileSkills, List<String> skills, List<String> languages, List<String> routingStatus, List<String> presence, String memberBy, Boolean joined) Get the members of this queue.getRoutingQueueMembersWithHttpInfo(String queueId, Integer pageNumber, Integer pageSize, String sortOrder, List<String> expand, String name, List<String> profileSkills, List<String> skills, List<String> languages, List<String> routingStatus, List<String> presence, String memberBy, Boolean joined) Get the members of this queue.getRoutingQueues(GetRoutingQueuesRequest request) Get list of queues.getRoutingQueues(ApiRequest<Void> request) Get list of queues.getRoutingQueues(Integer pageNumber, Integer pageSize, String sortOrder, String name, List<String> id, List<String> divisionId, List<String> peerId, String cannedResponseLibraryId, Boolean hasPeer, List<String> expand) Get list of queues.Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).getRoutingQueuesDivisionviews(ApiRequest<Void> request) Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).getRoutingQueuesDivisionviews(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id, List<String> divisionId) Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).Get a paged listing of simplified queue objects, sorted by name.getRoutingQueuesDivisionviewsAll(ApiRequest<Void> request) Get a paged listing of simplified queue objects, sorted by name.getRoutingQueuesDivisionviewsAll(Integer pageSize, Integer pageNumber, String sortOrder) Get a paged listing of simplified queue objects, sorted by name.getRoutingQueuesDivisionviewsAllWithHttpInfo(Integer pageSize, Integer pageNumber, String sortOrder) Get a paged listing of simplified queue objects, sorted by name.getRoutingQueuesDivisionviewsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id, List<String> divisionId) Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).Get a paged listing of queues the user is a member of.getRoutingQueuesMe(ApiRequest<Void> request) Get a paged listing of queues the user is a member of.getRoutingQueuesMe(Integer pageNumber, Integer pageSize, Boolean joined, String sortOrder) Get a paged listing of queues the user is a member of.getRoutingQueuesMeWithHttpInfo(Integer pageNumber, Integer pageSize, Boolean joined, String sortOrder) Get a paged listing of queues the user is a member of.getRoutingQueuesWithHttpInfo(Integer pageNumber, Integer pageSize, String sortOrder, String name, List<String> id, List<String> divisionId, List<String> peerId, String cannedResponseLibraryId, Boolean hasPeer, List<String> expand) Get list of queues.Deprecated.getRoutingQueueUsers(ApiRequest<Void> request) Deprecated.getRoutingQueueUsers(String queueId, Integer pageNumber, Integer pageSize, String sortOrder, List<String> expand, Boolean joined, String name, List<String> profileSkills, List<String> skills, List<String> languages, List<String> routingStatus, List<String> presence) Deprecated.getRoutingQueueUsersWithHttpInfo(String queueId, Integer pageNumber, Integer pageSize, String sortOrder, List<String> expand, Boolean joined, String name, List<String> profileSkills, List<String> skills, List<String> languages, List<String> routingStatus, List<String> presence) Deprecated.getRoutingQueueWithHttpInfo(String queueId, List<String> expand) Get details about this queue.Get the wrap-up codes for a queuegetRoutingQueueWrapupcodes(ApiRequest<Void> request) Get the wrap-up codes for a queuegetRoutingQueueWrapupcodes(String queueId, Integer pageSize, Integer pageNumber, String name) Get the wrap-up codes for a queuegetRoutingQueueWrapupcodesWithHttpInfo(String queueId, Integer pageSize, Integer pageNumber, String name) Get the wrap-up codes for a queueGet an organization's routing settingsGet an organization's routing settingsgetRoutingSettings(ApiRequest<Void> request) Get an organization's routing settingsGet Contact Center SettingsGet Contact Center SettingsgetRoutingSettingsContactcenter(ApiRequest<Void> request) Get Contact Center SettingsGet Contact Center SettingsGet Transcription SettingsGet Transcription SettingsgetRoutingSettingsTranscription(ApiRequest<Void> request) Get Transcription SettingsGet Transcription SettingsGet an organization's routing settingsgetRoutingSkill(GetRoutingSkillRequest request) Get Routing SkillgetRoutingSkill(ApiRequest<Void> request) Get Routing SkillgetRoutingSkill(String skillId) Get Routing SkillGet a skill expression by IDgetRoutingSkillexpression(ApiRequest<Void> request) Get a skill expression by IDgetRoutingSkillexpression(String expressionId, Boolean includeArchived, String format) Get a skill expression by IDGet skill expressionsgetRoutingSkillexpressions(ApiRequest<Void> request) Get skill expressionsgetRoutingSkillexpressions(String format, Boolean includeArchived, List<String> id) Get skill expressionsGet skill expressions associated with a queueGet skill expressions associated with a queuegetRoutingSkillexpressionsQueueQueueId(String queueId, String format, Boolean includeArchived) Get skill expressions associated with a queuegetRoutingSkillexpressionsQueueQueueIdWithHttpInfo(String queueId, String format, Boolean includeArchived) Get skill expressions associated with a queuegetRoutingSkillexpressionsWithHttpInfo(String format, Boolean includeArchived, List<String> id) Get skill expressionsgetRoutingSkillexpressionWithHttpInfo(String expressionId, Boolean includeArchived, String format) Get a skill expression by IDGet skill groupgetRoutingSkillgroup(ApiRequest<Void> request) Get skill groupgetRoutingSkillgroup(String skillGroupId) Get skill groupGet skill group membersgetRoutingSkillgroupMembers(ApiRequest<Void> request) Get skill group membersgetRoutingSkillgroupMembers(String skillGroupId, Integer pageSize, String after, String before, String expand) Get skill group membersGet list of member divisions for this skill group.Get list of member divisions for this skill group.getRoutingSkillgroupMembersDivisions(String skillGroupId, String expand) Get list of member divisions for this skill group.getRoutingSkillgroupMembersDivisionsWithHttpInfo(String skillGroupId, String expand) Get list of member divisions for this skill group.getRoutingSkillgroupMembersWithHttpInfo(String skillGroupId, Integer pageSize, String after, String before, String expand) Get skill group membersGet skill group listinggetRoutingSkillgroups(ApiRequest<Void> request) Get skill group listinggetRoutingSkillgroups(Integer pageSize, String name, String after, String before) Get skill group listinggetRoutingSkillgroupsWithHttpInfo(Integer pageSize, String name, String after, String before) Get skill group listinggetRoutingSkillgroupWithHttpInfo(String skillGroupId) Get skill groupgetRoutingSkills(GetRoutingSkillsRequest request) Get the list of routing skills.getRoutingSkills(ApiRequest<Void> request) Get the list of routing skills.Get the list of routing skills.Get the list of routing skills.getRoutingSkillWithHttpInfo(String skillId) Get Routing SkillGet an Address by Id for SMSgetRoutingSmsAddress(ApiRequest<Void> request) Get an Address by Id for SMSgetRoutingSmsAddress(String addressId) Get an Address by Id for SMSGet a list of Addresses for SMSgetRoutingSmsAddresses(ApiRequest<Void> request) Get a list of Addresses for SMSgetRoutingSmsAddresses(Integer pageSize, Integer pageNumber) Get a list of Addresses for SMSgetRoutingSmsAddressesWithHttpInfo(Integer pageSize, Integer pageNumber) Get a list of Addresses for SMSgetRoutingSmsAddressWithHttpInfo(String addressId) Get an Address by Id for SMSGet a list of available phone numbers for SMS provisioning.getRoutingSmsAvailablephonenumbers(ApiRequest<Void> request) Get a list of available phone numbers for SMS provisioning.getRoutingSmsAvailablephonenumbers(String countryCode, String phoneNumberType, String region, String city, String areaCode, String pattern, String addressRequirement) Get a list of available phone numbers for SMS provisioning.getRoutingSmsAvailablephonenumbersWithHttpInfo(String countryCode, String phoneNumberType, String region, String city, String areaCode, String pattern, String addressRequirement) Get a list of available phone numbers for SMS provisioning.getRoutingSmsIdentityresolutionPhonenumber(GetRoutingSmsIdentityresolutionPhonenumberRequest request) Get a SMS identity resolution settings.Get a SMS identity resolution settings.getRoutingSmsIdentityresolutionPhonenumber(String addressId) Get a SMS identity resolution settings.Get a SMS identity resolution settings.Get a phone number provisioned for SMS.getRoutingSmsPhonenumber(ApiRequest<Void> request) Get a phone number provisioned for SMS.getRoutingSmsPhonenumber(String phoneNumberId, String expand) Get a phone number provisioned for SMS.Get a list of provisioned phone numbers.getRoutingSmsPhonenumbers(ApiRequest<Void> request) Get a list of provisioned phone numbers.getRoutingSmsPhonenumbers(String phoneNumber, List<String> phoneNumberType, List<String> phoneNumberStatus, List<String> countryCode, Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String language, String integrationId, String supportedContentId, List<String> expand) Get a list of provisioned phone numbers.getRoutingSmsPhonenumbersWithHttpInfo(String phoneNumber, List<String> phoneNumberType, List<String> phoneNumberStatus, List<String> countryCode, Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String language, String integrationId, String supportedContentId, List<String> expand) Get a list of provisioned phone numbers.getRoutingSmsPhonenumberWithHttpInfo(String phoneNumberId, String expand) Get a phone number provisioned for SMS.Get the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get the user's max utilization settings.getRoutingUserUtilization(ApiRequest<Void> request) Get the user's max utilization settings.getRoutingUserUtilization(String userId) Get the user's max utilization settings.Get the user's max utilization settings.Get the organization-wide max utilization settings.Get the organization-wide max utilization settings.getRoutingUtilization(ApiRequest<Void> request) Get the organization-wide max utilization settings.Get details about this utilization labelgetRoutingUtilizationLabel(ApiRequest<Void> request) Get details about this utilization labelgetRoutingUtilizationLabel(String labelId) Get details about this utilization labelGet list of agent ids associated with a utilization labelgetRoutingUtilizationLabelAgents(ApiRequest<Void> request) Get list of agent ids associated with a utilization labelgetRoutingUtilizationLabelAgents(String labelId) Get list of agent ids associated with a utilization labelGet list of agent ids associated with a utilization labelGet list of utilization labelsgetRoutingUtilizationLabels(ApiRequest<Void> request) Get list of utilization labelsgetRoutingUtilizationLabels(Integer pageSize, Integer pageNumber, String sortOrder, String name) Get list of utilization labelsgetRoutingUtilizationLabelsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortOrder, String name) Get list of utilization labelsGet details about this utilization labelGet the organization-wide max utilization settings.Get details about this wrap-up code.getRoutingWrapupcode(ApiRequest<Void> request) Get details about this wrap-up code.getRoutingWrapupcode(String codeId) Get details about this wrap-up code.Get list of wrapup codes.getRoutingWrapupcodes(ApiRequest<Void> request) Get list of wrapup codes.getRoutingWrapupcodes(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id, List<String> divisionId) Get list of wrapup codes.Get a simplified wrap-up code.getRoutingWrapupcodesDivisionview(ApiRequest<Void> request) Get a simplified wrap-up code.Get a simplified wrap-up code.Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).getRoutingWrapupcodesDivisionviews(ApiRequest<Void> request) Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).getRoutingWrapupcodesDivisionviews(Integer pageSize, Integer pageNumber, String name, List<String> id, List<String> divisionId, String includeState) Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).getRoutingWrapupcodesDivisionviewsWithHttpInfo(Integer pageSize, Integer pageNumber, String name, List<String> id, List<String> divisionId, String includeState) Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).Get a simplified wrap-up code.getRoutingWrapupcodesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id, List<String> divisionId) Get list of wrapup codes.Get details about this wrap-up code.getUserQueues(GetUserQueuesRequest request) Get queues for usergetUserQueues(ApiRequest<Void> request) Get queues for usergetUserQueues(String userId, Integer pageSize, Integer pageNumber, Boolean joined, List<String> divisionId) Get queues for usergetUserQueuesWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, Boolean joined, List<String> divisionId) Get queues for userList routing languages assigned to a usergetUserRoutinglanguages(ApiRequest<Void> request) List routing languages assigned to a usergetUserRoutinglanguages(String userId, Integer pageSize, Integer pageNumber, String sortOrder) List routing languages assigned to a usergetUserRoutinglanguagesWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, String sortOrder) List routing languages assigned to a userList routing skills assigned to a usergetUserRoutingskills(ApiRequest<Void> request) List routing skills assigned to a usergetUserRoutingskills(String userId, Integer pageSize, Integer pageNumber, String sortOrder) List routing skills assigned to a usergetUserRoutingskillsWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, String sortOrder) List routing skills assigned to a userGet skill groups for a usergetUserSkillgroups(ApiRequest<Void> request) Get skill groups for a usergetUserSkillgroups(String userId, Integer pageSize, String after, String before) Get skill groups for a usergetUserSkillgroupsWithHttpInfo(String userId, Integer pageSize, String after, String before) Get skill groups for a userUpdate attributes of an in-queue conversation Returns an object indicating the updated values of all settable attributes.Update attributes of an in-queue conversation Returns an object indicating the updated values of all settable attributes.patchRoutingConversation(String conversationId, RoutingConversationAttributesRequest body) Update attributes of an in-queue conversation Returns an object indicating the updated values of all settable attributes.patchRoutingConversationWithHttpInfo(String conversationId, RoutingConversationAttributesRequest body) Update attributes of an in-queue conversation Returns an object indicating the updated values of all settable attributes.Update domain settingsUpdate domain settingspatchRoutingEmailDomain(String domainId, InboundDomainPatchRequest body) Update domain settingsValidate domain settingsValidate domain settingspatchRoutingEmailDomainValidate(String domainId, InboundDomainPatchRequest body) Validate domain settingsValidate domain settingspatchRoutingEmailDomainWithHttpInfo(String domainId, InboundDomainPatchRequest body) Update domain settingsUpdate configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).patchRoutingEmailOutboundDomain(String domainId, OutboundDomainPatchRequest body) Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).Update an email setting.Update an email setting.patchRoutingEmailSettingEmailSettingId(String emailSettingId, EmailSetting body) Update an email setting.patchRoutingEmailSettingEmailSettingIdWithHttpInfo(String emailSettingId, EmailSetting body) Update an email setting.Update single predictor.Update single predictor.patchRoutingPredictor(String predictorId, PatchPredictorRequest body) Update single predictor.patchRoutingPredictorsKeyperformanceindicator(PatchRoutingPredictorsKeyperformanceindicatorRequest request) Update a custom Key Performance Indicator.Update a custom Key Performance Indicator.Update a custom Key Performance Indicator.Update a custom Key Performance Indicator.patchRoutingPredictorWithHttpInfo(String predictorId, PatchPredictorRequest body) Update single predictor.voidUpdate the ring number OR joined status for a queue member.patchRoutingQueueMember(ApiRequest<QueueMember> request) Update the ring number OR joined status for a queue member.voidpatchRoutingQueueMember(String queueId, String memberId, QueueMember body) Update the ring number OR joined status for a queue member.Join or unjoin a set of up to 100 users for a queue Users can only be joined to queues where they have membership.patchRoutingQueueMembers(ApiRequest<List<QueueMember>> request) Join or unjoin a set of up to 100 users for a queue Users can only be joined to queues where they have membership.patchRoutingQueueMembers(String queueId, List<QueueMember> body) Join or unjoin a set of up to 100 users for a queue Users can only be joined to queues where they have membership.patchRoutingQueueMembersWithHttpInfo(String queueId, List<QueueMember> body) Join or unjoin a set of up to 100 users for a queue Users can only be joined to queues where they have membership.patchRoutingQueueMemberWithHttpInfo(String queueId, String memberId, QueueMember body) Update the ring number OR joined status for a queue member.voidDeprecated.patchRoutingQueueUser(ApiRequest<QueueMember> request) Deprecated.voidpatchRoutingQueueUser(String queueId, String memberId, QueueMember body) Deprecated.Deprecated.patchRoutingQueueUsers(ApiRequest<List<QueueMember>> request) Deprecated.patchRoutingQueueUsers(String queueId, List<QueueMember> body) Deprecated.patchRoutingQueueUsersWithHttpInfo(String queueId, List<QueueMember> body) Deprecated.patchRoutingQueueUserWithHttpInfo(String queueId, String memberId, QueueMember body) Deprecated.voidUpdate Contact Center SettingsUpdate Contact Center SettingsvoidUpdate Contact Center SettingsUpdate Contact Center SettingsPatch Transcription SettingsPatch Transcription SettingsPatch Transcription SettingsPatch Transcription SettingsUpdate Routing Skill DivisionUpdate Routing Skill DivisionpatchRoutingSkill(String skillId, UpdateSkillDivisionRequest body) Update Routing Skill DivisionUpdate skill group definitionpatchRoutingSkillgroup(ApiRequest<SkillGroup> request) Update skill group definitionpatchRoutingSkillgroup(String skillGroupId, SkillGroup body) Update skill group definitionpatchRoutingSkillgroupWithHttpInfo(String skillGroupId, SkillGroup body) Update skill group definitionpatchRoutingSkillWithHttpInfo(String skillId, UpdateSkillDivisionRequest body) Update Routing Skill DivisionUpdate a phone number provisioned for SMS.Update a phone number provisioned for SMS.patchRoutingSmsPhonenumber(String phoneNumberId, SmsPhoneNumberPatchRequest body) Update a phone number provisioned for SMS.patchRoutingSmsPhonenumberWithHttpInfo(String phoneNumberId, SmsPhoneNumberPatchRequest body) Update a phone number provisioned for SMS.patchUserQueue(PatchUserQueueRequest request) Join or unjoin a queue for a userpatchUserQueue(ApiRequest<UserQueue> request) Join or unjoin a queue for a userpatchUserQueue(String queueId, String userId, UserQueue body) Join or unjoin a queue for a userpatchUserQueues(PatchUserQueuesRequest request) Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership.patchUserQueues(ApiRequest<List<UserQueue>> request) Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership.Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership.Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership.patchUserQueueWithHttpInfo(String queueId, String userId, UserQueue body) Join or unjoin a queue for a userUpdate an assigned routing language's proficiencyUpdate an assigned routing language's proficiencypatchUserRoutinglanguage(String userId, String languageId, UserRoutingLanguage body) Update an assigned routing language's proficiencyAssign multiple routing languages to a user.Assign multiple routing languages to a user.patchUserRoutinglanguagesBulk(String userId, List<UserRoutingLanguagePost> body) Assign multiple routing languages to a user.Assign multiple routing languages to a user.patchUserRoutinglanguageWithHttpInfo(String userId, String languageId, UserRoutingLanguage body) Update an assigned routing language's proficiencyAssign multiple routing skills to a userAssign multiple routing skills to a userpatchUserRoutingskillsBulk(String userId, List<UserRoutingSkillPost> body) Assign multiple routing skills to a userpatchUserRoutingskillsBulkWithHttpInfo(String userId, List<UserRoutingSkillPost> body) Assign multiple routing skills to a userQuery for queue observationsQuery for queue observationsQuery for queue observationsQuery for queue observationsQuery for user activity observationsQuery for user activity observationspostAnalyticsRoutingActivityQuery(RoutingActivityQuery body, Integer pageSize, Integer pageNumber) Query for user activity observationspostAnalyticsRoutingActivityQueryWithHttpInfo(RoutingActivityQuery body, Integer pageSize, Integer pageNumber) Query for user activity observationsCreate a benefit assessment.Create a benefit assessment.Create a benefit assessment.Create a benefit assessment job.Create a benefit assessment job.Create a benefit assessment job.Create a benefit assessment job.Create a benefit assessment.Restart domain dkimpostRoutingEmailDomainDkim(ApiRequest<Void> request) Restart domain dkimpostRoutingEmailDomainDkim(String domainId) Restart domain dkimpostRoutingEmailDomainDkimWithHttpInfo(String domainId) Restart domain dkimSet domain mail from settingsSet domain mail from settingspostRoutingEmailDomainMailfrom(String domainId, MailFromResult body) Set domain mail from settingspostRoutingEmailDomainMailfromWithHttpInfo(String domainId, MailFromResult body) Set domain mail from settingsCreate a routeCreate a routepostRoutingEmailDomainRoutes(String domainName, InboundRoute body) Create a routepostRoutingEmailDomainRoutesWithHttpInfo(String domainName, InboundRoute body) Create a routeCreate a domainCreate a domainCreate a domainCreate a domainTests the custom SMTP server integration connection set on this ACD domain The request body is optional.Tests the custom SMTP server integration connection set on this ACD domain The request body is optional.postRoutingEmailDomainTestconnection(String domainId, TestMessage body) Tests the custom SMTP server integration connection set on this ACD domain The request body is optional.postRoutingEmailDomainTestconnectionWithHttpInfo(String domainId, TestMessage body) Tests the custom SMTP server integration connection set on this ACD domain The request body is optional.Restart domain verificationpostRoutingEmailDomainVerification(ApiRequest<Void> request) Restart domain verificationpostRoutingEmailDomainVerification(String domainId) Restart domain verificationRestart domain verificationCreate a domainCreate a domainCreate a domainCreate a simulated domainCreate a simulated domainCreate a simulated domainCreate a simulated domainCreate a domainpostRoutingEmailOutboundDomainTestconnection(PostRoutingEmailOutboundDomainTestconnectionRequest request) Tests the custom SMTP server integration connection set on this outbound domain The request body is optional.Tests the custom SMTP server integration connection set on this outbound domain The request body is optional.postRoutingEmailOutboundDomainTestconnection(String domainId, TestMessage body) Tests the custom SMTP server integration connection set on this outbound domain The request body is optional.Tests the custom SMTP server integration connection set on this outbound domain The request body is optional.Create a new email setting.postRoutingEmailSetting(ApiRequest<EmailSetting> request) Create a new email setting.Create a new email setting.Create a new email setting.Create LanguagepostRoutingLanguages(ApiRequest<Language> request) Create LanguagepostRoutingLanguages(Language body) Create LanguageCreate LanguageCreate a predictor.Create a predictor.Create a predictor.postRoutingPredictorsKeyperformanceindicators(PostRoutingPredictorsKeyperformanceindicatorsRequest request) Create a custom Key Performance Indicator.Create a custom Key Performance Indicator.Create a custom Key Performance Indicator.Create a custom Key Performance Indicator.Create a predictor.voidBulk add or delete up to 100 queue memberspostRoutingQueueMembers(ApiRequest<List<WritableEntity>> request) Bulk add or delete up to 100 queue membersvoidpostRoutingQueueMembers(String queueId, List<WritableEntity> body, Boolean delete) Bulk add or delete up to 100 queue memberspostRoutingQueueMembersWithHttpInfo(String queueId, List<WritableEntity> body, Boolean delete) Bulk add or delete up to 100 queue membersCreate a queuepostRoutingQueues(ApiRequest<CreateQueueRequest> request) Create a queueCreate a queueCreate a queuevoidDeprecated.postRoutingQueueUsers(ApiRequest<List<WritableEntity>> request) Deprecated.voidpostRoutingQueueUsers(String queueId, List<WritableEntity> body, Boolean delete) Deprecated.postRoutingQueueUsersWithHttpInfo(String queueId, List<WritableEntity> body, Boolean delete) Deprecated.Add up to 100 wrap-up codes to a queueAdd up to 100 wrap-up codes to a queuepostRoutingQueueWrapupcodes(String queueId, List<WrapUpCodeReference> body) Add up to 100 wrap-up codes to a queuepostRoutingQueueWrapupcodesWithHttpInfo(String queueId, List<WrapUpCodeReference> body) Add up to 100 wrap-up codes to a queueValidate and normalize a skill expressionValidate and normalize a skill expressionValidate and normalize a skill expressionValidate and normalize a skill expressionvoidAdd or remove member divisions for this skill group.Add or remove member divisions for this skill group.voidpostRoutingSkillgroupMembersDivisions(String skillGroupId, SkillGroupMemberDivisions body) Add or remove member divisions for this skill group.postRoutingSkillgroupMembersDivisionsWithHttpInfo(String skillGroupId, SkillGroupMemberDivisions body) Add or remove member divisions for this skill group.Create a skill groupCreate a skill groupCreate a skill groupCreate a skill groupCreate SkillpostRoutingSkills(ApiRequest<CreateRoutingSkill> request) Create SkillCreate SkillCreate SkillProvision an Address for SMSProvision an Address for SMSProvision an Address for SMSProvision an Address for SMSProvision a phone number for SMS When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile.Provision a phone number for SMS When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile.Provision a phone number for SMS When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile.Provision an alphanumeric number for SMS postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without noticeProvision an alphanumeric number for SMS postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without noticeProvision an alphanumeric number for SMS postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without noticeProvision an alphanumeric number for SMS postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without noticeImports a phone number for SMSImports a phone number for SMSImports a phone number for SMSImports a phone number for SMSProvision a phone number for SMS When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile.Create a utilization labelCreate a utilization labelCreate a utilization labelCreate a utilization labelCreate a wrap-up codeCreate a wrap-up codeCreate a wrap-up codeCreate a wrap-up codeAssign a routing language to a userAssign a routing language to a userpostUserRoutinglanguages(String userId, UserRoutingLanguagePost body) Assign a routing language to a userAssign a routing language to a userAssign a routing skill to a userAssign a routing skill to a userpostUserRoutingskills(String userId, UserRoutingSkillPost body) Assign a routing skill to a userpostUserRoutingskillsWithHttpInfo(String userId, UserRoutingSkillPost body) Assign a routing skill to a userUpdate the user's Direct Routing Backup settings.Update the user's Direct Routing Backup settings.Update the user's Direct Routing Backup settings.Update the user's Direct Routing Backup settings.Update a routeputRoutingEmailDomainRoute(ApiRequest<InboundRoute> request) Update a routeputRoutingEmailDomainRoute(String domainName, String routeId, InboundRoute body) Update a routeputRoutingEmailDomainRouteIdentityresolution(PutRoutingEmailDomainRouteIdentityresolutionRequest request) Update identity resolution settings for a route.Update identity resolution settings for a route.putRoutingEmailDomainRouteIdentityresolution(String domainName, String routeId, RouteIdentityResolutionConfig body) Update identity resolution settings for a route.putRoutingEmailDomainRouteIdentityresolutionWithHttpInfo(String domainName, String routeId, RouteIdentityResolutionConfig body) Update identity resolution settings for a route.putRoutingEmailDomainRouteWithHttpInfo(String domainName, String routeId, InboundRoute body) Update a routeRequest an activation status (cname + dkim) update of an outbound domainRequest an activation status (cname + dkim) update of an outbound domainRequest an activation status (cname + dkim) update of an outbound domainRequest an activation status (cname + dkim) update of an outbound domainUpdate a recipientUpdate a recipientputRoutingMessageRecipient(String recipientId, RecipientRequest body) Update a recipientputRoutingMessageRecipientWithHttpInfo(String recipientId, RecipientRequest body) Update a recipientputRoutingQueue(PutRoutingQueueRequest request) Update a queueputRoutingQueue(ApiRequest<QueueRequest> request) Update a queueputRoutingQueue(String queueId, QueueRequest body) Update a queueUpdate Queue IdentityResolution Settings.Update Queue IdentityResolution Settings.putRoutingQueueIdentityresolution(String queueId, IdentityResolutionQueueConfig body) Update Queue IdentityResolution Settings.Update Queue IdentityResolution Settings.putRoutingQueueWithHttpInfo(String queueId, QueueRequest body) Update a queueUpdate an organization's routing settingsputRoutingSettings(ApiRequest<RoutingSettings> request) Update an organization's routing settingsUpdate an organization's routing settingsUpdate Transcription SettingsUpdate Transcription SettingsUpdate Transcription SettingsUpdate Transcription SettingsUpdate an organization's routing settingsputRoutingSmsIdentityresolutionPhonenumber(PutRoutingSmsIdentityresolutionPhonenumberRequest request) Update an SMS identity resolution settings.Update an SMS identity resolution settings.putRoutingSmsIdentityresolutionPhonenumber(String addressId, SmsIdentityResolutionConfig body) Update an SMS identity resolution settings.putRoutingSmsIdentityresolutionPhonenumberWithHttpInfo(String addressId, SmsIdentityResolutionConfig body) Update an SMS identity resolution settings.Update the user's Direct Routing Backup settings.Update the user's Direct Routing Backup settings.Update the user's Direct Routing Backup settings.putRoutingUserDirectroutingbackupSettingsWithHttpInfo(String userId, AgentDirectRoutingBackupSettings body) Update the user's Direct Routing Backup settings.Update the user's max utilization settings.Update the user's max utilization settings.putRoutingUserUtilization(String userId, UtilizationRequest body) Update the user's max utilization settings.putRoutingUserUtilizationWithHttpInfo(String userId, UtilizationRequest body) Update the user's max utilization settings.Update the organization-wide max utilization settings.Update the organization-wide max utilization settings.Update the organization-wide max utilization settings.Update a utilization labelUpdate a utilization labelputRoutingUtilizationLabel(String labelId, UpdateUtilizationLabelRequest body) Update a utilization labelUpdate a utilization labelUpdate the organization-wide max utilization settings.Update wrap-up codeputRoutingWrapupcode(ApiRequest<WrapupCodeRequest> request) Update wrap-up codeputRoutingWrapupcode(String codeId, WrapupCodeRequest body) Update wrap-up codeputRoutingWrapupcodeWithHttpInfo(String codeId, WrapupCodeRequest body) Update wrap-up codeUpdate an assigned routing skill's proficiencyputUserRoutingskill(ApiRequest<UserRoutingSkill> request) Update an assigned routing skill's proficiencyputUserRoutingskill(String userId, String skillId, UserRoutingSkill body) Update an assigned routing skill's proficiencyAssign multiple routing skills to a user, replacing any current assignmentsAssign multiple routing skills to a user, replacing any current assignmentsputUserRoutingskillsBulk(String userId, List<UserRoutingSkillPost> body) Assign multiple routing skills to a user, replacing any current assignmentsputUserRoutingskillsBulkWithHttpInfo(String userId, List<UserRoutingSkillPost> body) Assign multiple routing skills to a user, replacing any current assignmentsputUserRoutingskillWithHttpInfo(String userId, String skillId, UserRoutingSkill body) Update an assigned routing skill's proficiency
-
Constructor Details
-
RoutingApi
public RoutingApi() -
RoutingApi
-
-
Method Details
-
deleteRoutingAssessment
Delete single benefit assessment.- Parameters:
assessmentId- Benefit Assessment ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingAssessmentWithHttpInfo
public ApiResponse<Void> deleteRoutingAssessmentWithHttpInfo(String assessmentId) throws IOException Delete single benefit assessment.- Parameters:
assessmentId- Benefit Assessment ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingAssessment
public void deleteRoutingAssessment(DeleteRoutingAssessmentRequest request) throws IOException, ApiException Delete single benefit assessment.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingAssessment
Delete single benefit assessment.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingDirectroutingbackupSettingsMe
Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingDirectroutingbackupSettingsMeWithHttpInfo
public ApiResponse<Void> deleteRoutingDirectroutingbackupSettingsMeWithHttpInfo() throws IOExceptionDelete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Throws:
IOException- if the request fails to be processed
-
deleteRoutingDirectroutingbackupSettingsMe
public void deleteRoutingDirectroutingbackupSettingsMe(DeleteRoutingDirectroutingbackupSettingsMeRequest request) throws IOException, ApiException Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingDirectroutingbackupSettingsMe
public ApiResponse<Void> deleteRoutingDirectroutingbackupSettingsMe(ApiRequest<Void> request) throws IOException Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingEmailDomain
Delete a domain- Parameters:
domainId- domain ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingEmailDomainWithHttpInfo
Delete a domain- Parameters:
domainId- domain ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingEmailDomain
public void deleteRoutingEmailDomain(DeleteRoutingEmailDomainRequest request) throws IOException, ApiException Delete a domain- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingEmailDomain
Delete a domain- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingEmailDomainRoute
public void deleteRoutingEmailDomainRoute(String domainName, String routeId) throws IOException, ApiException Delete a route- Parameters:
domainName- email domain (required)routeId- route ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingEmailDomainRouteWithHttpInfo
public ApiResponse<Void> deleteRoutingEmailDomainRouteWithHttpInfo(String domainName, String routeId) throws IOException Delete a route- Parameters:
domainName- email domain (required)routeId- route ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingEmailDomainRoute
public void deleteRoutingEmailDomainRoute(DeleteRoutingEmailDomainRouteRequest request) throws IOException, ApiException Delete a route- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingEmailDomainRoute
Delete a route- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingEmailOutboundDomain
Delete an outbound domain- Parameters:
domainId- domain ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingEmailOutboundDomainWithHttpInfo
public ApiResponse<Void> deleteRoutingEmailOutboundDomainWithHttpInfo(String domainId) throws IOException Delete an outbound domain- Parameters:
domainId- domain ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingEmailOutboundDomain
public void deleteRoutingEmailOutboundDomain(DeleteRoutingEmailOutboundDomainRequest request) throws IOException, ApiException Delete an outbound domain- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingEmailOutboundDomain
public ApiResponse<Void> deleteRoutingEmailOutboundDomain(ApiRequest<Void> request) throws IOException Delete an outbound domain- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingEmailSettingEmailSettingId
public void deleteRoutingEmailSettingEmailSettingId(String emailSettingId) throws IOException, ApiException Delete an email setting. Removes the email setting and its associated settings- Parameters:
emailSettingId- Email Setting ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingEmailSettingEmailSettingIdWithHttpInfo
public ApiResponse<Void> deleteRoutingEmailSettingEmailSettingIdWithHttpInfo(String emailSettingId) throws IOException Delete an email setting. Removes the email setting and its associated settings- Parameters:
emailSettingId- Email Setting ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingEmailSettingEmailSettingId
public void deleteRoutingEmailSettingEmailSettingId(DeleteRoutingEmailSettingEmailSettingIdRequest request) throws IOException, ApiException Delete an email setting. Removes the email setting and its associated settings- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingEmailSettingEmailSettingId
public ApiResponse<Void> deleteRoutingEmailSettingEmailSettingId(ApiRequest<Void> request) throws IOException Delete an email setting. Removes the email setting and its associated settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingLanguage
Delete a routing language- Parameters:
languageId- Language ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingLanguageWithHttpInfo
Delete a routing language- Parameters:
languageId- Language ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingLanguage
public void deleteRoutingLanguage(DeleteRoutingLanguageRequest request) throws IOException, ApiException Delete a routing language- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingLanguage
Delete a routing language- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingPredictor
Delete single predictor.- Parameters:
predictorId- Predictor ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingPredictorWithHttpInfo
Delete single predictor.- Parameters:
predictorId- Predictor ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingPredictor
public void deleteRoutingPredictor(DeleteRoutingPredictorRequest request) throws IOException, ApiException Delete single predictor.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingPredictor
Delete single predictor.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingPredictorsKeyperformanceindicator
public void deleteRoutingPredictorsKeyperformanceindicator(String kpiId) throws IOException, ApiException Delete a custom Key Performance Indicator. deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
kpiId- Key Performance Indicator ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingPredictorsKeyperformanceindicatorWithHttpInfo
public ApiResponse<Void> deleteRoutingPredictorsKeyperformanceindicatorWithHttpInfo(String kpiId) throws IOException Delete a custom Key Performance Indicator. deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
kpiId- Key Performance Indicator ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingPredictorsKeyperformanceindicator
public void deleteRoutingPredictorsKeyperformanceindicator(DeleteRoutingPredictorsKeyperformanceindicatorRequest request) throws IOException, ApiException Delete a custom Key Performance Indicator. deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingPredictorsKeyperformanceindicator
public ApiResponse<Void> deleteRoutingPredictorsKeyperformanceindicator(ApiRequest<Void> request) throws IOException Delete a custom Key Performance Indicator. deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingQueue
public void deleteRoutingQueue(String queueId, Boolean forceDelete) throws IOException, ApiException Delete a queue- Parameters:
queueId- Queue ID (required)forceDelete- forceDelete (optional)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingQueueWithHttpInfo
public ApiResponse<Void> deleteRoutingQueueWithHttpInfo(String queueId, Boolean forceDelete) throws IOException Delete a queue- Parameters:
queueId- Queue ID (required)forceDelete- forceDelete (optional)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingQueue
Delete a queue- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingQueue
Delete a queue- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingQueueMember
public void deleteRoutingQueueMember(String queueId, String memberId) throws IOException, ApiException Delete a queue member.- Parameters:
queueId- Queue ID (required)memberId- Member ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingQueueMemberWithHttpInfo
public ApiResponse<Void> deleteRoutingQueueMemberWithHttpInfo(String queueId, String memberId) throws IOException Delete a queue member.- Parameters:
queueId- Queue ID (required)memberId- Member ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingQueueMember
public void deleteRoutingQueueMember(DeleteRoutingQueueMemberRequest request) throws IOException, ApiException Delete a queue member.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingQueueMember
Delete a queue member.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingQueueUser
public void deleteRoutingQueueUser(String queueId, String memberId) throws IOException, ApiException Deprecated.DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.- Parameters:
queueId- Queue ID (required)memberId- Member ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingQueueUserWithHttpInfo
public ApiResponse<Void> deleteRoutingQueueUserWithHttpInfo(String queueId, String memberId) throws IOException Deprecated.DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.- Parameters:
queueId- Queue ID (required)memberId- Member ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingQueueUser
public void deleteRoutingQueueUser(DeleteRoutingQueueUserRequest request) throws IOException, ApiException Deprecated.DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingQueueUser
Deprecated.DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingQueueWrapupcode
public void deleteRoutingQueueWrapupcode(String queueId, String codeId) throws IOException, ApiException Delete a wrap-up code from a queue- Parameters:
queueId- Queue ID (required)codeId- Code ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingQueueWrapupcodeWithHttpInfo
public ApiResponse<Void> deleteRoutingQueueWrapupcodeWithHttpInfo(String queueId, String codeId) throws IOException Delete a wrap-up code from a queue- Parameters:
queueId- Queue ID (required)codeId- Code ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingQueueWrapupcode
public void deleteRoutingQueueWrapupcode(DeleteRoutingQueueWrapupcodeRequest request) throws IOException, ApiException Delete a wrap-up code from a queue- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingQueueWrapupcode
Delete a wrap-up code from a queue- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSettings
Delete an organization's routing settings- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSettingsWithHttpInfo
Delete an organization's routing settings- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSettings
public void deleteRoutingSettings(DeleteRoutingSettingsRequest request) throws IOException, ApiException Delete an organization's routing settings- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSettings
Delete an organization's routing settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSkill
Delete Routing Skill- Parameters:
skillId- Skill ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSkillWithHttpInfo
Delete Routing Skill- Parameters:
skillId- Skill ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSkill
Delete Routing Skill- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSkill
Delete Routing Skill- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSkillexpression
Archive a skill expression to remove it from the set of active expressions- Parameters:
expressionId- Expression ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSkillexpressionWithHttpInfo
public ApiResponse<Void> deleteRoutingSkillexpressionWithHttpInfo(String expressionId) throws IOException Archive a skill expression to remove it from the set of active expressions- Parameters:
expressionId- Expression ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSkillexpression
public void deleteRoutingSkillexpression(DeleteRoutingSkillexpressionRequest request) throws IOException, ApiException Archive a skill expression to remove it from the set of active expressions- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSkillexpression
Archive a skill expression to remove it from the set of active expressions- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSkillexpressions
Archive a set of skill expressions to remove them from the set of active expressions- Parameters:
id- Expression ID(s) to filter. Repeat for multiple or use comma-separated list. (optional)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSkillexpressionsWithHttpInfo
public ApiResponse<Void> deleteRoutingSkillexpressionsWithHttpInfo(List<String> id) throws IOException Archive a set of skill expressions to remove them from the set of active expressions- Parameters:
id- Expression ID(s) to filter. Repeat for multiple or use comma-separated list. (optional)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSkillexpressions
public void deleteRoutingSkillexpressions(DeleteRoutingSkillexpressionsRequest request) throws IOException, ApiException Archive a set of skill expressions to remove them from the set of active expressions- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSkillexpressions
Archive a set of skill expressions to remove them from the set of active expressions- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSkillgroup
Remove skill group definition- Parameters:
skillGroupId- Skill Group ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSkillgroupWithHttpInfo
public ApiResponse<Void> deleteRoutingSkillgroupWithHttpInfo(String skillGroupId) throws IOException Remove skill group definition- Parameters:
skillGroupId- Skill Group ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSkillgroup
public void deleteRoutingSkillgroup(DeleteRoutingSkillgroupRequest request) throws IOException, ApiException Remove skill group definition- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSkillgroup
Remove skill group definition- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSmsAddress
Delete an Address by Id for SMS- Parameters:
addressId- Address ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSmsAddressWithHttpInfo
Delete an Address by Id for SMS- Parameters:
addressId- Address ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSmsAddress
public void deleteRoutingSmsAddress(DeleteRoutingSmsAddressRequest request) throws IOException, ApiException Delete an Address by Id for SMS- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSmsAddress
Delete an Address by Id for SMS- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSmsPhonenumber
Delete a phone number provisioned for SMS.- Parameters:
phoneNumberId- phone number (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSmsPhonenumberWithHttpInfo
public ApiResponse<Void> deleteRoutingSmsPhonenumberWithHttpInfo(String phoneNumberId) throws IOException Delete a phone number provisioned for SMS.- Parameters:
phoneNumberId- phone number (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingSmsPhonenumber
public void deleteRoutingSmsPhonenumber(DeleteRoutingSmsPhonenumberRequest request) throws IOException, ApiException Delete a phone number provisioned for SMS.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingSmsPhonenumber
Delete a phone number provisioned for SMS.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingUserDirectroutingbackupSettings
public void deleteRoutingUserDirectroutingbackupSettings(String userId) throws IOException, ApiException Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Parameters:
userId- User ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingUserDirectroutingbackupSettingsWithHttpInfo
public ApiResponse<Void> deleteRoutingUserDirectroutingbackupSettingsWithHttpInfo(String userId) throws IOException Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Parameters:
userId- User ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingUserDirectroutingbackupSettings
public void deleteRoutingUserDirectroutingbackupSettings(DeleteRoutingUserDirectroutingbackupSettingsRequest request) throws IOException, ApiException Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingUserDirectroutingbackupSettings
public ApiResponse<Void> deleteRoutingUserDirectroutingbackupSettings(ApiRequest<Void> request) throws IOException Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingUserUtilization
Delete the user's max utilization settings and revert to the organization-wide default.- Parameters:
userId- User ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingUserUtilizationWithHttpInfo
Delete the user's max utilization settings and revert to the organization-wide default.- Parameters:
userId- User ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingUserUtilization
public void deleteRoutingUserUtilization(DeleteRoutingUserUtilizationRequest request) throws IOException, ApiException Delete the user's max utilization settings and revert to the organization-wide default.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingUserUtilization
Delete the user's max utilization settings and revert to the organization-wide default.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingUtilization
Delete the organization-wide max utilization settings and revert to the system default.- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingUtilizationWithHttpInfo
Delete the organization-wide max utilization settings and revert to the system default.- Throws:
IOException- if the request fails to be processed
-
deleteRoutingUtilization
public void deleteRoutingUtilization(DeleteRoutingUtilizationRequest request) throws IOException, ApiException Delete the organization-wide max utilization settings and revert to the system default.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingUtilization
Delete the organization-wide max utilization settings and revert to the system default.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingUtilizationLabel
public void deleteRoutingUtilizationLabel(String labelId, Boolean forceDelete) throws IOException, ApiException Delete a utilization label- Parameters:
labelId- Utilization Label ID (required)forceDelete- Remove all label usages (if found) without warning (optional, default to false)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingUtilizationLabelWithHttpInfo
public ApiResponse<Void> deleteRoutingUtilizationLabelWithHttpInfo(String labelId, Boolean forceDelete) throws IOException Delete a utilization label- Parameters:
labelId- Utilization Label ID (required)forceDelete- Remove all label usages (if found) without warning (optional, default to false)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingUtilizationLabel
public void deleteRoutingUtilizationLabel(DeleteRoutingUtilizationLabelRequest request) throws IOException, ApiException Delete a utilization label- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingUtilizationLabel
Delete a utilization label- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingWrapupcode
Delete wrap-up code- Parameters:
codeId- Wrapup Code ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingWrapupcodeWithHttpInfo
Delete wrap-up code- Parameters:
codeId- Wrapup Code ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingWrapupcode
public void deleteRoutingWrapupcode(DeleteRoutingWrapupcodeRequest request) throws IOException, ApiException Delete wrap-up code- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingWrapupcode
Delete wrap-up code- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUserRoutinglanguage
public void deleteUserRoutinglanguage(String userId, String languageId) throws IOException, ApiException Remove a routing language from a user- Parameters:
userId- User ID (required)languageId- languageId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserRoutinglanguageWithHttpInfo
public ApiResponse<Void> deleteUserRoutinglanguageWithHttpInfo(String userId, String languageId) throws IOException Remove a routing language from a user- Parameters:
userId- User ID (required)languageId- languageId (required)- Throws:
IOException- if the request fails to be processed
-
deleteUserRoutinglanguage
public void deleteUserRoutinglanguage(DeleteUserRoutinglanguageRequest request) throws IOException, ApiException Remove a routing language from a user- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserRoutinglanguage
Remove a routing language from a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUserRoutingskill
Remove a routing skill from a user- Parameters:
userId- User ID (required)skillId- skillId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserRoutingskillWithHttpInfo
public ApiResponse<Void> deleteUserRoutingskillWithHttpInfo(String userId, String skillId) throws IOException Remove a routing skill from a user- Parameters:
userId- User ID (required)skillId- skillId (required)- Throws:
IOException- if the request fails to be processed
-
deleteUserRoutingskill
public void deleteUserRoutingskill(DeleteUserRoutingskillRequest request) throws IOException, ApiException Remove a routing skill from a user- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserRoutingskill
Remove a routing skill from a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingAssessment
Retrieve a single benefit assessment.- Parameters:
assessmentId- Benefit Assessment ID (required)- Returns:
- BenefitAssessment
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingAssessmentWithHttpInfo
public ApiResponse<BenefitAssessment> getRoutingAssessmentWithHttpInfo(String assessmentId) throws IOException Retrieve a single benefit assessment.- Parameters:
assessmentId- Benefit Assessment ID (required)- Returns:
- BenefitAssessment
- Throws:
IOException- if the request fails to be processed
-
getRoutingAssessment
public BenefitAssessment getRoutingAssessment(GetRoutingAssessmentRequest request) throws IOException, ApiException Retrieve a single benefit assessment.- Parameters:
request- The request object- Returns:
- BenefitAssessment
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingAssessment
public ApiResponse<BenefitAssessment> getRoutingAssessment(ApiRequest<Void> request) throws IOException Retrieve a single benefit assessment.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingAssessments
public AssessmentListing getRoutingAssessments(String before, String after, String limit, String pageSize, List<String> queueId) throws IOException, ApiException Retrieve all benefit assessments.- Parameters:
before- The cursor that points to the start of the set of entities that has been returned. (optional)after- The cursor that points to the end of the set of entities that has been returned. (optional)limit- Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)pageSize- Number of entities to return. Maximum of 200. (optional)queueId- Queue ID(s) to filter assessments by. (optional)- Returns:
- AssessmentListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingAssessmentsWithHttpInfo
public ApiResponse<AssessmentListing> getRoutingAssessmentsWithHttpInfo(String before, String after, String limit, String pageSize, List<String> queueId) throws IOException Retrieve all benefit assessments.- Parameters:
before- The cursor that points to the start of the set of entities that has been returned. (optional)after- The cursor that points to the end of the set of entities that has been returned. (optional)limit- Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)pageSize- Number of entities to return. Maximum of 200. (optional)queueId- Queue ID(s) to filter assessments by. (optional)- Returns:
- AssessmentListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingAssessments
public AssessmentListing getRoutingAssessments(GetRoutingAssessmentsRequest request) throws IOException, ApiException Retrieve all benefit assessments.- Parameters:
request- The request object- Returns:
- AssessmentListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingAssessments
public ApiResponse<AssessmentListing> getRoutingAssessments(ApiRequest<Void> request) throws IOException Retrieve all benefit assessments.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingAssessmentsJob
Retrieve a single benefit assessments job.- Parameters:
jobId- Benefit Assessment Job ID (required)- Returns:
- BenefitAssessmentJob
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingAssessmentsJobWithHttpInfo
public ApiResponse<BenefitAssessmentJob> getRoutingAssessmentsJobWithHttpInfo(String jobId) throws IOException Retrieve a single benefit assessments job.- Parameters:
jobId- Benefit Assessment Job ID (required)- Returns:
- BenefitAssessmentJob
- Throws:
IOException- if the request fails to be processed
-
getRoutingAssessmentsJob
public BenefitAssessmentJob getRoutingAssessmentsJob(GetRoutingAssessmentsJobRequest request) throws IOException, ApiException Retrieve a single benefit assessments job.- Parameters:
request- The request object- Returns:
- BenefitAssessmentJob
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingAssessmentsJob
public ApiResponse<BenefitAssessmentJob> getRoutingAssessmentsJob(ApiRequest<Void> request) throws IOException Retrieve a single benefit assessments job.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingAssessmentsJobs
public AssessmentJobListing getRoutingAssessmentsJobs(List<String> divisionId) throws IOException, ApiException Retrieve all benefit assessment jobs.- Parameters:
divisionId- Division ID(s) to filter assessment jobs by. (optional)- Returns:
- AssessmentJobListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingAssessmentsJobsWithHttpInfo
public ApiResponse<AssessmentJobListing> getRoutingAssessmentsJobsWithHttpInfo(List<String> divisionId) throws IOException Retrieve all benefit assessment jobs.- Parameters:
divisionId- Division ID(s) to filter assessment jobs by. (optional)- Returns:
- AssessmentJobListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingAssessmentsJobs
public AssessmentJobListing getRoutingAssessmentsJobs(GetRoutingAssessmentsJobsRequest request) throws IOException, ApiException Retrieve all benefit assessment jobs.- Parameters:
request- The request object- Returns:
- AssessmentJobListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingAssessmentsJobs
public ApiResponse<AssessmentJobListing> getRoutingAssessmentsJobs(ApiRequest<Void> request) throws IOException Retrieve all benefit assessment jobs.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingAvailablemediatypes
public AvailableMediaTypeEntityListing getRoutingAvailablemediatypes() throws IOException, ApiExceptionGet available media types- Returns:
- AvailableMediaTypeEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingAvailablemediatypesWithHttpInfo
public ApiResponse<AvailableMediaTypeEntityListing> getRoutingAvailablemediatypesWithHttpInfo() throws IOExceptionGet available media types- Returns:
- AvailableMediaTypeEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingAvailablemediatypes
public AvailableMediaTypeEntityListing getRoutingAvailablemediatypes(GetRoutingAvailablemediatypesRequest request) throws IOException, ApiException Get available media types- Parameters:
request- The request object- Returns:
- AvailableMediaTypeEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingAvailablemediatypes
public ApiResponse<AvailableMediaTypeEntityListing> getRoutingAvailablemediatypes(ApiRequest<Void> request) throws IOException Get available media types- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingDirectroutingbackupSettingsMe
public AgentDirectRoutingBackupSettings getRoutingDirectroutingbackupSettingsMe() throws IOException, ApiExceptionGet the user's Direct Routing Backup settings.- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingDirectroutingbackupSettingsMeWithHttpInfo
public ApiResponse<AgentDirectRoutingBackupSettings> getRoutingDirectroutingbackupSettingsMeWithHttpInfo() throws IOExceptionGet the user's Direct Routing Backup settings.- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
IOException- if the request fails to be processed
-
getRoutingDirectroutingbackupSettingsMe
public AgentDirectRoutingBackupSettings getRoutingDirectroutingbackupSettingsMe(GetRoutingDirectroutingbackupSettingsMeRequest request) throws IOException, ApiException Get the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingDirectroutingbackupSettingsMe
public ApiResponse<AgentDirectRoutingBackupSettings> getRoutingDirectroutingbackupSettingsMe(ApiRequest<Void> request) throws IOException Get the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomain
public InboundDomain getRoutingEmailDomain(String domainId, String expand) throws IOException, ApiException Get domain- Parameters:
domainId- domain ID (required)expand- Expand options. Valid values: settings (optional)- Returns:
- InboundDomain
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainWithHttpInfo
public ApiResponse<InboundDomain> getRoutingEmailDomainWithHttpInfo(String domainId, String expand) throws IOException Get domain- Parameters:
domainId- domain ID (required)expand- Expand options. Valid values: settings (optional)- Returns:
- InboundDomain
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomain
public InboundDomain getRoutingEmailDomain(GetRoutingEmailDomainRequest request) throws IOException, ApiException Get domain- Parameters:
request- The request object- Returns:
- InboundDomain
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomain
public ApiResponse<InboundDomain> getRoutingEmailDomain(ApiRequest<Void> request) throws IOException Get domain- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomainDkim
public VerificationResult getRoutingEmailDomainDkim(String domainId) throws IOException, ApiException Get domain dkim settings- Parameters:
domainId- domain ID (required)- Returns:
- VerificationResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainDkimWithHttpInfo
public ApiResponse<VerificationResult> getRoutingEmailDomainDkimWithHttpInfo(String domainId) throws IOException Get domain dkim settings- Parameters:
domainId- domain ID (required)- Returns:
- VerificationResult
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomainDkim
public VerificationResult getRoutingEmailDomainDkim(GetRoutingEmailDomainDkimRequest request) throws IOException, ApiException Get domain dkim settings- Parameters:
request- The request object- Returns:
- VerificationResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainDkim
public ApiResponse<VerificationResult> getRoutingEmailDomainDkim(ApiRequest<Void> request) throws IOException Get domain dkim settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomainMailfrom
public MailFromResult getRoutingEmailDomainMailfrom(String domainId) throws IOException, ApiException Get domain mail from settings- Parameters:
domainId- domain ID (required)- Returns:
- MailFromResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainMailfromWithHttpInfo
public ApiResponse<MailFromResult> getRoutingEmailDomainMailfromWithHttpInfo(String domainId) throws IOException Get domain mail from settings- Parameters:
domainId- domain ID (required)- Returns:
- MailFromResult
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomainMailfrom
public MailFromResult getRoutingEmailDomainMailfrom(GetRoutingEmailDomainMailfromRequest request) throws IOException, ApiException Get domain mail from settings- Parameters:
request- The request object- Returns:
- MailFromResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainMailfrom
public ApiResponse<MailFromResult> getRoutingEmailDomainMailfrom(ApiRequest<Void> request) throws IOException Get domain mail from settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomainRoute
public InboundRoute getRoutingEmailDomainRoute(String domainName, String routeId, List<String> expand) throws IOException, ApiException Get a route- Parameters:
domainName- email domain (required)routeId- route ID (required)expand- Which fields, if any, to expand (optional)- Returns:
- InboundRoute
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainRouteWithHttpInfo
public ApiResponse<InboundRoute> getRoutingEmailDomainRouteWithHttpInfo(String domainName, String routeId, List<String> expand) throws IOException Get a route- Parameters:
domainName- email domain (required)routeId- route ID (required)expand- Which fields, if any, to expand (optional)- Returns:
- InboundRoute
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomainRoute
public InboundRoute getRoutingEmailDomainRoute(GetRoutingEmailDomainRouteRequest request) throws IOException, ApiException Get a route- Parameters:
request- The request object- Returns:
- InboundRoute
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainRoute
public ApiResponse<InboundRoute> getRoutingEmailDomainRoute(ApiRequest<Void> request) throws IOException Get a route- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomainRouteIdentityresolution
public RouteIdentityResolutionConfig getRoutingEmailDomainRouteIdentityresolution(String domainName, String routeId) throws IOException, ApiException Get a route identity resolution setting.- Parameters:
domainName- email domain (required)routeId- route ID (required)- Returns:
- RouteIdentityResolutionConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainRouteIdentityresolutionWithHttpInfo
public ApiResponse<RouteIdentityResolutionConfig> getRoutingEmailDomainRouteIdentityresolutionWithHttpInfo(String domainName, String routeId) throws IOException Get a route identity resolution setting.- Parameters:
domainName- email domain (required)routeId- route ID (required)- Returns:
- RouteIdentityResolutionConfig
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomainRouteIdentityresolution
public RouteIdentityResolutionConfig getRoutingEmailDomainRouteIdentityresolution(GetRoutingEmailDomainRouteIdentityresolutionRequest request) throws IOException, ApiException Get a route identity resolution setting.- Parameters:
request- The request object- Returns:
- RouteIdentityResolutionConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainRouteIdentityresolution
public ApiResponse<RouteIdentityResolutionConfig> getRoutingEmailDomainRouteIdentityresolution(ApiRequest<Void> request) throws IOException Get a route identity resolution setting.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomainRoutes
public InboundRouteEntityListing getRoutingEmailDomainRoutes(String domainName, Integer pageSize, Integer pageNumber, String pattern, List<String> expand) throws IOException, ApiException Get routes- Parameters:
domainName- email domain (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)pattern- Filter routes by the route's pattern property (optional)expand- Which fields, if any, to expand (optional)- Returns:
- InboundRouteEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainRoutesWithHttpInfo
public ApiResponse<InboundRouteEntityListing> getRoutingEmailDomainRoutesWithHttpInfo(String domainName, Integer pageSize, Integer pageNumber, String pattern, List<String> expand) throws IOException Get routes- Parameters:
domainName- email domain (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)pattern- Filter routes by the route's pattern property (optional)expand- Which fields, if any, to expand (optional)- Returns:
- InboundRouteEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomainRoutes
public InboundRouteEntityListing getRoutingEmailDomainRoutes(GetRoutingEmailDomainRoutesRequest request) throws IOException, ApiException Get routes- Parameters:
request- The request object- Returns:
- InboundRouteEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainRoutes
public ApiResponse<InboundRouteEntityListing> getRoutingEmailDomainRoutes(ApiRequest<Void> request) throws IOException Get routes- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomainVerification
public VerificationResult getRoutingEmailDomainVerification(String domainId) throws IOException, ApiException Get domain verification settings- Parameters:
domainId- domain ID (required)- Returns:
- VerificationResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainVerificationWithHttpInfo
public ApiResponse<VerificationResult> getRoutingEmailDomainVerificationWithHttpInfo(String domainId) throws IOException Get domain verification settings- Parameters:
domainId- domain ID (required)- Returns:
- VerificationResult
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomainVerification
public VerificationResult getRoutingEmailDomainVerification(GetRoutingEmailDomainVerificationRequest request) throws IOException, ApiException Get domain verification settings- Parameters:
request- The request object- Returns:
- VerificationResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainVerification
public ApiResponse<VerificationResult> getRoutingEmailDomainVerification(ApiRequest<Void> request) throws IOException Get domain verification settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomains
public InboundDomainEntityListing getRoutingEmailDomains(Integer pageSize, Integer pageNumber, Boolean excludeStatus, String filter, String expand) throws IOException, ApiException Get domains- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)excludeStatus- Exclude MX record data (optional, default to false)filter- Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter. (optional)expand- Expand options. Valid values: settings (optional)- Returns:
- InboundDomainEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomainsWithHttpInfo
public ApiResponse<InboundDomainEntityListing> getRoutingEmailDomainsWithHttpInfo(Integer pageSize, Integer pageNumber, Boolean excludeStatus, String filter, String expand) throws IOException Get domains- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)excludeStatus- Exclude MX record data (optional, default to false)filter- Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter. (optional)expand- Expand options. Valid values: settings (optional)- Returns:
- InboundDomainEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailDomains
public InboundDomainEntityListing getRoutingEmailDomains(GetRoutingEmailDomainsRequest request) throws IOException, ApiException Get domains- Parameters:
request- The request object- Returns:
- InboundDomainEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailDomains
public ApiResponse<InboundDomainEntityListing> getRoutingEmailDomains(ApiRequest<Void> request) throws IOException Get domains- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailOutboundDomain
public OutboundDomain getRoutingEmailOutboundDomain(String domainId, String expand) throws IOException, ApiException Get domain- Parameters:
domainId- domain ID (required)expand- Expand options. Valid values: settings (optional)- Returns:
- OutboundDomain
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailOutboundDomainWithHttpInfo
public ApiResponse<OutboundDomain> getRoutingEmailOutboundDomainWithHttpInfo(String domainId, String expand) throws IOException Get domain- Parameters:
domainId- domain ID (required)expand- Expand options. Valid values: settings (optional)- Returns:
- OutboundDomain
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailOutboundDomain
public OutboundDomain getRoutingEmailOutboundDomain(GetRoutingEmailOutboundDomainRequest request) throws IOException, ApiException Get domain- Parameters:
request- The request object- Returns:
- OutboundDomain
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailOutboundDomain
public ApiResponse<OutboundDomain> getRoutingEmailOutboundDomain(ApiRequest<Void> request) throws IOException Get domain- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailOutboundDomainActivation
public EmailOutboundDomainResult getRoutingEmailOutboundDomainActivation(String domainId) throws IOException, ApiException Get activation status (cname + dkim) of an outbound domain- Parameters:
domainId- domain ID (required)- Returns:
- EmailOutboundDomainResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailOutboundDomainActivationWithHttpInfo
public ApiResponse<EmailOutboundDomainResult> getRoutingEmailOutboundDomainActivationWithHttpInfo(String domainId) throws IOException Get activation status (cname + dkim) of an outbound domain- Parameters:
domainId- domain ID (required)- Returns:
- EmailOutboundDomainResult
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailOutboundDomainActivation
public EmailOutboundDomainResult getRoutingEmailOutboundDomainActivation(GetRoutingEmailOutboundDomainActivationRequest request) throws IOException, ApiException Get activation status (cname + dkim) of an outbound domain- Parameters:
request- The request object- Returns:
- EmailOutboundDomainResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailOutboundDomainActivation
public ApiResponse<EmailOutboundDomainResult> getRoutingEmailOutboundDomainActivation(ApiRequest<Void> request) throws IOException Get activation status (cname + dkim) of an outbound domain- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailOutboundDomains
public OutboundDomainEntityListing getRoutingEmailOutboundDomains(Integer pageSize, Integer pageNumber, String filter, String expand) throws IOException, ApiException Get outbound domains- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)filter- Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter. (optional)expand- Expand options. Valid values: settings (optional)- Returns:
- OutboundDomainEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailOutboundDomainsWithHttpInfo
public ApiResponse<OutboundDomainEntityListing> getRoutingEmailOutboundDomainsWithHttpInfo(Integer pageSize, Integer pageNumber, String filter, String expand) throws IOException Get outbound domains- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)filter- Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter. (optional)expand- Expand options. Valid values: settings (optional)- Returns:
- OutboundDomainEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailOutboundDomains
public OutboundDomainEntityListing getRoutingEmailOutboundDomains(GetRoutingEmailOutboundDomainsRequest request) throws IOException, ApiException Get outbound domains- Parameters:
request- The request object- Returns:
- OutboundDomainEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailOutboundDomains
public ApiResponse<OutboundDomainEntityListing> getRoutingEmailOutboundDomains(ApiRequest<Void> request) throws IOException Get outbound domains- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailSetting
public EmailSettingEntityListing getRoutingEmailSetting(Integer pageSize, Integer pageNumber) throws IOException, ApiException Get a paged list of email routing settings.- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)- Returns:
- EmailSettingEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailSettingWithHttpInfo
public ApiResponse<EmailSettingEntityListing> getRoutingEmailSettingWithHttpInfo(Integer pageSize, Integer pageNumber) throws IOException Get a paged list of email routing settings.- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)- Returns:
- EmailSettingEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailSetting
public EmailSettingEntityListing getRoutingEmailSetting(GetRoutingEmailSettingRequest request) throws IOException, ApiException Get a paged list of email routing settings.- Parameters:
request- The request object- Returns:
- EmailSettingEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailSetting
public ApiResponse<EmailSettingEntityListing> getRoutingEmailSetting(ApiRequest<Void> request) throws IOException Get a paged list of email routing settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailSettingEmailSettingId
public EmailSetting getRoutingEmailSettingEmailSettingId(String emailSettingId) throws IOException, ApiException Get email setting. Returns the specified email setting that defines settings for email- Parameters:
emailSettingId- Email Setting ID (required)- Returns:
- EmailSetting
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailSettingEmailSettingIdWithHttpInfo
public ApiResponse<EmailSetting> getRoutingEmailSettingEmailSettingIdWithHttpInfo(String emailSettingId) throws IOException Get email setting. Returns the specified email setting that defines settings for email- Parameters:
emailSettingId- Email Setting ID (required)- Returns:
- EmailSetting
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailSettingEmailSettingId
public EmailSetting getRoutingEmailSettingEmailSettingId(GetRoutingEmailSettingEmailSettingIdRequest request) throws IOException, ApiException Get email setting. Returns the specified email setting that defines settings for email- Parameters:
request- The request object- Returns:
- EmailSetting
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailSettingEmailSettingId
public ApiResponse<EmailSetting> getRoutingEmailSettingEmailSettingId(ApiRequest<Void> request) throws IOException Get email setting. Returns the specified email setting that defines settings for email- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailSetup
Get email setup- Returns:
- EmailSetup
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailSetupWithHttpInfo
Get email setup- Returns:
- EmailSetup
- Throws:
IOException- if the request fails to be processed
-
getRoutingEmailSetup
public EmailSetup getRoutingEmailSetup(GetRoutingEmailSetupRequest request) throws IOException, ApiException Get email setup- Parameters:
request- The request object- Returns:
- EmailSetup
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingEmailSetup
Get email setup- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingLanguage
Get a routing language- Parameters:
languageId- Language ID (required)- Returns:
- Language
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingLanguageWithHttpInfo
Get a routing language- Parameters:
languageId- Language ID (required)- Returns:
- Language
- Throws:
IOException- if the request fails to be processed
-
getRoutingLanguage
public Language getRoutingLanguage(GetRoutingLanguageRequest request) throws IOException, ApiException Get a routing language- Parameters:
request- The request object- Returns:
- Language
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingLanguage
Get a routing language- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingLanguages
public LanguageEntityListing getRoutingLanguages(Integer pageSize, Integer pageNumber, String sortOrder, String name, List<String> id) throws IOException, ApiException Get the list of supported languages.- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Ascending or descending sort order (optional, default to ASC)name- Name (optional)id- id (optional)- Returns:
- LanguageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingLanguagesWithHttpInfo
public ApiResponse<LanguageEntityListing> getRoutingLanguagesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortOrder, String name, List<String> id) throws IOException Get the list of supported languages.- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Ascending or descending sort order (optional, default to ASC)name- Name (optional)id- id (optional)- Returns:
- LanguageEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingLanguages
public LanguageEntityListing getRoutingLanguages(GetRoutingLanguagesRequest request) throws IOException, ApiException Get the list of supported languages.- Parameters:
request- The request object- Returns:
- LanguageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingLanguages
public ApiResponse<LanguageEntityListing> getRoutingLanguages(ApiRequest<Void> request) throws IOException Get the list of supported languages.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingMessageRecipient
Get a recipient- Parameters:
recipientId- Recipient ID (required)- Returns:
- Recipient
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingMessageRecipientWithHttpInfo
public ApiResponse<Recipient> getRoutingMessageRecipientWithHttpInfo(String recipientId) throws IOException Get a recipient- Parameters:
recipientId- Recipient ID (required)- Returns:
- Recipient
- Throws:
IOException- if the request fails to be processed
-
getRoutingMessageRecipient
public Recipient getRoutingMessageRecipient(GetRoutingMessageRecipientRequest request) throws IOException, ApiException Get a recipient- Parameters:
request- The request object- Returns:
- Recipient
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingMessageRecipient
public ApiResponse<Recipient> getRoutingMessageRecipient(ApiRequest<Void> request) throws IOException Get a recipient- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingMessageRecipients
public RecipientListing getRoutingMessageRecipients(String messengerType, String name, Integer pageSize, Integer pageNumber) throws IOException, ApiException Get recipients- Parameters:
messengerType- Messenger Type (optional)name- Recipient Name (optional)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)- Returns:
- RecipientListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingMessageRecipientsWithHttpInfo
public ApiResponse<RecipientListing> getRoutingMessageRecipientsWithHttpInfo(String messengerType, String name, Integer pageSize, Integer pageNumber) throws IOException Get recipients- Parameters:
messengerType- Messenger Type (optional)name- Recipient Name (optional)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)- Returns:
- RecipientListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingMessageRecipients
public RecipientListing getRoutingMessageRecipients(GetRoutingMessageRecipientsRequest request) throws IOException, ApiException Get recipients- Parameters:
request- The request object- Returns:
- RecipientListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingMessageRecipients
public ApiResponse<RecipientListing> getRoutingMessageRecipients(ApiRequest<Void> request) throws IOException Get recipients- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictor
Retrieve a single predictor.- Parameters:
predictorId- Predictor ID (required)- Returns:
- Predictor
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictorWithHttpInfo
public ApiResponse<Predictor> getRoutingPredictorWithHttpInfo(String predictorId) throws IOException Retrieve a single predictor.- Parameters:
predictorId- Predictor ID (required)- Returns:
- Predictor
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictor
public Predictor getRoutingPredictor(GetRoutingPredictorRequest request) throws IOException, ApiException Retrieve a single predictor.- Parameters:
request- The request object- Returns:
- Predictor
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictor
Retrieve a single predictor.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictorModelFeatures
public PredictorModelFeatureListing getRoutingPredictorModelFeatures(String predictorId, String modelId) throws IOException, ApiException Retrieve Predictor Model Features.- Parameters:
predictorId- Predictor ID (required)modelId- Model ID (required)- Returns:
- PredictorModelFeatureListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictorModelFeaturesWithHttpInfo
public ApiResponse<PredictorModelFeatureListing> getRoutingPredictorModelFeaturesWithHttpInfo(String predictorId, String modelId) throws IOException Retrieve Predictor Model Features.- Parameters:
predictorId- Predictor ID (required)modelId- Model ID (required)- Returns:
- PredictorModelFeatureListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictorModelFeatures
public PredictorModelFeatureListing getRoutingPredictorModelFeatures(GetRoutingPredictorModelFeaturesRequest request) throws IOException, ApiException Retrieve Predictor Model Features.- Parameters:
request- The request object- Returns:
- PredictorModelFeatureListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictorModelFeatures
public ApiResponse<PredictorModelFeatureListing> getRoutingPredictorModelFeatures(ApiRequest<Void> request) throws IOException Retrieve Predictor Model Features.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictorModels
public PredictorModels getRoutingPredictorModels(String predictorId) throws IOException, ApiException Retrieve Predictor Models and Top Features.- Parameters:
predictorId- Predictor ID (required)- Returns:
- PredictorModels
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictorModelsWithHttpInfo
public ApiResponse<PredictorModels> getRoutingPredictorModelsWithHttpInfo(String predictorId) throws IOException Retrieve Predictor Models and Top Features.- Parameters:
predictorId- Predictor ID (required)- Returns:
- PredictorModels
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictorModels
public PredictorModels getRoutingPredictorModels(GetRoutingPredictorModelsRequest request) throws IOException, ApiException Retrieve Predictor Models and Top Features.- Parameters:
request- The request object- Returns:
- PredictorModels
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictorModels
public ApiResponse<PredictorModels> getRoutingPredictorModels(ApiRequest<Void> request) throws IOException Retrieve Predictor Models and Top Features.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictors
public PredictorListing getRoutingPredictors(String before, String after, String limit, String pageSize, List<String> queueId, String kpiId, String state) throws IOException, ApiException Retrieve all predictors.- Parameters:
before- The cursor that points to the start of the set of entities that has been returned. (optional)after- The cursor that points to the end of the set of entities that has been returned. (optional)limit- Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)pageSize- Number of entities to return. Maximum of 200. (optional)queueId- Comma-separated list of queue Ids to filter by. (optional)kpiId- Standard or custom KPI id used to filter predictors. (optional)state- The state used to filter predictors. (optional)- Returns:
- PredictorListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictorsWithHttpInfo
public ApiResponse<PredictorListing> getRoutingPredictorsWithHttpInfo(String before, String after, String limit, String pageSize, List<String> queueId, String kpiId, String state) throws IOException Retrieve all predictors.- Parameters:
before- The cursor that points to the start of the set of entities that has been returned. (optional)after- The cursor that points to the end of the set of entities that has been returned. (optional)limit- Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)pageSize- Number of entities to return. Maximum of 200. (optional)queueId- Comma-separated list of queue Ids to filter by. (optional)kpiId- Standard or custom KPI id used to filter predictors. (optional)state- The state used to filter predictors. (optional)- Returns:
- PredictorListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictors
public PredictorListing getRoutingPredictors(GetRoutingPredictorsRequest request) throws IOException, ApiException Retrieve all predictors.- Parameters:
request- The request object- Returns:
- PredictorListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictors
public ApiResponse<PredictorListing> getRoutingPredictors(ApiRequest<Void> request) throws IOException Retrieve all predictors.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictorsKeyperformanceindicator
public KeyPerformanceIndicator getRoutingPredictorsKeyperformanceindicator(String kpiId, List<String> expand) throws IOException, ApiException Retrieve a single Key Performance Indicator. getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
kpiId- Key Performance Indicator ID (required)expand- Parameter to request additional data to return in KPI payload (optional)- Returns:
- KeyPerformanceIndicator
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictorsKeyperformanceindicatorWithHttpInfo
public ApiResponse<KeyPerformanceIndicator> getRoutingPredictorsKeyperformanceindicatorWithHttpInfo(String kpiId, List<String> expand) throws IOException Retrieve a single Key Performance Indicator. getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
kpiId- Key Performance Indicator ID (required)expand- Parameter to request additional data to return in KPI payload (optional)- Returns:
- KeyPerformanceIndicator
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictorsKeyperformanceindicator
public KeyPerformanceIndicator getRoutingPredictorsKeyperformanceindicator(GetRoutingPredictorsKeyperformanceindicatorRequest request) throws IOException, ApiException Retrieve a single Key Performance Indicator. getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
request- The request object- Returns:
- KeyPerformanceIndicator
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictorsKeyperformanceindicator
public ApiResponse<KeyPerformanceIndicator> getRoutingPredictorsKeyperformanceindicator(ApiRequest<Void> request) throws IOException Retrieve a single Key Performance Indicator. getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictorsKeyperformanceindicators
public List<KeyPerformanceIndicator> getRoutingPredictorsKeyperformanceindicators(String kpiGroup, List<String> expand) throws IOException, ApiException Get a list of Key Performance Indicators- Parameters:
kpiGroup- The Group of Key Performance Indicators to return (optional)expand- Parameter to request additional data to return in KPI payload (optional)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictorsKeyperformanceindicatorsWithHttpInfo
public ApiResponse<List<KeyPerformanceIndicator>> getRoutingPredictorsKeyperformanceindicatorsWithHttpInfo(String kpiGroup, List<String> expand) throws IOException Get a list of Key Performance Indicators- Parameters:
kpiGroup- The Group of Key Performance Indicators to return (optional)expand- Parameter to request additional data to return in KPI payload (optional)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictorsKeyperformanceindicators
public List<KeyPerformanceIndicator> getRoutingPredictorsKeyperformanceindicators(GetRoutingPredictorsKeyperformanceindicatorsRequest request) throws IOException, ApiException Get a list of Key Performance Indicators- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictorsKeyperformanceindicators
public ApiResponse<List<KeyPerformanceIndicator>> getRoutingPredictorsKeyperformanceindicators(ApiRequest<Void> request) throws IOException Get a list of Key Performance Indicators- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictorsKeyperformanceindicatortypes
public List<KeyPerformanceIndicatorType> getRoutingPredictorsKeyperformanceindicatortypes() throws IOException, ApiExceptionGet a list of Key Performance Indicators Types available. getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictorsKeyperformanceindicatortypesWithHttpInfo
public ApiResponse<List<KeyPerformanceIndicatorType>> getRoutingPredictorsKeyperformanceindicatortypesWithHttpInfo() throws IOExceptionGet a list of Key Performance Indicators Types available. getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
getRoutingPredictorsKeyperformanceindicatortypes
public List<KeyPerformanceIndicatorType> getRoutingPredictorsKeyperformanceindicatortypes(GetRoutingPredictorsKeyperformanceindicatortypesRequest request) throws IOException, ApiException Get a list of Key Performance Indicators Types available. getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingPredictorsKeyperformanceindicatortypes
public ApiResponse<List<KeyPerformanceIndicatorType>> getRoutingPredictorsKeyperformanceindicatortypes(ApiRequest<Void> request) throws IOException Get a list of Key Performance Indicators Types available. getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueue
Get details about this queue.- Parameters:
queueId- Queue ID (required)expand- Which fields, if any, to expand (optional)- Returns:
- Queue
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueWithHttpInfo
public ApiResponse<Queue> getRoutingQueueWithHttpInfo(String queueId, List<String> expand) throws IOException Get details about this queue.- Parameters:
queueId- Queue ID (required)expand- Which fields, if any, to expand (optional)- Returns:
- Queue
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueue
Get details about this queue.- Parameters:
request- The request object- Returns:
- Queue
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueue
Get details about this queue.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueAssistant
public AssistantQueue getRoutingQueueAssistant(String queueId, List<String> expand, String languageVariation, Boolean fallbackToPrimaryAssistant) throws IOException, ApiException Get an assistant associated with a queue.- Parameters:
queueId- Queue ID (required)expand- Which fields, if any, to expand. (optional)languageVariation- Language variation (optional)fallbackToPrimaryAssistant- Fall back to primary assistant if specified variation is not found (optional)- Returns:
- AssistantQueue
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueAssistantWithHttpInfo
public ApiResponse<AssistantQueue> getRoutingQueueAssistantWithHttpInfo(String queueId, List<String> expand, String languageVariation, Boolean fallbackToPrimaryAssistant) throws IOException Get an assistant associated with a queue.- Parameters:
queueId- Queue ID (required)expand- Which fields, if any, to expand. (optional)languageVariation- Language variation (optional)fallbackToPrimaryAssistant- Fall back to primary assistant if specified variation is not found (optional)- Returns:
- AssistantQueue
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueAssistant
public AssistantQueue getRoutingQueueAssistant(GetRoutingQueueAssistantRequest request) throws IOException, ApiException Get an assistant associated with a queue.- Parameters:
request- The request object- Returns:
- AssistantQueue
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueAssistant
public ApiResponse<AssistantQueue> getRoutingQueueAssistant(ApiRequest<Void> request) throws IOException Get an assistant associated with a queue.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueComparisonperiod
public ComparisonPeriod getRoutingQueueComparisonperiod(String queueId, String comparisonPeriodId) throws IOException, ApiException Get a Comparison Period.- Parameters:
queueId- Queue id (required)comparisonPeriodId- ComparisonPeriod id (required)- Returns:
- ComparisonPeriod
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueComparisonperiodWithHttpInfo
public ApiResponse<ComparisonPeriod> getRoutingQueueComparisonperiodWithHttpInfo(String queueId, String comparisonPeriodId) throws IOException Get a Comparison Period.- Parameters:
queueId- Queue id (required)comparisonPeriodId- ComparisonPeriod id (required)- Returns:
- ComparisonPeriod
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueComparisonperiod
public ComparisonPeriod getRoutingQueueComparisonperiod(GetRoutingQueueComparisonperiodRequest request) throws IOException, ApiException Get a Comparison Period.- Parameters:
request- The request object- Returns:
- ComparisonPeriod
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueComparisonperiod
public ApiResponse<ComparisonPeriod> getRoutingQueueComparisonperiod(ApiRequest<Void> request) throws IOException Get a Comparison Period.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueComparisonperiods
public ComparisonPeriodListing getRoutingQueueComparisonperiods(String queueId) throws IOException, ApiException Get list of comparison periods- Parameters:
queueId- Queue id (required)- Returns:
- ComparisonPeriodListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueComparisonperiodsWithHttpInfo
public ApiResponse<ComparisonPeriodListing> getRoutingQueueComparisonperiodsWithHttpInfo(String queueId) throws IOException Get list of comparison periods- Parameters:
queueId- Queue id (required)- Returns:
- ComparisonPeriodListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueComparisonperiods
public ComparisonPeriodListing getRoutingQueueComparisonperiods(GetRoutingQueueComparisonperiodsRequest request) throws IOException, ApiException Get list of comparison periods- Parameters:
request- The request object- Returns:
- ComparisonPeriodListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueComparisonperiods
public ApiResponse<ComparisonPeriodListing> getRoutingQueueComparisonperiods(ApiRequest<Void> request) throws IOException Get list of comparison periods- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueEstimatedwaittime
public EstimatedWaitTimePredictions getRoutingQueueEstimatedwaittime(String queueId, String conversationId) throws IOException, ApiException Get Estimated Wait Time- Parameters:
queueId- queueId (required)conversationId- conversationId (optional)- Returns:
- EstimatedWaitTimePredictions
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueEstimatedwaittimeWithHttpInfo
public ApiResponse<EstimatedWaitTimePredictions> getRoutingQueueEstimatedwaittimeWithHttpInfo(String queueId, String conversationId) throws IOException Get Estimated Wait Time- Parameters:
queueId- queueId (required)conversationId- conversationId (optional)- Returns:
- EstimatedWaitTimePredictions
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueEstimatedwaittime
public EstimatedWaitTimePredictions getRoutingQueueEstimatedwaittime(GetRoutingQueueEstimatedwaittimeRequest request) throws IOException, ApiException Get Estimated Wait Time- Parameters:
request- The request object- Returns:
- EstimatedWaitTimePredictions
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueEstimatedwaittime
public ApiResponse<EstimatedWaitTimePredictions> getRoutingQueueEstimatedwaittime(ApiRequest<Void> request) throws IOException Get Estimated Wait Time- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueIdentityresolution
public IdentityResolutionQueueConfig getRoutingQueueIdentityresolution(String queueId) throws IOException, ApiException Get Queue IdentityResolution Settings.- Parameters:
queueId- Queue ID (required)- Returns:
- IdentityResolutionQueueConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueIdentityresolutionWithHttpInfo
public ApiResponse<IdentityResolutionQueueConfig> getRoutingQueueIdentityresolutionWithHttpInfo(String queueId) throws IOException Get Queue IdentityResolution Settings.- Parameters:
queueId- Queue ID (required)- Returns:
- IdentityResolutionQueueConfig
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueIdentityresolution
public IdentityResolutionQueueConfig getRoutingQueueIdentityresolution(GetRoutingQueueIdentityresolutionRequest request) throws IOException, ApiException Get Queue IdentityResolution Settings.- Parameters:
request- The request object- Returns:
- IdentityResolutionQueueConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueIdentityresolution
public ApiResponse<IdentityResolutionQueueConfig> getRoutingQueueIdentityresolution(ApiRequest<Void> request) throws IOException Get Queue IdentityResolution Settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueMediatypeEstimatedwaittime
public EstimatedWaitTimePredictions getRoutingQueueMediatypeEstimatedwaittime(String queueId, String mediaType, String labelId) throws IOException, ApiException Get Estimated Wait Time- Parameters:
queueId- queueId (required)mediaType- mediaType (required)labelId- Unique id that represents the interaction label used with media type for EWT calculation (optional)- Returns:
- EstimatedWaitTimePredictions
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueMediatypeEstimatedwaittimeWithHttpInfo
public ApiResponse<EstimatedWaitTimePredictions> getRoutingQueueMediatypeEstimatedwaittimeWithHttpInfo(String queueId, String mediaType, String labelId) throws IOException Get Estimated Wait Time- Parameters:
queueId- queueId (required)mediaType- mediaType (required)labelId- Unique id that represents the interaction label used with media type for EWT calculation (optional)- Returns:
- EstimatedWaitTimePredictions
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueMediatypeEstimatedwaittime
public EstimatedWaitTimePredictions getRoutingQueueMediatypeEstimatedwaittime(GetRoutingQueueMediatypeEstimatedwaittimeRequest request) throws IOException, ApiException Get Estimated Wait Time- Parameters:
request- The request object- Returns:
- EstimatedWaitTimePredictions
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueMediatypeEstimatedwaittime
public ApiResponse<EstimatedWaitTimePredictions> getRoutingQueueMediatypeEstimatedwaittime(ApiRequest<Void> request) throws IOException Get Estimated Wait Time- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueMembers
public QueueMemberEntityListing getRoutingQueueMembers(String queueId, Integer pageNumber, Integer pageSize, String sortOrder, List<String> expand, String name, List<String> profileSkills, List<String> skills, List<String> languages, List<String> routingStatus, List<String> presence, String memberBy, Boolean joined) throws IOException, ApiException Get the members of this queue.- Parameters:
queueId- Queue ID (required)pageNumber- (optional, default to 1)pageSize- Max value is 100 (optional, default to 25)sortOrder- Note: results are sorted by name. (optional, default to asc)expand- Which fields, if any, to expand. (optional)name- Filter by queue member name (contains-style search) (optional)profileSkills- Filter by profile skill (contains-style search) (optional)skills- Filter by skill (contains-style search) (optional)languages- Filter by language (contains-style search) (optional)routingStatus- Filter by routing status (optional)presence- Filter by presence (optional)memberBy- Filter by member type (optional)joined- Filter by joined status (optional)- Returns:
- QueueMemberEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueMembersWithHttpInfo
public ApiResponse<QueueMemberEntityListing> getRoutingQueueMembersWithHttpInfo(String queueId, Integer pageNumber, Integer pageSize, String sortOrder, List<String> expand, String name, List<String> profileSkills, List<String> skills, List<String> languages, List<String> routingStatus, List<String> presence, String memberBy, Boolean joined) throws IOException Get the members of this queue.- Parameters:
queueId- Queue ID (required)pageNumber- (optional, default to 1)pageSize- Max value is 100 (optional, default to 25)sortOrder- Note: results are sorted by name. (optional, default to asc)expand- Which fields, if any, to expand. (optional)name- Filter by queue member name (contains-style search) (optional)profileSkills- Filter by profile skill (contains-style search) (optional)skills- Filter by skill (contains-style search) (optional)languages- Filter by language (contains-style search) (optional)routingStatus- Filter by routing status (optional)presence- Filter by presence (optional)memberBy- Filter by member type (optional)joined- Filter by joined status (optional)- Returns:
- QueueMemberEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueMembers
public QueueMemberEntityListing getRoutingQueueMembers(GetRoutingQueueMembersRequest request) throws IOException, ApiException Get the members of this queue.- Parameters:
request- The request object- Returns:
- QueueMemberEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueMembers
public ApiResponse<QueueMemberEntityListing> getRoutingQueueMembers(ApiRequest<Void> request) throws IOException Get the members of this queue.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueUsers
public QueueMemberEntityListingV1 getRoutingQueueUsers(String queueId, Integer pageNumber, Integer pageSize, String sortOrder, List<String> expand, Boolean joined, String name, List<String> profileSkills, List<String> skills, List<String> languages, List<String> routingStatus, List<String> presence) throws IOException, ApiException Deprecated.DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.- Parameters:
queueId- Queue ID (required)pageNumber- (optional, default to 1)pageSize- Max value is 100 (optional, default to 25)sortOrder- Note: results are sorted by name. (optional, default to asc)expand- Which fields, if any, to expand. (optional)joined- Filter by joined status (optional)name- Filter by queue member name (optional)profileSkills- Filter by profile skill (optional)skills- Filter by skill (optional)languages- Filter by language (optional)routingStatus- Filter by routing status (optional)presence- Filter by presence (optional)- Returns:
- QueueMemberEntityListingV1
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueUsersWithHttpInfo
public ApiResponse<QueueMemberEntityListingV1> getRoutingQueueUsersWithHttpInfo(String queueId, Integer pageNumber, Integer pageSize, String sortOrder, List<String> expand, Boolean joined, String name, List<String> profileSkills, List<String> skills, List<String> languages, List<String> routingStatus, List<String> presence) throws IOException Deprecated.DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.- Parameters:
queueId- Queue ID (required)pageNumber- (optional, default to 1)pageSize- Max value is 100 (optional, default to 25)sortOrder- Note: results are sorted by name. (optional, default to asc)expand- Which fields, if any, to expand. (optional)joined- Filter by joined status (optional)name- Filter by queue member name (optional)profileSkills- Filter by profile skill (optional)skills- Filter by skill (optional)languages- Filter by language (optional)routingStatus- Filter by routing status (optional)presence- Filter by presence (optional)- Returns:
- QueueMemberEntityListingV1
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueUsers
public QueueMemberEntityListingV1 getRoutingQueueUsers(GetRoutingQueueUsersRequest request) throws IOException, ApiException Deprecated.DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.- Parameters:
request- The request object- Returns:
- QueueMemberEntityListingV1
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueUsers
public ApiResponse<QueueMemberEntityListingV1> getRoutingQueueUsers(ApiRequest<Void> request) throws IOException Deprecated.DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueWrapupcodes
public WrapupCodeEntityListing getRoutingQueueWrapupcodes(String queueId, Integer pageSize, Integer pageNumber, String name) throws IOException, ApiException Get the wrap-up codes for a queue- Parameters:
queueId- Queue ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)name- Wrapup code's name (trailing asterisks allowed) (optional)- Returns:
- WrapupCodeEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueWrapupcodesWithHttpInfo
public ApiResponse<WrapupCodeEntityListing> getRoutingQueueWrapupcodesWithHttpInfo(String queueId, Integer pageSize, Integer pageNumber, String name) throws IOException Get the wrap-up codes for a queue- Parameters:
queueId- Queue ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)name- Wrapup code's name (trailing asterisks allowed) (optional)- Returns:
- WrapupCodeEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueueWrapupcodes
public WrapupCodeEntityListing getRoutingQueueWrapupcodes(GetRoutingQueueWrapupcodesRequest request) throws IOException, ApiException Get the wrap-up codes for a queue- Parameters:
request- The request object- Returns:
- WrapupCodeEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueueWrapupcodes
public ApiResponse<WrapupCodeEntityListing> getRoutingQueueWrapupcodes(ApiRequest<Void> request) throws IOException Get the wrap-up codes for a queue- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueues
public QueueEntityListing getRoutingQueues(Integer pageNumber, Integer pageSize, String sortOrder, String name, List<String> id, List<String> divisionId, List<String> peerId, String cannedResponseLibraryId, Boolean hasPeer, List<String> expand) throws IOException, ApiException Get list of queues.- Parameters:
pageNumber- Page number (optional, default to 1)pageSize- Page size (optional, default to 25)sortOrder- Note: results are sorted by name. (optional, default to asc)name- Include only queues with the given name (leading and trailing asterisks allowed) (optional)id- Include only queues with the specified ID(s) (optional)divisionId- Include only queues in the specified division ID(s) (optional)peerId- Include only queues with the specified peer ID(s) (optional)cannedResponseLibraryId- Include only queues explicitly associated with the specified canned response library ID (optional)hasPeer- Include only queues with a peer ID (optional)expand- Which fields, if any, to expand (optional)- Returns:
- QueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueuesWithHttpInfo
public ApiResponse<QueueEntityListing> getRoutingQueuesWithHttpInfo(Integer pageNumber, Integer pageSize, String sortOrder, String name, List<String> id, List<String> divisionId, List<String> peerId, String cannedResponseLibraryId, Boolean hasPeer, List<String> expand) throws IOException Get list of queues.- Parameters:
pageNumber- Page number (optional, default to 1)pageSize- Page size (optional, default to 25)sortOrder- Note: results are sorted by name. (optional, default to asc)name- Include only queues with the given name (leading and trailing asterisks allowed) (optional)id- Include only queues with the specified ID(s) (optional)divisionId- Include only queues in the specified division ID(s) (optional)peerId- Include only queues with the specified peer ID(s) (optional)cannedResponseLibraryId- Include only queues explicitly associated with the specified canned response library ID (optional)hasPeer- Include only queues with a peer ID (optional)expand- Which fields, if any, to expand (optional)- Returns:
- QueueEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueues
public QueueEntityListing getRoutingQueues(GetRoutingQueuesRequest request) throws IOException, ApiException Get list of queues.- Parameters:
request- The request object- Returns:
- QueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueues
public ApiResponse<QueueEntityListing> getRoutingQueues(ApiRequest<Void> request) throws IOException Get list of queues.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueuesDivisionviews
public QueueEntityListing getRoutingQueuesDivisionviews(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id, List<String> divisionId) throws IOException, ApiException Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).- Parameters:
pageSize- Page size [max value is 100] (optional, default to 25)pageNumber- Page number [max value is 5] (optional, default to 1)sortBy- Sort by (optional, default to name)sortOrder- Sort order (optional, default to asc)name- Name (optional)id- Queue ID(s) (optional)divisionId- Division ID(s). Including '*' will query for all divisions (optional)- Returns:
- QueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueuesDivisionviewsWithHttpInfo
public ApiResponse<QueueEntityListing> getRoutingQueuesDivisionviewsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id, List<String> divisionId) throws IOException Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).- Parameters:
pageSize- Page size [max value is 100] (optional, default to 25)pageNumber- Page number [max value is 5] (optional, default to 1)sortBy- Sort by (optional, default to name)sortOrder- Sort order (optional, default to asc)name- Name (optional)id- Queue ID(s) (optional)divisionId- Division ID(s). Including '*' will query for all divisions (optional)- Returns:
- QueueEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueuesDivisionviews
public QueueEntityListing getRoutingQueuesDivisionviews(GetRoutingQueuesDivisionviewsRequest request) throws IOException, ApiException Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).- Parameters:
request- The request object- Returns:
- QueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueuesDivisionviews
public ApiResponse<QueueEntityListing> getRoutingQueuesDivisionviews(ApiRequest<Void> request) throws IOException Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueuesDivisionviewsAll
public QueueEntityListing getRoutingQueuesDivisionviewsAll(Integer pageSize, Integer pageNumber, String sortOrder) throws IOException, ApiException Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.- Parameters:
pageSize- Page size [max value is 500] (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Sort order (optional, default to asc)- Returns:
- QueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueuesDivisionviewsAllWithHttpInfo
public ApiResponse<QueueEntityListing> getRoutingQueuesDivisionviewsAllWithHttpInfo(Integer pageSize, Integer pageNumber, String sortOrder) throws IOException Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.- Parameters:
pageSize- Page size [max value is 500] (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Sort order (optional, default to asc)- Returns:
- QueueEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueuesDivisionviewsAll
public QueueEntityListing getRoutingQueuesDivisionviewsAll(GetRoutingQueuesDivisionviewsAllRequest request) throws IOException, ApiException Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.- Parameters:
request- The request object- Returns:
- QueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueuesDivisionviewsAll
public ApiResponse<QueueEntityListing> getRoutingQueuesDivisionviewsAll(ApiRequest<Void> request) throws IOException Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueuesMe
public UserQueueEntityListing getRoutingQueuesMe(Integer pageNumber, Integer pageSize, Boolean joined, String sortOrder) throws IOException, ApiException Get a paged listing of queues the user is a member of.- Parameters:
pageNumber- Page number (optional, default to 1)pageSize- Page size (optional, default to 25)joined- Filter by joined status. (optional)sortOrder- Note: results are sorted by name. (optional, default to asc)- Returns:
- UserQueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueuesMeWithHttpInfo
public ApiResponse<UserQueueEntityListing> getRoutingQueuesMeWithHttpInfo(Integer pageNumber, Integer pageSize, Boolean joined, String sortOrder) throws IOException Get a paged listing of queues the user is a member of.- Parameters:
pageNumber- Page number (optional, default to 1)pageSize- Page size (optional, default to 25)joined- Filter by joined status. (optional)sortOrder- Note: results are sorted by name. (optional, default to asc)- Returns:
- UserQueueEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingQueuesMe
public UserQueueEntityListing getRoutingQueuesMe(GetRoutingQueuesMeRequest request) throws IOException, ApiException Get a paged listing of queues the user is a member of.- Parameters:
request- The request object- Returns:
- UserQueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingQueuesMe
public ApiResponse<UserQueueEntityListing> getRoutingQueuesMe(ApiRequest<Void> request) throws IOException Get a paged listing of queues the user is a member of.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSettings
Get an organization's routing settings- Returns:
- RoutingSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSettingsWithHttpInfo
Get an organization's routing settings- Returns:
- RoutingSettings
- Throws:
IOException- if the request fails to be processed
-
getRoutingSettings
public RoutingSettings getRoutingSettings(GetRoutingSettingsRequest request) throws IOException, ApiException Get an organization's routing settings- Parameters:
request- The request object- Returns:
- RoutingSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSettings
Get an organization's routing settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSettingsContactcenter
Get Contact Center Settings- Returns:
- ContactCenterSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSettingsContactcenterWithHttpInfo
public ApiResponse<ContactCenterSettings> getRoutingSettingsContactcenterWithHttpInfo() throws IOExceptionGet Contact Center Settings- Returns:
- ContactCenterSettings
- Throws:
IOException- if the request fails to be processed
-
getRoutingSettingsContactcenter
public ContactCenterSettings getRoutingSettingsContactcenter(GetRoutingSettingsContactcenterRequest request) throws IOException, ApiException Get Contact Center Settings- Parameters:
request- The request object- Returns:
- ContactCenterSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSettingsContactcenter
public ApiResponse<ContactCenterSettings> getRoutingSettingsContactcenter(ApiRequest<Void> request) throws IOException Get Contact Center Settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSettingsTranscription
Get Transcription Settings- Returns:
- TranscriptionSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSettingsTranscriptionWithHttpInfo
public ApiResponse<TranscriptionSettings> getRoutingSettingsTranscriptionWithHttpInfo() throws IOExceptionGet Transcription Settings- Returns:
- TranscriptionSettings
- Throws:
IOException- if the request fails to be processed
-
getRoutingSettingsTranscription
public TranscriptionSettings getRoutingSettingsTranscription(GetRoutingSettingsTranscriptionRequest request) throws IOException, ApiException Get Transcription Settings- Parameters:
request- The request object- Returns:
- TranscriptionSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSettingsTranscription
public ApiResponse<TranscriptionSettings> getRoutingSettingsTranscription(ApiRequest<Void> request) throws IOException Get Transcription Settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkill
Get Routing Skill- Parameters:
skillId- Skill ID (required)- Returns:
- RoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillWithHttpInfo
Get Routing Skill- Parameters:
skillId- Skill ID (required)- Returns:
- RoutingSkill
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkill
public RoutingSkill getRoutingSkill(GetRoutingSkillRequest request) throws IOException, ApiException Get Routing Skill- Parameters:
request- The request object- Returns:
- RoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkill
Get Routing Skill- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillexpression
public SkillExpression getRoutingSkillexpression(String expressionId, Boolean includeArchived, String format) throws IOException, ApiException Get a skill expression by ID- Parameters:
expressionId- Expression ID (required)includeArchived- Include archived (optional, default to false)format- Response format: raw expression or normalized (optional, default to Raw)- Returns:
- SkillExpression
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillexpressionWithHttpInfo
public ApiResponse<SkillExpression> getRoutingSkillexpressionWithHttpInfo(String expressionId, Boolean includeArchived, String format) throws IOException Get a skill expression by ID- Parameters:
expressionId- Expression ID (required)includeArchived- Include archived (optional, default to false)format- Response format: raw expression or normalized (optional, default to Raw)- Returns:
- SkillExpression
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillexpression
public SkillExpression getRoutingSkillexpression(GetRoutingSkillexpressionRequest request) throws IOException, ApiException Get a skill expression by ID- Parameters:
request- The request object- Returns:
- SkillExpression
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillexpression
public ApiResponse<SkillExpression> getRoutingSkillexpression(ApiRequest<Void> request) throws IOException Get a skill expression by ID- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillexpressions
public SkillExpressionEntityListing getRoutingSkillexpressions(String format, Boolean includeArchived, List<String> id) throws IOException, ApiException Get skill expressions- Parameters:
format- Response format: raw expression or normalized (optional, default to Raw)includeArchived- Include archived (optional, default to false)id- Expression ID(s) to filter. Repeat for multiple or use comma-separated list. (optional)- Returns:
- SkillExpressionEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillexpressionsWithHttpInfo
public ApiResponse<SkillExpressionEntityListing> getRoutingSkillexpressionsWithHttpInfo(String format, Boolean includeArchived, List<String> id) throws IOException Get skill expressions- Parameters:
format- Response format: raw expression or normalized (optional, default to Raw)includeArchived- Include archived (optional, default to false)id- Expression ID(s) to filter. Repeat for multiple or use comma-separated list. (optional)- Returns:
- SkillExpressionEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillexpressions
public SkillExpressionEntityListing getRoutingSkillexpressions(GetRoutingSkillexpressionsRequest request) throws IOException, ApiException Get skill expressions- Parameters:
request- The request object- Returns:
- SkillExpressionEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillexpressions
public ApiResponse<SkillExpressionEntityListing> getRoutingSkillexpressions(ApiRequest<Void> request) throws IOException Get skill expressions- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillexpressionsQueueQueueId
public SkillExpressionEntityListing getRoutingSkillexpressionsQueueQueueId(String queueId, String format, Boolean includeArchived) throws IOException, ApiException Get skill expressions associated with a queue- Parameters:
queueId- Queue ID (required)format- Response format: raw expression or normalized (optional, default to Raw)includeArchived- Include archived (optional, default to false)- Returns:
- SkillExpressionEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillexpressionsQueueQueueIdWithHttpInfo
public ApiResponse<SkillExpressionEntityListing> getRoutingSkillexpressionsQueueQueueIdWithHttpInfo(String queueId, String format, Boolean includeArchived) throws IOException Get skill expressions associated with a queue- Parameters:
queueId- Queue ID (required)format- Response format: raw expression or normalized (optional, default to Raw)includeArchived- Include archived (optional, default to false)- Returns:
- SkillExpressionEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillexpressionsQueueQueueId
public SkillExpressionEntityListing getRoutingSkillexpressionsQueueQueueId(GetRoutingSkillexpressionsQueueQueueIdRequest request) throws IOException, ApiException Get skill expressions associated with a queue- Parameters:
request- The request object- Returns:
- SkillExpressionEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillexpressionsQueueQueueId
public ApiResponse<SkillExpressionEntityListing> getRoutingSkillexpressionsQueueQueueId(ApiRequest<Void> request) throws IOException Get skill expressions associated with a queue- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillgroup
Get skill group- Parameters:
skillGroupId- Skill Group ID (required)- Returns:
- SkillGroup
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillgroupWithHttpInfo
public ApiResponse<SkillGroup> getRoutingSkillgroupWithHttpInfo(String skillGroupId) throws IOException Get skill group- Parameters:
skillGroupId- Skill Group ID (required)- Returns:
- SkillGroup
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillgroup
public SkillGroup getRoutingSkillgroup(GetRoutingSkillgroupRequest request) throws IOException, ApiException Get skill group- Parameters:
request- The request object- Returns:
- SkillGroup
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillgroup
Get skill group- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillgroupMembers
public SkillGroupMemberEntityListing getRoutingSkillgroupMembers(String skillGroupId, Integer pageSize, String after, String before, String expand) throws IOException, ApiException Get skill group members- Parameters:
skillGroupId- Skill Group ID (required)pageSize- Page size (optional, default to 25)after- The cursor that points to the next item (optional)before- The cursor that points to the previous item (optional)expand- Expand the name on each user (optional)- Returns:
- SkillGroupMemberEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillgroupMembersWithHttpInfo
public ApiResponse<SkillGroupMemberEntityListing> getRoutingSkillgroupMembersWithHttpInfo(String skillGroupId, Integer pageSize, String after, String before, String expand) throws IOException Get skill group members- Parameters:
skillGroupId- Skill Group ID (required)pageSize- Page size (optional, default to 25)after- The cursor that points to the next item (optional)before- The cursor that points to the previous item (optional)expand- Expand the name on each user (optional)- Returns:
- SkillGroupMemberEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillgroupMembers
public SkillGroupMemberEntityListing getRoutingSkillgroupMembers(GetRoutingSkillgroupMembersRequest request) throws IOException, ApiException Get skill group members- Parameters:
request- The request object- Returns:
- SkillGroupMemberEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillgroupMembers
public ApiResponse<SkillGroupMemberEntityListing> getRoutingSkillgroupMembers(ApiRequest<Void> request) throws IOException Get skill group members- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillgroupMembersDivisions
public SkillGroupMemberDivisionList getRoutingSkillgroupMembersDivisions(String skillGroupId, String expand) throws IOException, ApiException Get list of member divisions for this skill group.- Parameters:
skillGroupId- Skill Group ID (required)expand- Expand the name on each user (optional)- Returns:
- SkillGroupMemberDivisionList
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillgroupMembersDivisionsWithHttpInfo
public ApiResponse<SkillGroupMemberDivisionList> getRoutingSkillgroupMembersDivisionsWithHttpInfo(String skillGroupId, String expand) throws IOException Get list of member divisions for this skill group.- Parameters:
skillGroupId- Skill Group ID (required)expand- Expand the name on each user (optional)- Returns:
- SkillGroupMemberDivisionList
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillgroupMembersDivisions
public SkillGroupMemberDivisionList getRoutingSkillgroupMembersDivisions(GetRoutingSkillgroupMembersDivisionsRequest request) throws IOException, ApiException Get list of member divisions for this skill group.- Parameters:
request- The request object- Returns:
- SkillGroupMemberDivisionList
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillgroupMembersDivisions
public ApiResponse<SkillGroupMemberDivisionList> getRoutingSkillgroupMembersDivisions(ApiRequest<Void> request) throws IOException Get list of member divisions for this skill group.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillgroups
public SkillGroupEntityListing getRoutingSkillgroups(Integer pageSize, String name, String after, String before) throws IOException, ApiException Get skill group listing- Parameters:
pageSize- Page size (optional, default to 25)name- Return only skill group names whose names start with this value (case-insensitive matching) (optional)after- The cursor that points to the next item (optional)before- The cursor that points to the previous item (optional)- Returns:
- SkillGroupEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillgroupsWithHttpInfo
public ApiResponse<SkillGroupEntityListing> getRoutingSkillgroupsWithHttpInfo(Integer pageSize, String name, String after, String before) throws IOException Get skill group listing- Parameters:
pageSize- Page size (optional, default to 25)name- Return only skill group names whose names start with this value (case-insensitive matching) (optional)after- The cursor that points to the next item (optional)before- The cursor that points to the previous item (optional)- Returns:
- SkillGroupEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkillgroups
public SkillGroupEntityListing getRoutingSkillgroups(GetRoutingSkillgroupsRequest request) throws IOException, ApiException Get skill group listing- Parameters:
request- The request object- Returns:
- SkillGroupEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillgroups
public ApiResponse<SkillGroupEntityListing> getRoutingSkillgroups(ApiRequest<Void> request) throws IOException Get skill group listing- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkills
public SkillEntityListing getRoutingSkills(Integer pageSize, Integer pageNumber, String name, List<String> id) throws IOException, ApiException Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)name- Filter for results that start with this value (optional)id- id (optional)- Returns:
- SkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkillsWithHttpInfo
public ApiResponse<SkillEntityListing> getRoutingSkillsWithHttpInfo(Integer pageSize, Integer pageNumber, String name, List<String> id) throws IOException Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)name- Filter for results that start with this value (optional)id- id (optional)- Returns:
- SkillEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingSkills
public SkillEntityListing getRoutingSkills(GetRoutingSkillsRequest request) throws IOException, ApiException Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.- Parameters:
request- The request object- Returns:
- SkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSkills
public ApiResponse<SkillEntityListing> getRoutingSkills(ApiRequest<Void> request) throws IOException Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSmsAddress
Get an Address by Id for SMS- Parameters:
addressId- Address ID (required)- Returns:
- SmsAddress
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSmsAddressWithHttpInfo
public ApiResponse<SmsAddress> getRoutingSmsAddressWithHttpInfo(String addressId) throws IOException Get an Address by Id for SMS- Parameters:
addressId- Address ID (required)- Returns:
- SmsAddress
- Throws:
IOException- if the request fails to be processed
-
getRoutingSmsAddress
public SmsAddress getRoutingSmsAddress(GetRoutingSmsAddressRequest request) throws IOException, ApiException Get an Address by Id for SMS- Parameters:
request- The request object- Returns:
- SmsAddress
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSmsAddress
Get an Address by Id for SMS- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSmsAddresses
public SmsAddressEntityListing getRoutingSmsAddresses(Integer pageSize, Integer pageNumber) throws IOException, ApiException Get a list of Addresses for SMS- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)- Returns:
- SmsAddressEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSmsAddressesWithHttpInfo
public ApiResponse<SmsAddressEntityListing> getRoutingSmsAddressesWithHttpInfo(Integer pageSize, Integer pageNumber) throws IOException Get a list of Addresses for SMS- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)- Returns:
- SmsAddressEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingSmsAddresses
public SmsAddressEntityListing getRoutingSmsAddresses(GetRoutingSmsAddressesRequest request) throws IOException, ApiException Get a list of Addresses for SMS- Parameters:
request- The request object- Returns:
- SmsAddressEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSmsAddresses
public ApiResponse<SmsAddressEntityListing> getRoutingSmsAddresses(ApiRequest<Void> request) throws IOException Get a list of Addresses for SMS- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSmsAvailablephonenumbers
public SMSAvailablePhoneNumberEntityListing getRoutingSmsAvailablephonenumbers(String countryCode, String phoneNumberType, String region, String city, String areaCode, String pattern, String addressRequirement) throws IOException, ApiException Get a list of available phone numbers for SMS provisioning. This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.- Parameters:
countryCode- The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned (required)phoneNumberType- Type of available phone numbers searched (required)region- Region/province/state that can be used to restrict the numbers returned (optional)city- City that can be used to restrict the numbers returned (optional)areaCode- Area code that can be used to restrict the numbers returned (optional)pattern- A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit. (optional)addressRequirement- This indicates whether the phone number requires to have an Address registered. (optional)- Returns:
- SMSAvailablePhoneNumberEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSmsAvailablephonenumbersWithHttpInfo
public ApiResponse<SMSAvailablePhoneNumberEntityListing> getRoutingSmsAvailablephonenumbersWithHttpInfo(String countryCode, String phoneNumberType, String region, String city, String areaCode, String pattern, String addressRequirement) throws IOException Get a list of available phone numbers for SMS provisioning. This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.- Parameters:
countryCode- The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned (required)phoneNumberType- Type of available phone numbers searched (required)region- Region/province/state that can be used to restrict the numbers returned (optional)city- City that can be used to restrict the numbers returned (optional)areaCode- Area code that can be used to restrict the numbers returned (optional)pattern- A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit. (optional)addressRequirement- This indicates whether the phone number requires to have an Address registered. (optional)- Returns:
- SMSAvailablePhoneNumberEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingSmsAvailablephonenumbers
public SMSAvailablePhoneNumberEntityListing getRoutingSmsAvailablephonenumbers(GetRoutingSmsAvailablephonenumbersRequest request) throws IOException, ApiException Get a list of available phone numbers for SMS provisioning. This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.- Parameters:
request- The request object- Returns:
- SMSAvailablePhoneNumberEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSmsAvailablephonenumbers
public ApiResponse<SMSAvailablePhoneNumberEntityListing> getRoutingSmsAvailablephonenumbers(ApiRequest<Void> request) throws IOException Get a list of available phone numbers for SMS provisioning. This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSmsIdentityresolutionPhonenumber
public SmsIdentityResolutionConfig getRoutingSmsIdentityresolutionPhonenumber(String addressId) throws IOException, ApiException Get a SMS identity resolution settings.- Parameters:
addressId- Address ID (required)- Returns:
- SmsIdentityResolutionConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSmsIdentityresolutionPhonenumberWithHttpInfo
public ApiResponse<SmsIdentityResolutionConfig> getRoutingSmsIdentityresolutionPhonenumberWithHttpInfo(String addressId) throws IOException Get a SMS identity resolution settings.- Parameters:
addressId- Address ID (required)- Returns:
- SmsIdentityResolutionConfig
- Throws:
IOException- if the request fails to be processed
-
getRoutingSmsIdentityresolutionPhonenumber
public SmsIdentityResolutionConfig getRoutingSmsIdentityresolutionPhonenumber(GetRoutingSmsIdentityresolutionPhonenumberRequest request) throws IOException, ApiException Get a SMS identity resolution settings.- Parameters:
request- The request object- Returns:
- SmsIdentityResolutionConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSmsIdentityresolutionPhonenumber
public ApiResponse<SmsIdentityResolutionConfig> getRoutingSmsIdentityresolutionPhonenumber(ApiRequest<Void> request) throws IOException Get a SMS identity resolution settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSmsPhonenumber
public SmsPhoneNumber getRoutingSmsPhonenumber(String phoneNumberId, String expand) throws IOException, ApiException Get a phone number provisioned for SMS. When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile using the PATCH endpoint.- Parameters:
phoneNumberId- phone number (required)expand- Expand response with additional information (optional)- Returns:
- SmsPhoneNumber
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSmsPhonenumberWithHttpInfo
public ApiResponse<SmsPhoneNumber> getRoutingSmsPhonenumberWithHttpInfo(String phoneNumberId, String expand) throws IOException Get a phone number provisioned for SMS. When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile using the PATCH endpoint.- Parameters:
phoneNumberId- phone number (required)expand- Expand response with additional information (optional)- Returns:
- SmsPhoneNumber
- Throws:
IOException- if the request fails to be processed
-
getRoutingSmsPhonenumber
public SmsPhoneNumber getRoutingSmsPhonenumber(GetRoutingSmsPhonenumberRequest request) throws IOException, ApiException Get a phone number provisioned for SMS. When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile using the PATCH endpoint.- Parameters:
request- The request object- Returns:
- SmsPhoneNumber
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSmsPhonenumber
public ApiResponse<SmsPhoneNumber> getRoutingSmsPhonenumber(ApiRequest<Void> request) throws IOException Get a phone number provisioned for SMS. When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile using the PATCH endpoint.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingSmsPhonenumbers
public SmsPhoneNumberEntityListing getRoutingSmsPhonenumbers(String phoneNumber, List<String> phoneNumberType, List<String> phoneNumberStatus, List<String> countryCode, Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String language, String integrationId, String supportedContentId, List<String> expand) throws IOException, ApiException Get a list of provisioned phone numbers. When no supported content profile is explicitly set, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile.- Parameters:
phoneNumber- Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used. (optional)phoneNumberType- Filter on phone number type (optional)phoneNumberStatus- Filter on phone number status (optional)countryCode- Filter on country code (optional)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortBy- Optional field to sort results (optional)sortOrder- Sort order (optional)language- A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize country field and sort operations (optional, default to "en-US")integrationId- Filter on the Genesys Cloud integration id to which the phone number belongs to (optional)supportedContentId- Filter based on the supported content ID (optional)expand- Which fields, if any, to expand (optional)- Returns:
- SmsPhoneNumberEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSmsPhonenumbersWithHttpInfo
public ApiResponse<SmsPhoneNumberEntityListing> getRoutingSmsPhonenumbersWithHttpInfo(String phoneNumber, List<String> phoneNumberType, List<String> phoneNumberStatus, List<String> countryCode, Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String language, String integrationId, String supportedContentId, List<String> expand) throws IOException Get a list of provisioned phone numbers. When no supported content profile is explicitly set, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile.- Parameters:
phoneNumber- Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used. (optional)phoneNumberType- Filter on phone number type (optional)phoneNumberStatus- Filter on phone number status (optional)countryCode- Filter on country code (optional)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortBy- Optional field to sort results (optional)sortOrder- Sort order (optional)language- A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize country field and sort operations (optional, default to "en-US")integrationId- Filter on the Genesys Cloud integration id to which the phone number belongs to (optional)supportedContentId- Filter based on the supported content ID (optional)expand- Which fields, if any, to expand (optional)- Returns:
- SmsPhoneNumberEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingSmsPhonenumbers
public SmsPhoneNumberEntityListing getRoutingSmsPhonenumbers(GetRoutingSmsPhonenumbersRequest request) throws IOException, ApiException Get a list of provisioned phone numbers. When no supported content profile is explicitly set, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile.- Parameters:
request- The request object- Returns:
- SmsPhoneNumberEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingSmsPhonenumbers
public ApiResponse<SmsPhoneNumberEntityListing> getRoutingSmsPhonenumbers(ApiRequest<Void> request) throws IOException Get a list of provisioned phone numbers. When no supported content profile is explicitly set, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingUserDirectroutingbackupSettings
public AgentDirectRoutingBackupSettings getRoutingUserDirectroutingbackupSettings(String userId) throws IOException, ApiException Get the user's Direct Routing Backup settings.- Parameters:
userId- User ID (required)- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUserDirectroutingbackupSettingsWithHttpInfo
public ApiResponse<AgentDirectRoutingBackupSettings> getRoutingUserDirectroutingbackupSettingsWithHttpInfo(String userId) throws IOException Get the user's Direct Routing Backup settings.- Parameters:
userId- User ID (required)- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
IOException- if the request fails to be processed
-
getRoutingUserDirectroutingbackupSettings
public AgentDirectRoutingBackupSettings getRoutingUserDirectroutingbackupSettings(GetRoutingUserDirectroutingbackupSettingsRequest request) throws IOException, ApiException Get the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUserDirectroutingbackupSettings
public ApiResponse<AgentDirectRoutingBackupSettings> getRoutingUserDirectroutingbackupSettings(ApiRequest<Void> request) throws IOException Get the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingUserUtilization
public AgentMaxUtilizationResponse getRoutingUserUtilization(String userId) throws IOException, ApiException Get the user's max utilization settings. If not configured, the organization-wide default is returned.- Parameters:
userId- User ID (required)- Returns:
- AgentMaxUtilizationResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUserUtilizationWithHttpInfo
public ApiResponse<AgentMaxUtilizationResponse> getRoutingUserUtilizationWithHttpInfo(String userId) throws IOException Get the user's max utilization settings. If not configured, the organization-wide default is returned.- Parameters:
userId- User ID (required)- Returns:
- AgentMaxUtilizationResponse
- Throws:
IOException- if the request fails to be processed
-
getRoutingUserUtilization
public AgentMaxUtilizationResponse getRoutingUserUtilization(GetRoutingUserUtilizationRequest request) throws IOException, ApiException Get the user's max utilization settings. If not configured, the organization-wide default is returned.- Parameters:
request- The request object- Returns:
- AgentMaxUtilizationResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUserUtilization
public ApiResponse<AgentMaxUtilizationResponse> getRoutingUserUtilization(ApiRequest<Void> request) throws IOException Get the user's max utilization settings. If not configured, the organization-wide default is returned.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingUtilization
Get the organization-wide max utilization settings.- Returns:
- UtilizationResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUtilizationWithHttpInfo
Get the organization-wide max utilization settings.- Returns:
- UtilizationResponse
- Throws:
IOException- if the request fails to be processed
-
getRoutingUtilization
public UtilizationResponse getRoutingUtilization(GetRoutingUtilizationRequest request) throws IOException, ApiException Get the organization-wide max utilization settings.- Parameters:
request- The request object- Returns:
- UtilizationResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUtilization
public ApiResponse<UtilizationResponse> getRoutingUtilization(ApiRequest<Void> request) throws IOException Get the organization-wide max utilization settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingUtilizationLabel
Get details about this utilization label- Parameters:
labelId- Utilization Label ID (required)- Returns:
- UtilizationLabel
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUtilizationLabelWithHttpInfo
public ApiResponse<UtilizationLabel> getRoutingUtilizationLabelWithHttpInfo(String labelId) throws IOException Get details about this utilization label- Parameters:
labelId- Utilization Label ID (required)- Returns:
- UtilizationLabel
- Throws:
IOException- if the request fails to be processed
-
getRoutingUtilizationLabel
public UtilizationLabel getRoutingUtilizationLabel(GetRoutingUtilizationLabelRequest request) throws IOException, ApiException Get details about this utilization label- Parameters:
request- The request object- Returns:
- UtilizationLabel
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUtilizationLabel
public ApiResponse<UtilizationLabel> getRoutingUtilizationLabel(ApiRequest<Void> request) throws IOException Get details about this utilization label- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingUtilizationLabelAgents
public List<Object> getRoutingUtilizationLabelAgents(String labelId) throws IOException, ApiException Get list of agent ids associated with a utilization label- Parameters:
labelId- Utilization Label ID (required)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUtilizationLabelAgentsWithHttpInfo
public ApiResponse<List<Object>> getRoutingUtilizationLabelAgentsWithHttpInfo(String labelId) throws IOException Get list of agent ids associated with a utilization label- Parameters:
labelId- Utilization Label ID (required)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
getRoutingUtilizationLabelAgents
public List<Object> getRoutingUtilizationLabelAgents(GetRoutingUtilizationLabelAgentsRequest request) throws IOException, ApiException Get list of agent ids associated with a utilization label- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUtilizationLabelAgents
public ApiResponse<List<Object>> getRoutingUtilizationLabelAgents(ApiRequest<Void> request) throws IOException Get list of agent ids associated with a utilization label- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingUtilizationLabels
public UtilizationLabelEntityListing getRoutingUtilizationLabels(Integer pageSize, Integer pageNumber, String sortOrder, String name) throws IOException, ApiException Get list of utilization labels- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Sort order by name (optional, default to ascending)name- Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*' (optional)- Returns:
- UtilizationLabelEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUtilizationLabelsWithHttpInfo
public ApiResponse<UtilizationLabelEntityListing> getRoutingUtilizationLabelsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortOrder, String name) throws IOException Get list of utilization labels- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Sort order by name (optional, default to ascending)name- Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*' (optional)- Returns:
- UtilizationLabelEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingUtilizationLabels
public UtilizationLabelEntityListing getRoutingUtilizationLabels(GetRoutingUtilizationLabelsRequest request) throws IOException, ApiException Get list of utilization labels- Parameters:
request- The request object- Returns:
- UtilizationLabelEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUtilizationLabels
public ApiResponse<UtilizationLabelEntityListing> getRoutingUtilizationLabels(ApiRequest<Void> request) throws IOException Get list of utilization labels- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingWrapupcode
Get details about this wrap-up code.- Parameters:
codeId- Wrapup Code ID (required)- Returns:
- WrapupCode
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingWrapupcodeWithHttpInfo
Get details about this wrap-up code.- Parameters:
codeId- Wrapup Code ID (required)- Returns:
- WrapupCode
- Throws:
IOException- if the request fails to be processed
-
getRoutingWrapupcode
public WrapupCode getRoutingWrapupcode(GetRoutingWrapupcodeRequest request) throws IOException, ApiException Get details about this wrap-up code.- Parameters:
request- The request object- Returns:
- WrapupCode
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingWrapupcode
Get details about this wrap-up code.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingWrapupcodes
public WrapupCodeEntityListing getRoutingWrapupcodes(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id, List<String> divisionId) throws IOException, ApiException Get list of wrapup codes.- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortBy- Sort by (optional, default to name)sortOrder- Sort order (optional, default to ascending)name- Wrapup code's name ('Sort by' param is ignored unless this field is provided) (optional)id- Filter by wrapup code ID(s) (optional)divisionId- Filter by division ID(s) (optional)- Returns:
- WrapupCodeEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingWrapupcodesWithHttpInfo
public ApiResponse<WrapupCodeEntityListing> getRoutingWrapupcodesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id, List<String> divisionId) throws IOException Get list of wrapup codes.- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortBy- Sort by (optional, default to name)sortOrder- Sort order (optional, default to ascending)name- Wrapup code's name ('Sort by' param is ignored unless this field is provided) (optional)id- Filter by wrapup code ID(s) (optional)divisionId- Filter by division ID(s) (optional)- Returns:
- WrapupCodeEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingWrapupcodes
public WrapupCodeEntityListing getRoutingWrapupcodes(GetRoutingWrapupcodesRequest request) throws IOException, ApiException Get list of wrapup codes.- Parameters:
request- The request object- Returns:
- WrapupCodeEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingWrapupcodes
public ApiResponse<WrapupCodeEntityListing> getRoutingWrapupcodes(ApiRequest<Void> request) throws IOException Get list of wrapup codes.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingWrapupcodesDivisionview
Get a simplified wrap-up code.- Parameters:
codeId- Wrapup Code ID (required)- Returns:
- WrapupCode
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingWrapupcodesDivisionviewWithHttpInfo
public ApiResponse<WrapupCode> getRoutingWrapupcodesDivisionviewWithHttpInfo(String codeId) throws IOException Get a simplified wrap-up code.- Parameters:
codeId- Wrapup Code ID (required)- Returns:
- WrapupCode
- Throws:
IOException- if the request fails to be processed
-
getRoutingWrapupcodesDivisionview
public WrapupCode getRoutingWrapupcodesDivisionview(GetRoutingWrapupcodesDivisionviewRequest request) throws IOException, ApiException Get a simplified wrap-up code.- Parameters:
request- The request object- Returns:
- WrapupCode
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingWrapupcodesDivisionview
public ApiResponse<WrapupCode> getRoutingWrapupcodesDivisionview(ApiRequest<Void> request) throws IOException Get a simplified wrap-up code.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingWrapupcodesDivisionviews
public WrapupCodeEntityListing getRoutingWrapupcodesDivisionviews(Integer pageSize, Integer pageNumber, String name, List<String> id, List<String> divisionId, String includeState) throws IOException, ApiException Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s). Specifying both name and ID parameters is not supported.- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)name- Name (trailing asterisks allowed) (optional)id- Wrapup code ID(s) (optional)divisionId- Division ID(s) (optional)includeState- Wrapup code state(s) to include (optional)- Returns:
- WrapupCodeEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingWrapupcodesDivisionviewsWithHttpInfo
public ApiResponse<WrapupCodeEntityListing> getRoutingWrapupcodesDivisionviewsWithHttpInfo(Integer pageSize, Integer pageNumber, String name, List<String> id, List<String> divisionId, String includeState) throws IOException Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s). Specifying both name and ID parameters is not supported.- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)name- Name (trailing asterisks allowed) (optional)id- Wrapup code ID(s) (optional)divisionId- Division ID(s) (optional)includeState- Wrapup code state(s) to include (optional)- Returns:
- WrapupCodeEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRoutingWrapupcodesDivisionviews
public WrapupCodeEntityListing getRoutingWrapupcodesDivisionviews(GetRoutingWrapupcodesDivisionviewsRequest request) throws IOException, ApiException Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s). Specifying both name and ID parameters is not supported.- Parameters:
request- The request object- Returns:
- WrapupCodeEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingWrapupcodesDivisionviews
public ApiResponse<WrapupCodeEntityListing> getRoutingWrapupcodesDivisionviews(ApiRequest<Void> request) throws IOException Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s). Specifying both name and ID parameters is not supported.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserQueues
public UserQueueEntityListing getUserQueues(String userId, Integer pageSize, Integer pageNumber, Boolean joined, List<String> divisionId) throws IOException, ApiException Get queues for user- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)joined- Is joined to the queue (optional, default to true)divisionId- Division ID(s) (optional)- Returns:
- UserQueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserQueuesWithHttpInfo
public ApiResponse<UserQueueEntityListing> getUserQueuesWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, Boolean joined, List<String> divisionId) throws IOException Get queues for user- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)joined- Is joined to the queue (optional, default to true)divisionId- Division ID(s) (optional)- Returns:
- UserQueueEntityListing
- Throws:
IOException- if the request fails to be processed
-
getUserQueues
public UserQueueEntityListing getUserQueues(GetUserQueuesRequest request) throws IOException, ApiException Get queues for user- Parameters:
request- The request object- Returns:
- UserQueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserQueues
public ApiResponse<UserQueueEntityListing> getUserQueues(ApiRequest<Void> request) throws IOException Get queues for user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserRoutinglanguages
public UserLanguageEntityListing getUserRoutinglanguages(String userId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException, ApiException List routing languages assigned to a user- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Ascending or descending sort order (optional, default to ASC)- Returns:
- UserLanguageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserRoutinglanguagesWithHttpInfo
public ApiResponse<UserLanguageEntityListing> getUserRoutinglanguagesWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException List routing languages assigned to a user- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Ascending or descending sort order (optional, default to ASC)- Returns:
- UserLanguageEntityListing
- Throws:
IOException- if the request fails to be processed
-
getUserRoutinglanguages
public UserLanguageEntityListing getUserRoutinglanguages(GetUserRoutinglanguagesRequest request) throws IOException, ApiException List routing languages assigned to a user- Parameters:
request- The request object- Returns:
- UserLanguageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserRoutinglanguages
public ApiResponse<UserLanguageEntityListing> getUserRoutinglanguages(ApiRequest<Void> request) throws IOException List routing languages assigned to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserRoutingskills
public UserSkillEntityListing getUserRoutingskills(String userId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException, ApiException List routing skills assigned to a user- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Ascending or descending sort order (optional, default to ASC)- Returns:
- UserSkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserRoutingskillsWithHttpInfo
public ApiResponse<UserSkillEntityListing> getUserRoutingskillsWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException List routing skills assigned to a user- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Ascending or descending sort order (optional, default to ASC)- Returns:
- UserSkillEntityListing
- Throws:
IOException- if the request fails to be processed
-
getUserRoutingskills
public UserSkillEntityListing getUserRoutingskills(GetUserRoutingskillsRequest request) throws IOException, ApiException List routing skills assigned to a user- Parameters:
request- The request object- Returns:
- UserSkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserRoutingskills
public ApiResponse<UserSkillEntityListing> getUserRoutingskills(ApiRequest<Void> request) throws IOException List routing skills assigned to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserSkillgroups
public UserSkillGroupEntityListing getUserSkillgroups(String userId, Integer pageSize, String after, String before) throws IOException, ApiException Get skill groups for a user- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)after- The cursor that points to the next page (optional)before- The cursor that points to the previous page (optional)- Returns:
- UserSkillGroupEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserSkillgroupsWithHttpInfo
public ApiResponse<UserSkillGroupEntityListing> getUserSkillgroupsWithHttpInfo(String userId, Integer pageSize, String after, String before) throws IOException Get skill groups for a user- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)after- The cursor that points to the next page (optional)before- The cursor that points to the previous page (optional)- Returns:
- UserSkillGroupEntityListing
- Throws:
IOException- if the request fails to be processed
-
getUserSkillgroups
public UserSkillGroupEntityListing getUserSkillgroups(GetUserSkillgroupsRequest request) throws IOException, ApiException Get skill groups for a user- Parameters:
request- The request object- Returns:
- UserSkillGroupEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserSkillgroups
public ApiResponse<UserSkillGroupEntityListing> getUserSkillgroups(ApiRequest<Void> request) throws IOException Get skill groups for a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingConversation
public RoutingConversationAttributesResponse patchRoutingConversation(String conversationId, RoutingConversationAttributesRequest body) throws IOException, ApiException Update attributes of an in-queue conversation Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, skillExpression, languageId, and priority.- Parameters:
conversationId- Conversation ID (required)body- Conversation Attributes (required)- Returns:
- RoutingConversationAttributesResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingConversationWithHttpInfo
public ApiResponse<RoutingConversationAttributesResponse> patchRoutingConversationWithHttpInfo(String conversationId, RoutingConversationAttributesRequest body) throws IOException Update attributes of an in-queue conversation Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, skillExpression, languageId, and priority.- Parameters:
conversationId- Conversation ID (required)body- Conversation Attributes (required)- Returns:
- RoutingConversationAttributesResponse
- Throws:
IOException- if the request fails to be processed
-
patchRoutingConversation
public RoutingConversationAttributesResponse patchRoutingConversation(PatchRoutingConversationRequest request) throws IOException, ApiException Update attributes of an in-queue conversation Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, skillExpression, languageId, and priority.- Parameters:
request- The request object- Returns:
- RoutingConversationAttributesResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingConversation
public ApiResponse<RoutingConversationAttributesResponse> patchRoutingConversation(ApiRequest<RoutingConversationAttributesRequest> request) throws IOException Update attributes of an in-queue conversation Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, skillExpression, languageId, and priority.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingEmailDomain
public InboundDomain patchRoutingEmailDomain(String domainId, InboundDomainPatchRequest body) throws IOException, ApiException Update domain settings- Parameters:
domainId- domain ID (required)body- Domain settings (required)- Returns:
- InboundDomain
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingEmailDomainWithHttpInfo
public ApiResponse<InboundDomain> patchRoutingEmailDomainWithHttpInfo(String domainId, InboundDomainPatchRequest body) throws IOException Update domain settings- Parameters:
domainId- domain ID (required)body- Domain settings (required)- Returns:
- InboundDomain
- Throws:
IOException- if the request fails to be processed
-
patchRoutingEmailDomain
public InboundDomain patchRoutingEmailDomain(PatchRoutingEmailDomainRequest request) throws IOException, ApiException Update domain settings- Parameters:
request- The request object- Returns:
- InboundDomain
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingEmailDomain
public ApiResponse<InboundDomain> patchRoutingEmailDomain(ApiRequest<InboundDomainPatchRequest> request) throws IOException Update domain settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingEmailDomainValidate
public InboundDomain patchRoutingEmailDomainValidate(String domainId, InboundDomainPatchRequest body) throws IOException, ApiException Validate domain settings- Parameters:
domainId- domain ID (required)body- Domain settings (required)- Returns:
- InboundDomain
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingEmailDomainValidateWithHttpInfo
public ApiResponse<InboundDomain> patchRoutingEmailDomainValidateWithHttpInfo(String domainId, InboundDomainPatchRequest body) throws IOException Validate domain settings- Parameters:
domainId- domain ID (required)body- Domain settings (required)- Returns:
- InboundDomain
- Throws:
IOException- if the request fails to be processed
-
patchRoutingEmailDomainValidate
public InboundDomain patchRoutingEmailDomainValidate(PatchRoutingEmailDomainValidateRequest request) throws IOException, ApiException Validate domain settings- Parameters:
request- The request object- Returns:
- InboundDomain
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingEmailDomainValidate
public ApiResponse<InboundDomain> patchRoutingEmailDomainValidate(ApiRequest<InboundDomainPatchRequest> request) throws IOException Validate domain settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingEmailOutboundDomain
public OutboundDomain patchRoutingEmailOutboundDomain(String domainId, OutboundDomainPatchRequest body) throws IOException, ApiException Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).- Parameters:
domainId- domain ID (required)body- Domain settings (required)- Returns:
- OutboundDomain
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingEmailOutboundDomainWithHttpInfo
public ApiResponse<OutboundDomain> patchRoutingEmailOutboundDomainWithHttpInfo(String domainId, OutboundDomainPatchRequest body) throws IOException Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).- Parameters:
domainId- domain ID (required)body- Domain settings (required)- Returns:
- OutboundDomain
- Throws:
IOException- if the request fails to be processed
-
patchRoutingEmailOutboundDomain
public OutboundDomain patchRoutingEmailOutboundDomain(PatchRoutingEmailOutboundDomainRequest request) throws IOException, ApiException Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).- Parameters:
request- The request object- Returns:
- OutboundDomain
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingEmailOutboundDomain
public ApiResponse<OutboundDomain> patchRoutingEmailOutboundDomain(ApiRequest<OutboundDomainPatchRequest> request) throws IOException Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingEmailSettingEmailSettingId
public EmailSetting patchRoutingEmailSettingEmailSettingId(String emailSettingId, EmailSetting body) throws IOException, ApiException Update an email setting. Modifies the settings for email setting- Parameters:
emailSettingId- Email Setting ID (required)body- EmailSetting (required)- Returns:
- EmailSetting
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingEmailSettingEmailSettingIdWithHttpInfo
public ApiResponse<EmailSetting> patchRoutingEmailSettingEmailSettingIdWithHttpInfo(String emailSettingId, EmailSetting body) throws IOException Update an email setting. Modifies the settings for email setting- Parameters:
emailSettingId- Email Setting ID (required)body- EmailSetting (required)- Returns:
- EmailSetting
- Throws:
IOException- if the request fails to be processed
-
patchRoutingEmailSettingEmailSettingId
public EmailSetting patchRoutingEmailSettingEmailSettingId(PatchRoutingEmailSettingEmailSettingIdRequest request) throws IOException, ApiException Update an email setting. Modifies the settings for email setting- Parameters:
request- The request object- Returns:
- EmailSetting
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingEmailSettingEmailSettingId
public ApiResponse<EmailSetting> patchRoutingEmailSettingEmailSettingId(ApiRequest<EmailSetting> request) throws IOException Update an email setting. Modifies the settings for email setting- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingPredictor
public Predictor patchRoutingPredictor(String predictorId, PatchPredictorRequest body) throws IOException, ApiException Update single predictor.- Parameters:
predictorId- Predictor ID (required)body- (optional)- Returns:
- Predictor
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingPredictorWithHttpInfo
public ApiResponse<Predictor> patchRoutingPredictorWithHttpInfo(String predictorId, PatchPredictorRequest body) throws IOException Update single predictor.- Parameters:
predictorId- Predictor ID (required)body- (optional)- Returns:
- Predictor
- Throws:
IOException- if the request fails to be processed
-
patchRoutingPredictor
public Predictor patchRoutingPredictor(PatchRoutingPredictorRequest request) throws IOException, ApiException Update single predictor.- Parameters:
request- The request object- Returns:
- Predictor
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingPredictor
public ApiResponse<Predictor> patchRoutingPredictor(ApiRequest<PatchPredictorRequest> request) throws IOException Update single predictor.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingPredictorsKeyperformanceindicator
public KeyPerformanceIndicator patchRoutingPredictorsKeyperformanceindicator(String kpiId, UpdateKpiRequest body) throws IOException, ApiException Update a custom Key Performance Indicator. patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
kpiId- Key Performance Indicator ID (required)body- (optional)- Returns:
- KeyPerformanceIndicator
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingPredictorsKeyperformanceindicatorWithHttpInfo
public ApiResponse<KeyPerformanceIndicator> patchRoutingPredictorsKeyperformanceindicatorWithHttpInfo(String kpiId, UpdateKpiRequest body) throws IOException Update a custom Key Performance Indicator. patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
kpiId- Key Performance Indicator ID (required)body- (optional)- Returns:
- KeyPerformanceIndicator
- Throws:
IOException- if the request fails to be processed
-
patchRoutingPredictorsKeyperformanceindicator
public KeyPerformanceIndicator patchRoutingPredictorsKeyperformanceindicator(PatchRoutingPredictorsKeyperformanceindicatorRequest request) throws IOException, ApiException Update a custom Key Performance Indicator. patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
request- The request object- Returns:
- KeyPerformanceIndicator
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingPredictorsKeyperformanceindicator
public ApiResponse<KeyPerformanceIndicator> patchRoutingPredictorsKeyperformanceindicator(ApiRequest<UpdateKpiRequest> request) throws IOException Update a custom Key Performance Indicator. patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingQueueMember
public void patchRoutingQueueMember(String queueId, String memberId, QueueMember body) throws IOException, ApiException Update the ring number OR joined status for a queue member.- Parameters:
queueId- Queue ID (required)memberId- Member ID (required)body- Queue Member (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingQueueMemberWithHttpInfo
public ApiResponse<Void> patchRoutingQueueMemberWithHttpInfo(String queueId, String memberId, QueueMember body) throws IOException Update the ring number OR joined status for a queue member.- Parameters:
queueId- Queue ID (required)memberId- Member ID (required)body- Queue Member (required)- Throws:
IOException- if the request fails to be processed
-
patchRoutingQueueMember
public void patchRoutingQueueMember(PatchRoutingQueueMemberRequest request) throws IOException, ApiException Update the ring number OR joined status for a queue member.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingQueueMember
public ApiResponse<Void> patchRoutingQueueMember(ApiRequest<QueueMember> request) throws IOException Update the ring number OR joined status for a queue member.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingQueueMembers
public QueueMemberEntityListing patchRoutingQueueMembers(String queueId, List<QueueMember> body) throws IOException, ApiException Join or unjoin a set of up to 100 users for a queue Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.- Parameters:
queueId- Queue ID (required)body- Queue Members (required)- Returns:
- QueueMemberEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingQueueMembersWithHttpInfo
public ApiResponse<QueueMemberEntityListing> patchRoutingQueueMembersWithHttpInfo(String queueId, List<QueueMember> body) throws IOException Join or unjoin a set of up to 100 users for a queue Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.- Parameters:
queueId- Queue ID (required)body- Queue Members (required)- Returns:
- QueueMemberEntityListing
- Throws:
IOException- if the request fails to be processed
-
patchRoutingQueueMembers
public QueueMemberEntityListing patchRoutingQueueMembers(PatchRoutingQueueMembersRequest request) throws IOException, ApiException Join or unjoin a set of up to 100 users for a queue Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.- Parameters:
request- The request object- Returns:
- QueueMemberEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingQueueMembers
public ApiResponse<QueueMemberEntityListing> patchRoutingQueueMembers(ApiRequest<List<QueueMember>> request) throws IOException Join or unjoin a set of up to 100 users for a queue Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingQueueUser
public void patchRoutingQueueUser(String queueId, String memberId, QueueMember body) throws IOException, ApiException Deprecated.DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.- Parameters:
queueId- Queue ID (required)memberId- Member ID (required)body- Queue Member (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingQueueUserWithHttpInfo
public ApiResponse<Void> patchRoutingQueueUserWithHttpInfo(String queueId, String memberId, QueueMember body) throws IOException Deprecated.DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.- Parameters:
queueId- Queue ID (required)memberId- Member ID (required)body- Queue Member (required)- Throws:
IOException- if the request fails to be processed
-
patchRoutingQueueUser
public void patchRoutingQueueUser(PatchRoutingQueueUserRequest request) throws IOException, ApiException Deprecated.DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingQueueUser
Deprecated.DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingQueueUsers
public QueueMemberEntityListingV1 patchRoutingQueueUsers(String queueId, List<QueueMember> body) throws IOException, ApiException Deprecated.DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.- Parameters:
queueId- Queue ID (required)body- Queue Members (required)- Returns:
- QueueMemberEntityListingV1
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingQueueUsersWithHttpInfo
public ApiResponse<QueueMemberEntityListingV1> patchRoutingQueueUsersWithHttpInfo(String queueId, List<QueueMember> body) throws IOException Deprecated.DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.- Parameters:
queueId- Queue ID (required)body- Queue Members (required)- Returns:
- QueueMemberEntityListingV1
- Throws:
IOException- if the request fails to be processed
-
patchRoutingQueueUsers
public QueueMemberEntityListingV1 patchRoutingQueueUsers(PatchRoutingQueueUsersRequest request) throws IOException, ApiException Deprecated.DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.- Parameters:
request- The request object- Returns:
- QueueMemberEntityListingV1
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingQueueUsers
public ApiResponse<QueueMemberEntityListingV1> patchRoutingQueueUsers(ApiRequest<List<QueueMember>> request) throws IOException Deprecated.DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingSettingsContactcenter
public void patchRoutingSettingsContactcenter(ContactCenterSettings body) throws IOException, ApiException Update Contact Center Settings- Parameters:
body- Contact Center Settings (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingSettingsContactcenterWithHttpInfo
public ApiResponse<Void> patchRoutingSettingsContactcenterWithHttpInfo(ContactCenterSettings body) throws IOException Update Contact Center Settings- Parameters:
body- Contact Center Settings (required)- Throws:
IOException- if the request fails to be processed
-
patchRoutingSettingsContactcenter
public void patchRoutingSettingsContactcenter(PatchRoutingSettingsContactcenterRequest request) throws IOException, ApiException Update Contact Center Settings- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingSettingsContactcenter
public ApiResponse<Void> patchRoutingSettingsContactcenter(ApiRequest<ContactCenterSettings> request) throws IOException Update Contact Center Settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingSettingsTranscription
public TranscriptionSettings patchRoutingSettingsTranscription(TranscriptionSettings body) throws IOException, ApiException Patch Transcription Settings- Parameters:
body- Organization Settings (required)- Returns:
- TranscriptionSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingSettingsTranscriptionWithHttpInfo
public ApiResponse<TranscriptionSettings> patchRoutingSettingsTranscriptionWithHttpInfo(TranscriptionSettings body) throws IOException Patch Transcription Settings- Parameters:
body- Organization Settings (required)- Returns:
- TranscriptionSettings
- Throws:
IOException- if the request fails to be processed
-
patchRoutingSettingsTranscription
public TranscriptionSettings patchRoutingSettingsTranscription(PatchRoutingSettingsTranscriptionRequest request) throws IOException, ApiException Patch Transcription Settings- Parameters:
request- The request object- Returns:
- TranscriptionSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingSettingsTranscription
public ApiResponse<TranscriptionSettings> patchRoutingSettingsTranscription(ApiRequest<TranscriptionSettings> request) throws IOException Patch Transcription Settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingSkill
public RoutingSkill patchRoutingSkill(String skillId, UpdateSkillDivisionRequest body) throws IOException, ApiException Update Routing Skill Division- Parameters:
skillId- Skill ID (required)body- updateSkillDivisionRequest (required)- Returns:
- RoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingSkillWithHttpInfo
public ApiResponse<RoutingSkill> patchRoutingSkillWithHttpInfo(String skillId, UpdateSkillDivisionRequest body) throws IOException Update Routing Skill Division- Parameters:
skillId- Skill ID (required)body- updateSkillDivisionRequest (required)- Returns:
- RoutingSkill
- Throws:
IOException- if the request fails to be processed
-
patchRoutingSkill
public RoutingSkill patchRoutingSkill(PatchRoutingSkillRequest request) throws IOException, ApiException Update Routing Skill Division- Parameters:
request- The request object- Returns:
- RoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingSkill
public ApiResponse<RoutingSkill> patchRoutingSkill(ApiRequest<UpdateSkillDivisionRequest> request) throws IOException Update Routing Skill Division- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingSkillgroup
public SkillGroup patchRoutingSkillgroup(String skillGroupId, SkillGroup body) throws IOException, ApiException Update skill group definition- Parameters:
skillGroupId- Skill Group ID (required)body- Update skill groups (required)- Returns:
- SkillGroup
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingSkillgroupWithHttpInfo
public ApiResponse<SkillGroup> patchRoutingSkillgroupWithHttpInfo(String skillGroupId, SkillGroup body) throws IOException Update skill group definition- Parameters:
skillGroupId- Skill Group ID (required)body- Update skill groups (required)- Returns:
- SkillGroup
- Throws:
IOException- if the request fails to be processed
-
patchRoutingSkillgroup
public SkillGroup patchRoutingSkillgroup(PatchRoutingSkillgroupRequest request) throws IOException, ApiException Update skill group definition- Parameters:
request- The request object- Returns:
- SkillGroup
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingSkillgroup
public ApiResponse<SkillGroup> patchRoutingSkillgroup(ApiRequest<SkillGroup> request) throws IOException Update skill group definition- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRoutingSmsPhonenumber
public SmsPhoneNumber patchRoutingSmsPhonenumber(String phoneNumberId, SmsPhoneNumberPatchRequest body) throws IOException, ApiException Update a phone number provisioned for SMS. Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the \"SMS Default\" profile, which allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To customize media filtering, provide a supported content profile ID in the request body.- Parameters:
phoneNumberId- phone number (required)body- SmsPhoneNumberPatchRequest (required)- Returns:
- SmsPhoneNumber
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingSmsPhonenumberWithHttpInfo
public ApiResponse<SmsPhoneNumber> patchRoutingSmsPhonenumberWithHttpInfo(String phoneNumberId, SmsPhoneNumberPatchRequest body) throws IOException Update a phone number provisioned for SMS. Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the \"SMS Default\" profile, which allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To customize media filtering, provide a supported content profile ID in the request body.- Parameters:
phoneNumberId- phone number (required)body- SmsPhoneNumberPatchRequest (required)- Returns:
- SmsPhoneNumber
- Throws:
IOException- if the request fails to be processed
-
patchRoutingSmsPhonenumber
public SmsPhoneNumber patchRoutingSmsPhonenumber(PatchRoutingSmsPhonenumberRequest request) throws IOException, ApiException Update a phone number provisioned for SMS. Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the \"SMS Default\" profile, which allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To customize media filtering, provide a supported content profile ID in the request body.- Parameters:
request- The request object- Returns:
- SmsPhoneNumber
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRoutingSmsPhonenumber
public ApiResponse<SmsPhoneNumber> patchRoutingSmsPhonenumber(ApiRequest<SmsPhoneNumberPatchRequest> request) throws IOException Update a phone number provisioned for SMS. Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the \"SMS Default\" profile, which allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To customize media filtering, provide a supported content profile ID in the request body.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserQueue
public UserQueue patchUserQueue(String queueId, String userId, UserQueue body) throws IOException, ApiException Join or unjoin a queue for a user- Parameters:
queueId- Queue ID (required)userId- User ID (required)body- Queue Member (required)- Returns:
- UserQueue
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserQueueWithHttpInfo
public ApiResponse<UserQueue> patchUserQueueWithHttpInfo(String queueId, String userId, UserQueue body) throws IOException Join or unjoin a queue for a user- Parameters:
queueId- Queue ID (required)userId- User ID (required)body- Queue Member (required)- Returns:
- UserQueue
- Throws:
IOException- if the request fails to be processed
-
patchUserQueue
Join or unjoin a queue for a user- Parameters:
request- The request object- Returns:
- UserQueue
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserQueue
Join or unjoin a queue for a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserQueues
public UserQueueEntityListing patchUserQueues(String userId, List<UserQueue> body, List<String> divisionId) throws IOException, ApiException Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.- Parameters:
userId- User ID (required)body- User Queues (required)divisionId- Division ID(s) (optional)- Returns:
- UserQueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserQueuesWithHttpInfo
public ApiResponse<UserQueueEntityListing> patchUserQueuesWithHttpInfo(String userId, List<UserQueue> body, List<String> divisionId) throws IOException Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.- Parameters:
userId- User ID (required)body- User Queues (required)divisionId- Division ID(s) (optional)- Returns:
- UserQueueEntityListing
- Throws:
IOException- if the request fails to be processed
-
patchUserQueues
public UserQueueEntityListing patchUserQueues(PatchUserQueuesRequest request) throws IOException, ApiException Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.- Parameters:
request- The request object- Returns:
- UserQueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserQueues
public ApiResponse<UserQueueEntityListing> patchUserQueues(ApiRequest<List<UserQueue>> request) throws IOException Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserRoutinglanguage
public UserRoutingLanguage patchUserRoutinglanguage(String userId, String languageId, UserRoutingLanguage body) throws IOException, ApiException Update an assigned routing language's proficiency- Parameters:
userId- User ID (required)languageId- languageId (required)body- Language (required)- Returns:
- UserRoutingLanguage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserRoutinglanguageWithHttpInfo
public ApiResponse<UserRoutingLanguage> patchUserRoutinglanguageWithHttpInfo(String userId, String languageId, UserRoutingLanguage body) throws IOException Update an assigned routing language's proficiency- Parameters:
userId- User ID (required)languageId- languageId (required)body- Language (required)- Returns:
- UserRoutingLanguage
- Throws:
IOException- if the request fails to be processed
-
patchUserRoutinglanguage
public UserRoutingLanguage patchUserRoutinglanguage(PatchUserRoutinglanguageRequest request) throws IOException, ApiException Update an assigned routing language's proficiency- Parameters:
request- The request object- Returns:
- UserRoutingLanguage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserRoutinglanguage
public ApiResponse<UserRoutingLanguage> patchUserRoutinglanguage(ApiRequest<UserRoutingLanguage> request) throws IOException Update an assigned routing language's proficiency- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserRoutinglanguagesBulk
public UserLanguageEntityListing patchUserRoutinglanguagesBulk(String userId, List<UserRoutingLanguagePost> body) throws IOException, ApiException Assign multiple routing languages to a user. Max 50 routing languages in request body- Parameters:
userId- User ID (required)body- Language (required)- Returns:
- UserLanguageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserRoutinglanguagesBulkWithHttpInfo
public ApiResponse<UserLanguageEntityListing> patchUserRoutinglanguagesBulkWithHttpInfo(String userId, List<UserRoutingLanguagePost> body) throws IOException Assign multiple routing languages to a user. Max 50 routing languages in request body- Parameters:
userId- User ID (required)body- Language (required)- Returns:
- UserLanguageEntityListing
- Throws:
IOException- if the request fails to be processed
-
patchUserRoutinglanguagesBulk
public UserLanguageEntityListing patchUserRoutinglanguagesBulk(PatchUserRoutinglanguagesBulkRequest request) throws IOException, ApiException Assign multiple routing languages to a user. Max 50 routing languages in request body- Parameters:
request- The request object- Returns:
- UserLanguageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserRoutinglanguagesBulk
public ApiResponse<UserLanguageEntityListing> patchUserRoutinglanguagesBulk(ApiRequest<List<UserRoutingLanguagePost>> request) throws IOException Assign multiple routing languages to a user. Max 50 routing languages in request body- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserRoutingskillsBulk
public UserSkillEntityListing patchUserRoutingskillsBulk(String userId, List<UserRoutingSkillPost> body) throws IOException, ApiException Assign multiple routing skills to a user- Parameters:
userId- User ID (required)body- Skill (required)- Returns:
- UserSkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserRoutingskillsBulkWithHttpInfo
public ApiResponse<UserSkillEntityListing> patchUserRoutingskillsBulkWithHttpInfo(String userId, List<UserRoutingSkillPost> body) throws IOException Assign multiple routing skills to a user- Parameters:
userId- User ID (required)body- Skill (required)- Returns:
- UserSkillEntityListing
- Throws:
IOException- if the request fails to be processed
-
patchUserRoutingskillsBulk
public UserSkillEntityListing patchUserRoutingskillsBulk(PatchUserRoutingskillsBulkRequest request) throws IOException, ApiException Assign multiple routing skills to a user- Parameters:
request- The request object- Returns:
- UserSkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserRoutingskillsBulk
public ApiResponse<UserSkillEntityListing> patchUserRoutingskillsBulk(ApiRequest<List<UserRoutingSkillPost>> request) throws IOException Assign multiple routing skills to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsQueuesObservationsQuery
public QueueObservationQueryResponse postAnalyticsQueuesObservationsQuery(QueueObservationQuery body) throws IOException, ApiException Query for queue observations- Parameters:
body- query (required)- Returns:
- QueueObservationQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsQueuesObservationsQueryWithHttpInfo
public ApiResponse<QueueObservationQueryResponse> postAnalyticsQueuesObservationsQueryWithHttpInfo(QueueObservationQuery body) throws IOException Query for queue observations- Parameters:
body- query (required)- Returns:
- QueueObservationQueryResponse
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsQueuesObservationsQuery
public QueueObservationQueryResponse postAnalyticsQueuesObservationsQuery(PostAnalyticsQueuesObservationsQueryRequest request) throws IOException, ApiException Query for queue observations- Parameters:
request- The request object- Returns:
- QueueObservationQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsQueuesObservationsQuery
public ApiResponse<QueueObservationQueryResponse> postAnalyticsQueuesObservationsQuery(ApiRequest<QueueObservationQuery> request) throws IOException Query for queue observations- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsRoutingActivityQuery
public RoutingActivityResponse postAnalyticsRoutingActivityQuery(RoutingActivityQuery body, Integer pageSize, Integer pageNumber) throws IOException, ApiException Query for user activity observations- Parameters:
body- query (required)pageSize- The desired page size (optional)pageNumber- The desired page number (optional)- Returns:
- RoutingActivityResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsRoutingActivityQueryWithHttpInfo
public ApiResponse<RoutingActivityResponse> postAnalyticsRoutingActivityQueryWithHttpInfo(RoutingActivityQuery body, Integer pageSize, Integer pageNumber) throws IOException Query for user activity observations- Parameters:
body- query (required)pageSize- The desired page size (optional)pageNumber- The desired page number (optional)- Returns:
- RoutingActivityResponse
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsRoutingActivityQuery
public RoutingActivityResponse postAnalyticsRoutingActivityQuery(PostAnalyticsRoutingActivityQueryRequest request) throws IOException, ApiException Query for user activity observations- Parameters:
request- The request object- Returns:
- RoutingActivityResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsRoutingActivityQuery
public ApiResponse<RoutingActivityResponse> postAnalyticsRoutingActivityQuery(ApiRequest<RoutingActivityQuery> request) throws IOException Query for user activity observations- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingAssessments
public BenefitAssessment postRoutingAssessments(CreateBenefitAssessmentRequest body) throws IOException, ApiException Create a benefit assessment.- Parameters:
body- (optional)- Returns:
- BenefitAssessment
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingAssessmentsWithHttpInfo
public ApiResponse<BenefitAssessment> postRoutingAssessmentsWithHttpInfo(CreateBenefitAssessmentRequest body) throws IOException Create a benefit assessment.- Parameters:
body- (optional)- Returns:
- BenefitAssessment
- Throws:
IOException- if the request fails to be processed
-
postRoutingAssessments
public BenefitAssessment postRoutingAssessments(PostRoutingAssessmentsRequest request) throws IOException, ApiException Create a benefit assessment.- Parameters:
request- The request object- Returns:
- BenefitAssessment
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingAssessments
public ApiResponse<BenefitAssessment> postRoutingAssessments(ApiRequest<CreateBenefitAssessmentRequest> request) throws IOException Create a benefit assessment.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingAssessmentsJobs
public BenefitAssessmentJob postRoutingAssessmentsJobs(CreateBenefitAssessmentJobRequest body) throws IOException, ApiException Create a benefit assessment job.- Parameters:
body- (optional)- Returns:
- BenefitAssessmentJob
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingAssessmentsJobsWithHttpInfo
public ApiResponse<BenefitAssessmentJob> postRoutingAssessmentsJobsWithHttpInfo(CreateBenefitAssessmentJobRequest body) throws IOException Create a benefit assessment job.- Parameters:
body- (optional)- Returns:
- BenefitAssessmentJob
- Throws:
IOException- if the request fails to be processed
-
postRoutingAssessmentsJobs
public BenefitAssessmentJob postRoutingAssessmentsJobs(PostRoutingAssessmentsJobsRequest request) throws IOException, ApiException Create a benefit assessment job.- Parameters:
request- The request object- Returns:
- BenefitAssessmentJob
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingAssessmentsJobs
public ApiResponse<BenefitAssessmentJob> postRoutingAssessmentsJobs(ApiRequest<CreateBenefitAssessmentJobRequest> request) throws IOException Create a benefit assessment job.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailDomainDkim
public VerificationResult postRoutingEmailDomainDkim(String domainId) throws IOException, ApiException Restart domain dkim- Parameters:
domainId- domain ID (required)- Returns:
- VerificationResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailDomainDkimWithHttpInfo
public ApiResponse<VerificationResult> postRoutingEmailDomainDkimWithHttpInfo(String domainId) throws IOException Restart domain dkim- Parameters:
domainId- domain ID (required)- Returns:
- VerificationResult
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailDomainDkim
public VerificationResult postRoutingEmailDomainDkim(PostRoutingEmailDomainDkimRequest request) throws IOException, ApiException Restart domain dkim- Parameters:
request- The request object- Returns:
- VerificationResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailDomainDkim
public ApiResponse<VerificationResult> postRoutingEmailDomainDkim(ApiRequest<Void> request) throws IOException Restart domain dkim- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailDomainMailfrom
public MailFromResult postRoutingEmailDomainMailfrom(String domainId, MailFromResult body) throws IOException, ApiException Set domain mail from settings- Parameters:
domainId- domain ID (required)body- Mail From Settings (required)- Returns:
- MailFromResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailDomainMailfromWithHttpInfo
public ApiResponse<MailFromResult> postRoutingEmailDomainMailfromWithHttpInfo(String domainId, MailFromResult body) throws IOException Set domain mail from settings- Parameters:
domainId- domain ID (required)body- Mail From Settings (required)- Returns:
- MailFromResult
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailDomainMailfrom
public MailFromResult postRoutingEmailDomainMailfrom(PostRoutingEmailDomainMailfromRequest request) throws IOException, ApiException Set domain mail from settings- Parameters:
request- The request object- Returns:
- MailFromResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailDomainMailfrom
public ApiResponse<MailFromResult> postRoutingEmailDomainMailfrom(ApiRequest<MailFromResult> request) throws IOException Set domain mail from settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailDomainRoutes
public InboundRoute postRoutingEmailDomainRoutes(String domainName, InboundRoute body) throws IOException, ApiException Create a route- Parameters:
domainName- email domain (required)body- Route (required)- Returns:
- InboundRoute
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailDomainRoutesWithHttpInfo
public ApiResponse<InboundRoute> postRoutingEmailDomainRoutesWithHttpInfo(String domainName, InboundRoute body) throws IOException Create a route- Parameters:
domainName- email domain (required)body- Route (required)- Returns:
- InboundRoute
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailDomainRoutes
public InboundRoute postRoutingEmailDomainRoutes(PostRoutingEmailDomainRoutesRequest request) throws IOException, ApiException Create a route- Parameters:
request- The request object- Returns:
- InboundRoute
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailDomainRoutes
public ApiResponse<InboundRoute> postRoutingEmailDomainRoutes(ApiRequest<InboundRoute> request) throws IOException Create a route- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailDomainTestconnection
public TestMessage postRoutingEmailDomainTestconnection(String domainId, TestMessage body) throws IOException, ApiException Tests the custom SMTP server integration connection set on this ACD domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server.- Parameters:
domainId- domain ID (required)body- TestMessage (optional)- Returns:
- TestMessage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailDomainTestconnectionWithHttpInfo
public ApiResponse<TestMessage> postRoutingEmailDomainTestconnectionWithHttpInfo(String domainId, TestMessage body) throws IOException Tests the custom SMTP server integration connection set on this ACD domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server.- Parameters:
domainId- domain ID (required)body- TestMessage (optional)- Returns:
- TestMessage
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailDomainTestconnection
public TestMessage postRoutingEmailDomainTestconnection(PostRoutingEmailDomainTestconnectionRequest request) throws IOException, ApiException Tests the custom SMTP server integration connection set on this ACD domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server.- Parameters:
request- The request object- Returns:
- TestMessage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailDomainTestconnection
public ApiResponse<TestMessage> postRoutingEmailDomainTestconnection(ApiRequest<TestMessage> request) throws IOException Tests the custom SMTP server integration connection set on this ACD domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailDomainVerification
public VerificationResult postRoutingEmailDomainVerification(String domainId) throws IOException, ApiException Restart domain verification- Parameters:
domainId- domain ID (required)- Returns:
- VerificationResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailDomainVerificationWithHttpInfo
public ApiResponse<VerificationResult> postRoutingEmailDomainVerificationWithHttpInfo(String domainId) throws IOException Restart domain verification- Parameters:
domainId- domain ID (required)- Returns:
- VerificationResult
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailDomainVerification
public VerificationResult postRoutingEmailDomainVerification(PostRoutingEmailDomainVerificationRequest request) throws IOException, ApiException Restart domain verification- Parameters:
request- The request object- Returns:
- VerificationResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailDomainVerification
public ApiResponse<VerificationResult> postRoutingEmailDomainVerification(ApiRequest<Void> request) throws IOException Restart domain verification- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailDomains
public InboundDomain postRoutingEmailDomains(InboundDomainCreateRequest body) throws IOException, ApiException Create a domain- Parameters:
body- Domain (required)- Returns:
- InboundDomain
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailDomainsWithHttpInfo
public ApiResponse<InboundDomain> postRoutingEmailDomainsWithHttpInfo(InboundDomainCreateRequest body) throws IOException Create a domain- Parameters:
body- Domain (required)- Returns:
- InboundDomain
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailDomains
public InboundDomain postRoutingEmailDomains(PostRoutingEmailDomainsRequest request) throws IOException, ApiException Create a domain- Parameters:
request- The request object- Returns:
- InboundDomain
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailDomains
public ApiResponse<InboundDomain> postRoutingEmailDomains(ApiRequest<InboundDomainCreateRequest> request) throws IOException Create a domain- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailOutboundDomainTestconnection
public TestMessage postRoutingEmailOutboundDomainTestconnection(String domainId, TestMessage body) throws IOException, ApiException Tests the custom SMTP server integration connection set on this outbound domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server for the outbound domain. If the body is specified, there will be an attempt to send an email message to the server.- Parameters:
domainId- domain ID (required)body- TestMessage (optional)- Returns:
- TestMessage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailOutboundDomainTestconnectionWithHttpInfo
public ApiResponse<TestMessage> postRoutingEmailOutboundDomainTestconnectionWithHttpInfo(String domainId, TestMessage body) throws IOException Tests the custom SMTP server integration connection set on this outbound domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server for the outbound domain. If the body is specified, there will be an attempt to send an email message to the server.- Parameters:
domainId- domain ID (required)body- TestMessage (optional)- Returns:
- TestMessage
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailOutboundDomainTestconnection
public TestMessage postRoutingEmailOutboundDomainTestconnection(PostRoutingEmailOutboundDomainTestconnectionRequest request) throws IOException, ApiException Tests the custom SMTP server integration connection set on this outbound domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server for the outbound domain. If the body is specified, there will be an attempt to send an email message to the server.- Parameters:
request- The request object- Returns:
- TestMessage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailOutboundDomainTestconnection
public ApiResponse<TestMessage> postRoutingEmailOutboundDomainTestconnection(ApiRequest<TestMessage> request) throws IOException Tests the custom SMTP server integration connection set on this outbound domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server for the outbound domain. If the body is specified, there will be an attempt to send an email message to the server.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailOutboundDomains
public EmailOutboundDomainResult postRoutingEmailOutboundDomains(OutboundDomainCreateRequest body) throws IOException, ApiException Create a domain- Parameters:
body- Domain (required)- Returns:
- EmailOutboundDomainResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailOutboundDomainsWithHttpInfo
public ApiResponse<EmailOutboundDomainResult> postRoutingEmailOutboundDomainsWithHttpInfo(OutboundDomainCreateRequest body) throws IOException Create a domain- Parameters:
body- Domain (required)- Returns:
- EmailOutboundDomainResult
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailOutboundDomains
public EmailOutboundDomainResult postRoutingEmailOutboundDomains(PostRoutingEmailOutboundDomainsRequest request) throws IOException, ApiException Create a domain- Parameters:
request- The request object- Returns:
- EmailOutboundDomainResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailOutboundDomains
public ApiResponse<EmailOutboundDomainResult> postRoutingEmailOutboundDomains(ApiRequest<OutboundDomainCreateRequest> request) throws IOException Create a domain- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailOutboundDomainsSimulated
public EmailOutboundDomainResult postRoutingEmailOutboundDomainsSimulated(OutboundDomainCreateRequest body) throws IOException, ApiException Create a simulated domain- Parameters:
body- Domain (required)- Returns:
- EmailOutboundDomainResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailOutboundDomainsSimulatedWithHttpInfo
public ApiResponse<EmailOutboundDomainResult> postRoutingEmailOutboundDomainsSimulatedWithHttpInfo(OutboundDomainCreateRequest body) throws IOException Create a simulated domain- Parameters:
body- Domain (required)- Returns:
- EmailOutboundDomainResult
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailOutboundDomainsSimulated
public EmailOutboundDomainResult postRoutingEmailOutboundDomainsSimulated(PostRoutingEmailOutboundDomainsSimulatedRequest request) throws IOException, ApiException Create a simulated domain- Parameters:
request- The request object- Returns:
- EmailOutboundDomainResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailOutboundDomainsSimulated
public ApiResponse<EmailOutboundDomainResult> postRoutingEmailOutboundDomainsSimulated(ApiRequest<OutboundDomainCreateRequest> request) throws IOException Create a simulated domain- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailSetting
Create a new email setting. Used to define various settings, that can then be associated with email domains- Parameters:
body- EmailSetting (required)- Returns:
- EmailSetting
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailSettingWithHttpInfo
public ApiResponse<EmailSetting> postRoutingEmailSettingWithHttpInfo(EmailSetting body) throws IOException Create a new email setting. Used to define various settings, that can then be associated with email domains- Parameters:
body- EmailSetting (required)- Returns:
- EmailSetting
- Throws:
IOException- if the request fails to be processed
-
postRoutingEmailSetting
public EmailSetting postRoutingEmailSetting(PostRoutingEmailSettingRequest request) throws IOException, ApiException Create a new email setting. Used to define various settings, that can then be associated with email domains- Parameters:
request- The request object- Returns:
- EmailSetting
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingEmailSetting
public ApiResponse<EmailSetting> postRoutingEmailSetting(ApiRequest<EmailSetting> request) throws IOException Create a new email setting. Used to define various settings, that can then be associated with email domains- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingLanguages
Create Language- Parameters:
body- Language (required)- Returns:
- Language
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingLanguagesWithHttpInfo
Create Language- Parameters:
body- Language (required)- Returns:
- Language
- Throws:
IOException- if the request fails to be processed
-
postRoutingLanguages
public Language postRoutingLanguages(PostRoutingLanguagesRequest request) throws IOException, ApiException Create Language- Parameters:
request- The request object- Returns:
- Language
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingLanguages
Create Language- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingPredictors
public Predictor postRoutingPredictors(CreatePredictorRequest body) throws IOException, ApiException Create a predictor.- Parameters:
body- (optional)- Returns:
- Predictor
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingPredictorsWithHttpInfo
public ApiResponse<Predictor> postRoutingPredictorsWithHttpInfo(CreatePredictorRequest body) throws IOException Create a predictor.- Parameters:
body- (optional)- Returns:
- Predictor
- Throws:
IOException- if the request fails to be processed
-
postRoutingPredictors
public Predictor postRoutingPredictors(PostRoutingPredictorsRequest request) throws IOException, ApiException Create a predictor.- Parameters:
request- The request object- Returns:
- Predictor
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingPredictors
public ApiResponse<Predictor> postRoutingPredictors(ApiRequest<CreatePredictorRequest> request) throws IOException Create a predictor.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingPredictorsKeyperformanceindicators
public KeyPerformanceIndicator postRoutingPredictorsKeyperformanceindicators(CreateKpiRequest body) throws IOException, ApiException Create a custom Key Performance Indicator. postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
body- request (required)- Returns:
- KeyPerformanceIndicator
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingPredictorsKeyperformanceindicatorsWithHttpInfo
public ApiResponse<KeyPerformanceIndicator> postRoutingPredictorsKeyperformanceindicatorsWithHttpInfo(CreateKpiRequest body) throws IOException Create a custom Key Performance Indicator. postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
body- request (required)- Returns:
- KeyPerformanceIndicator
- Throws:
IOException- if the request fails to be processed
-
postRoutingPredictorsKeyperformanceindicators
public KeyPerformanceIndicator postRoutingPredictorsKeyperformanceindicators(PostRoutingPredictorsKeyperformanceindicatorsRequest request) throws IOException, ApiException Create a custom Key Performance Indicator. postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
request- The request object- Returns:
- KeyPerformanceIndicator
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingPredictorsKeyperformanceindicators
public ApiResponse<KeyPerformanceIndicator> postRoutingPredictorsKeyperformanceindicators(ApiRequest<CreateKpiRequest> request) throws IOException Create a custom Key Performance Indicator. postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingQueueMembers
public void postRoutingQueueMembers(String queueId, List<WritableEntity> body, Boolean delete) throws IOException, ApiException Bulk add or delete up to 100 queue members- Parameters:
queueId- Queue ID (required)body- Queue Members (required)delete- True to delete queue members (optional, default to false)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingQueueMembersWithHttpInfo
public ApiResponse<Void> postRoutingQueueMembersWithHttpInfo(String queueId, List<WritableEntity> body, Boolean delete) throws IOException Bulk add or delete up to 100 queue members- Parameters:
queueId- Queue ID (required)body- Queue Members (required)delete- True to delete queue members (optional, default to false)- Throws:
IOException- if the request fails to be processed
-
postRoutingQueueMembers
public void postRoutingQueueMembers(PostRoutingQueueMembersRequest request) throws IOException, ApiException Bulk add or delete up to 100 queue members- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingQueueMembers
public ApiResponse<Void> postRoutingQueueMembers(ApiRequest<List<WritableEntity>> request) throws IOException Bulk add or delete up to 100 queue members- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingQueueUsers
public void postRoutingQueueUsers(String queueId, List<WritableEntity> body, Boolean delete) throws IOException, ApiException Deprecated.DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.- Parameters:
queueId- Queue ID (required)body- Queue Members (required)delete- True to delete queue members (optional, default to false)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingQueueUsersWithHttpInfo
public ApiResponse<Void> postRoutingQueueUsersWithHttpInfo(String queueId, List<WritableEntity> body, Boolean delete) throws IOException Deprecated.DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.- Parameters:
queueId- Queue ID (required)body- Queue Members (required)delete- True to delete queue members (optional, default to false)- Throws:
IOException- if the request fails to be processed
-
postRoutingQueueUsers
public void postRoutingQueueUsers(PostRoutingQueueUsersRequest request) throws IOException, ApiException Deprecated.DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingQueueUsers
public ApiResponse<Void> postRoutingQueueUsers(ApiRequest<List<WritableEntity>> request) throws IOException Deprecated.DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingQueueWrapupcodes
public List<WrapupCode> postRoutingQueueWrapupcodes(String queueId, List<WrapUpCodeReference> body) throws IOException, ApiException Add up to 100 wrap-up codes to a queue- Parameters:
queueId- Queue ID (required)body- List of wrapup codes (required)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingQueueWrapupcodesWithHttpInfo
public ApiResponse<List<WrapupCode>> postRoutingQueueWrapupcodesWithHttpInfo(String queueId, List<WrapUpCodeReference> body) throws IOException Add up to 100 wrap-up codes to a queue- Parameters:
queueId- Queue ID (required)body- List of wrapup codes (required)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
postRoutingQueueWrapupcodes
public List<WrapupCode> postRoutingQueueWrapupcodes(PostRoutingQueueWrapupcodesRequest request) throws IOException, ApiException Add up to 100 wrap-up codes to a queue- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingQueueWrapupcodes
public ApiResponse<List<WrapupCode>> postRoutingQueueWrapupcodes(ApiRequest<List<WrapUpCodeReference>> request) throws IOException Add up to 100 wrap-up codes to a queue- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingQueues
Create a queue- Parameters:
body- Queue (required)- Returns:
- Queue
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingQueuesWithHttpInfo
Create a queue- Parameters:
body- Queue (required)- Returns:
- Queue
- Throws:
IOException- if the request fails to be processed
-
postRoutingQueues
Create a queue- Parameters:
request- The request object- Returns:
- Queue
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingQueues
public ApiResponse<Queue> postRoutingQueues(ApiRequest<CreateQueueRequest> request) throws IOException Create a queue- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingSkillexpressionsValidate
public SkillExpressionValidationResult postRoutingSkillexpressionsValidate(SkillExpressionData body) throws IOException, ApiException Validate and normalize a skill expression- Parameters:
body- Skill expression data to validate (required)- Returns:
- SkillExpressionValidationResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSkillexpressionsValidateWithHttpInfo
public ApiResponse<SkillExpressionValidationResult> postRoutingSkillexpressionsValidateWithHttpInfo(SkillExpressionData body) throws IOException Validate and normalize a skill expression- Parameters:
body- Skill expression data to validate (required)- Returns:
- SkillExpressionValidationResult
- Throws:
IOException- if the request fails to be processed
-
postRoutingSkillexpressionsValidate
public SkillExpressionValidationResult postRoutingSkillexpressionsValidate(PostRoutingSkillexpressionsValidateRequest request) throws IOException, ApiException Validate and normalize a skill expression- Parameters:
request- The request object- Returns:
- SkillExpressionValidationResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSkillexpressionsValidate
public ApiResponse<SkillExpressionValidationResult> postRoutingSkillexpressionsValidate(ApiRequest<SkillExpressionData> request) throws IOException Validate and normalize a skill expression- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingSkillgroupMembersDivisions
public void postRoutingSkillgroupMembersDivisions(String skillGroupId, SkillGroupMemberDivisions body) throws IOException, ApiException Add or remove member divisions for this skill group.- Parameters:
skillGroupId- Skill Group ID (required)body- (optional)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSkillgroupMembersDivisionsWithHttpInfo
public ApiResponse<Void> postRoutingSkillgroupMembersDivisionsWithHttpInfo(String skillGroupId, SkillGroupMemberDivisions body) throws IOException Add or remove member divisions for this skill group.- Parameters:
skillGroupId- Skill Group ID (required)body- (optional)- Throws:
IOException- if the request fails to be processed
-
postRoutingSkillgroupMembersDivisions
public void postRoutingSkillgroupMembersDivisions(PostRoutingSkillgroupMembersDivisionsRequest request) throws IOException, ApiException Add or remove member divisions for this skill group.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSkillgroupMembersDivisions
public ApiResponse<Void> postRoutingSkillgroupMembersDivisions(ApiRequest<SkillGroupMemberDivisions> request) throws IOException Add or remove member divisions for this skill group.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingSkillgroups
public SkillGroupWithMemberDivisions postRoutingSkillgroups(SkillGroupWithMemberDivisions body) throws IOException, ApiException Create a skill group- Parameters:
body- Create skill group (required)- Returns:
- SkillGroupWithMemberDivisions
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSkillgroupsWithHttpInfo
public ApiResponse<SkillGroupWithMemberDivisions> postRoutingSkillgroupsWithHttpInfo(SkillGroupWithMemberDivisions body) throws IOException Create a skill group- Parameters:
body- Create skill group (required)- Returns:
- SkillGroupWithMemberDivisions
- Throws:
IOException- if the request fails to be processed
-
postRoutingSkillgroups
public SkillGroupWithMemberDivisions postRoutingSkillgroups(PostRoutingSkillgroupsRequest request) throws IOException, ApiException Create a skill group- Parameters:
request- The request object- Returns:
- SkillGroupWithMemberDivisions
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSkillgroups
public ApiResponse<SkillGroupWithMemberDivisions> postRoutingSkillgroups(ApiRequest<SkillGroupWithMemberDivisions> request) throws IOException Create a skill group- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingSkills
Create Skill- Parameters:
body- Skill (required)- Returns:
- RoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSkillsWithHttpInfo
public ApiResponse<RoutingSkill> postRoutingSkillsWithHttpInfo(CreateRoutingSkill body) throws IOException Create Skill- Parameters:
body- Skill (required)- Returns:
- RoutingSkill
- Throws:
IOException- if the request fails to be processed
-
postRoutingSkills
public RoutingSkill postRoutingSkills(PostRoutingSkillsRequest request) throws IOException, ApiException Create Skill- Parameters:
request- The request object- Returns:
- RoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSkills
public ApiResponse<RoutingSkill> postRoutingSkills(ApiRequest<CreateRoutingSkill> request) throws IOException Create Skill- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingSmsAddresses
public SmsAddress postRoutingSmsAddresses(SmsAddressProvision body) throws IOException, ApiException Provision an Address for SMS- Parameters:
body- SmsAddress (required)- Returns:
- SmsAddress
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSmsAddressesWithHttpInfo
public ApiResponse<SmsAddress> postRoutingSmsAddressesWithHttpInfo(SmsAddressProvision body) throws IOException Provision an Address for SMS- Parameters:
body- SmsAddress (required)- Returns:
- SmsAddress
- Throws:
IOException- if the request fails to be processed
-
postRoutingSmsAddresses
public SmsAddress postRoutingSmsAddresses(PostRoutingSmsAddressesRequest request) throws IOException, ApiException Provision an Address for SMS- Parameters:
request- The request object- Returns:
- SmsAddress
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSmsAddresses
public ApiResponse<SmsAddress> postRoutingSmsAddresses(ApiRequest<SmsAddressProvision> request) throws IOException Provision an Address for SMS- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingSmsPhonenumbers
public SmsPhoneNumber postRoutingSmsPhonenumbers(SmsPhoneNumberProvision body) throws IOException, ApiException Provision a phone number for SMS When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To use custom media filtering, specify a supported content profile ID in the request body.- Parameters:
body- SmsPhoneNumber (required)- Returns:
- SmsPhoneNumber
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSmsPhonenumbersWithHttpInfo
public ApiResponse<SmsPhoneNumber> postRoutingSmsPhonenumbersWithHttpInfo(SmsPhoneNumberProvision body) throws IOException Provision a phone number for SMS When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To use custom media filtering, specify a supported content profile ID in the request body.- Parameters:
body- SmsPhoneNumber (required)- Returns:
- SmsPhoneNumber
- Throws:
IOException- if the request fails to be processed
-
postRoutingSmsPhonenumbers
public SmsPhoneNumber postRoutingSmsPhonenumbers(PostRoutingSmsPhonenumbersRequest request) throws IOException, ApiException Provision a phone number for SMS When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To use custom media filtering, specify a supported content profile ID in the request body.- Parameters:
request- The request object- Returns:
- SmsPhoneNumber
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSmsPhonenumbers
public ApiResponse<SmsPhoneNumber> postRoutingSmsPhonenumbers(ApiRequest<SmsPhoneNumberProvision> request) throws IOException Provision a phone number for SMS When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To use custom media filtering, specify a supported content profile ID in the request body.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingSmsPhonenumbersAlphanumeric
public SmsPhoneNumber postRoutingSmsPhonenumbersAlphanumeric(SmsAlphanumericProvision body) throws IOException, ApiException Provision an alphanumeric number for SMS postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
body- SmsPhoneNumber (required)- Returns:
- SmsPhoneNumber
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSmsPhonenumbersAlphanumericWithHttpInfo
public ApiResponse<SmsPhoneNumber> postRoutingSmsPhonenumbersAlphanumericWithHttpInfo(SmsAlphanumericProvision body) throws IOException Provision an alphanumeric number for SMS postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
body- SmsPhoneNumber (required)- Returns:
- SmsPhoneNumber
- Throws:
IOException- if the request fails to be processed
-
postRoutingSmsPhonenumbersAlphanumeric
public SmsPhoneNumber postRoutingSmsPhonenumbersAlphanumeric(PostRoutingSmsPhonenumbersAlphanumericRequest request) throws IOException, ApiException Provision an alphanumeric number for SMS postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
request- The request object- Returns:
- SmsPhoneNumber
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSmsPhonenumbersAlphanumeric
public ApiResponse<SmsPhoneNumber> postRoutingSmsPhonenumbersAlphanumeric(ApiRequest<SmsAlphanumericProvision> request) throws IOException Provision an alphanumeric number for SMS postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingSmsPhonenumbersImport
public SmsPhoneNumber postRoutingSmsPhonenumbersImport(SmsPhoneNumberImport body) throws IOException, ApiException Imports a phone number for SMS- Parameters:
body- SmsPhoneNumber (required)- Returns:
- SmsPhoneNumber
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSmsPhonenumbersImportWithHttpInfo
public ApiResponse<SmsPhoneNumber> postRoutingSmsPhonenumbersImportWithHttpInfo(SmsPhoneNumberImport body) throws IOException Imports a phone number for SMS- Parameters:
body- SmsPhoneNumber (required)- Returns:
- SmsPhoneNumber
- Throws:
IOException- if the request fails to be processed
-
postRoutingSmsPhonenumbersImport
public SmsPhoneNumber postRoutingSmsPhonenumbersImport(PostRoutingSmsPhonenumbersImportRequest request) throws IOException, ApiException Imports a phone number for SMS- Parameters:
request- The request object- Returns:
- SmsPhoneNumber
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingSmsPhonenumbersImport
public ApiResponse<SmsPhoneNumber> postRoutingSmsPhonenumbersImport(ApiRequest<SmsPhoneNumberImport> request) throws IOException Imports a phone number for SMS- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingUtilizationLabels
public UtilizationLabel postRoutingUtilizationLabels(CreateUtilizationLabelRequest body) throws IOException, ApiException Create a utilization label- Parameters:
body- UtilizationLabel (required)- Returns:
- UtilizationLabel
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingUtilizationLabelsWithHttpInfo
public ApiResponse<UtilizationLabel> postRoutingUtilizationLabelsWithHttpInfo(CreateUtilizationLabelRequest body) throws IOException Create a utilization label- Parameters:
body- UtilizationLabel (required)- Returns:
- UtilizationLabel
- Throws:
IOException- if the request fails to be processed
-
postRoutingUtilizationLabels
public UtilizationLabel postRoutingUtilizationLabels(PostRoutingUtilizationLabelsRequest request) throws IOException, ApiException Create a utilization label- Parameters:
request- The request object- Returns:
- UtilizationLabel
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingUtilizationLabels
public ApiResponse<UtilizationLabel> postRoutingUtilizationLabels(ApiRequest<CreateUtilizationLabelRequest> request) throws IOException Create a utilization label- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRoutingWrapupcodes
Create a wrap-up code- Parameters:
body- WrapupCode (required)- Returns:
- WrapupCode
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingWrapupcodesWithHttpInfo
public ApiResponse<WrapupCode> postRoutingWrapupcodesWithHttpInfo(WrapupCodeRequest body) throws IOException Create a wrap-up code- Parameters:
body- WrapupCode (required)- Returns:
- WrapupCode
- Throws:
IOException- if the request fails to be processed
-
postRoutingWrapupcodes
public WrapupCode postRoutingWrapupcodes(PostRoutingWrapupcodesRequest request) throws IOException, ApiException Create a wrap-up code- Parameters:
request- The request object- Returns:
- WrapupCode
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRoutingWrapupcodes
public ApiResponse<WrapupCode> postRoutingWrapupcodes(ApiRequest<WrapupCodeRequest> request) throws IOException Create a wrap-up code- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUserRoutinglanguages
public UserRoutingLanguage postUserRoutinglanguages(String userId, UserRoutingLanguagePost body) throws IOException, ApiException Assign a routing language to a user- Parameters:
userId- User ID (required)body- Language (required)- Returns:
- UserRoutingLanguage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserRoutinglanguagesWithHttpInfo
public ApiResponse<UserRoutingLanguage> postUserRoutinglanguagesWithHttpInfo(String userId, UserRoutingLanguagePost body) throws IOException Assign a routing language to a user- Parameters:
userId- User ID (required)body- Language (required)- Returns:
- UserRoutingLanguage
- Throws:
IOException- if the request fails to be processed
-
postUserRoutinglanguages
public UserRoutingLanguage postUserRoutinglanguages(PostUserRoutinglanguagesRequest request) throws IOException, ApiException Assign a routing language to a user- Parameters:
request- The request object- Returns:
- UserRoutingLanguage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserRoutinglanguages
public ApiResponse<UserRoutingLanguage> postUserRoutinglanguages(ApiRequest<UserRoutingLanguagePost> request) throws IOException Assign a routing language to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUserRoutingskills
public UserRoutingSkill postUserRoutingskills(String userId, UserRoutingSkillPost body) throws IOException, ApiException Assign a routing skill to a user- Parameters:
userId- User ID (required)body- Skill (required)- Returns:
- UserRoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserRoutingskillsWithHttpInfo
public ApiResponse<UserRoutingSkill> postUserRoutingskillsWithHttpInfo(String userId, UserRoutingSkillPost body) throws IOException Assign a routing skill to a user- Parameters:
userId- User ID (required)body- Skill (required)- Returns:
- UserRoutingSkill
- Throws:
IOException- if the request fails to be processed
-
postUserRoutingskills
public UserRoutingSkill postUserRoutingskills(PostUserRoutingskillsRequest request) throws IOException, ApiException Assign a routing skill to a user- Parameters:
request- The request object- Returns:
- UserRoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserRoutingskills
public ApiResponse<UserRoutingSkill> postUserRoutingskills(ApiRequest<UserRoutingSkillPost> request) throws IOException Assign a routing skill to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingDirectroutingbackupSettingsMe
public AgentDirectRoutingBackupSettings putRoutingDirectroutingbackupSettingsMe(AgentDirectRoutingBackupSettings body) throws IOException, ApiException Update the user's Direct Routing Backup settings.- Parameters:
body- directRoutingBackup (required)- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingDirectroutingbackupSettingsMeWithHttpInfo
public ApiResponse<AgentDirectRoutingBackupSettings> putRoutingDirectroutingbackupSettingsMeWithHttpInfo(AgentDirectRoutingBackupSettings body) throws IOException Update the user's Direct Routing Backup settings.- Parameters:
body- directRoutingBackup (required)- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
IOException- if the request fails to be processed
-
putRoutingDirectroutingbackupSettingsMe
public AgentDirectRoutingBackupSettings putRoutingDirectroutingbackupSettingsMe(PutRoutingDirectroutingbackupSettingsMeRequest request) throws IOException, ApiException Update the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingDirectroutingbackupSettingsMe
public ApiResponse<AgentDirectRoutingBackupSettings> putRoutingDirectroutingbackupSettingsMe(ApiRequest<AgentDirectRoutingBackupSettings> request) throws IOException Update the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingEmailDomainRoute
public InboundRoute putRoutingEmailDomainRoute(String domainName, String routeId, InboundRoute body) throws IOException, ApiException Update a route- Parameters:
domainName- email domain (required)routeId- route ID (required)body- Route (required)- Returns:
- InboundRoute
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingEmailDomainRouteWithHttpInfo
public ApiResponse<InboundRoute> putRoutingEmailDomainRouteWithHttpInfo(String domainName, String routeId, InboundRoute body) throws IOException Update a route- Parameters:
domainName- email domain (required)routeId- route ID (required)body- Route (required)- Returns:
- InboundRoute
- Throws:
IOException- if the request fails to be processed
-
putRoutingEmailDomainRoute
public InboundRoute putRoutingEmailDomainRoute(PutRoutingEmailDomainRouteRequest request) throws IOException, ApiException Update a route- Parameters:
request- The request object- Returns:
- InboundRoute
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingEmailDomainRoute
public ApiResponse<InboundRoute> putRoutingEmailDomainRoute(ApiRequest<InboundRoute> request) throws IOException Update a route- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingEmailDomainRouteIdentityresolution
public RouteIdentityResolutionConfig putRoutingEmailDomainRouteIdentityresolution(String domainName, String routeId, RouteIdentityResolutionConfig body) throws IOException, ApiException Update identity resolution settings for a route.- Parameters:
domainName- email domain (required)routeId- route ID (required)body- (required)- Returns:
- RouteIdentityResolutionConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingEmailDomainRouteIdentityresolutionWithHttpInfo
public ApiResponse<RouteIdentityResolutionConfig> putRoutingEmailDomainRouteIdentityresolutionWithHttpInfo(String domainName, String routeId, RouteIdentityResolutionConfig body) throws IOException Update identity resolution settings for a route.- Parameters:
domainName- email domain (required)routeId- route ID (required)body- (required)- Returns:
- RouteIdentityResolutionConfig
- Throws:
IOException- if the request fails to be processed
-
putRoutingEmailDomainRouteIdentityresolution
public RouteIdentityResolutionConfig putRoutingEmailDomainRouteIdentityresolution(PutRoutingEmailDomainRouteIdentityresolutionRequest request) throws IOException, ApiException Update identity resolution settings for a route.- Parameters:
request- The request object- Returns:
- RouteIdentityResolutionConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingEmailDomainRouteIdentityresolution
public ApiResponse<RouteIdentityResolutionConfig> putRoutingEmailDomainRouteIdentityresolution(ApiRequest<RouteIdentityResolutionConfig> request) throws IOException Update identity resolution settings for a route.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingEmailOutboundDomainActivation
public EmailOutboundDomainResult putRoutingEmailOutboundDomainActivation(String domainId) throws IOException, ApiException Request an activation status (cname + dkim) update of an outbound domain- Parameters:
domainId- domain ID (required)- Returns:
- EmailOutboundDomainResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingEmailOutboundDomainActivationWithHttpInfo
public ApiResponse<EmailOutboundDomainResult> putRoutingEmailOutboundDomainActivationWithHttpInfo(String domainId) throws IOException Request an activation status (cname + dkim) update of an outbound domain- Parameters:
domainId- domain ID (required)- Returns:
- EmailOutboundDomainResult
- Throws:
IOException- if the request fails to be processed
-
putRoutingEmailOutboundDomainActivation
public EmailOutboundDomainResult putRoutingEmailOutboundDomainActivation(PutRoutingEmailOutboundDomainActivationRequest request) throws IOException, ApiException Request an activation status (cname + dkim) update of an outbound domain- Parameters:
request- The request object- Returns:
- EmailOutboundDomainResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingEmailOutboundDomainActivation
public ApiResponse<EmailOutboundDomainResult> putRoutingEmailOutboundDomainActivation(ApiRequest<Void> request) throws IOException Request an activation status (cname + dkim) update of an outbound domain- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingMessageRecipient
public Recipient putRoutingMessageRecipient(String recipientId, RecipientRequest body) throws IOException, ApiException Update a recipient- Parameters:
recipientId- Recipient ID (required)body- Recipient (required)- Returns:
- Recipient
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingMessageRecipientWithHttpInfo
public ApiResponse<Recipient> putRoutingMessageRecipientWithHttpInfo(String recipientId, RecipientRequest body) throws IOException Update a recipient- Parameters:
recipientId- Recipient ID (required)body- Recipient (required)- Returns:
- Recipient
- Throws:
IOException- if the request fails to be processed
-
putRoutingMessageRecipient
public Recipient putRoutingMessageRecipient(PutRoutingMessageRecipientRequest request) throws IOException, ApiException Update a recipient- Parameters:
request- The request object- Returns:
- Recipient
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingMessageRecipient
public ApiResponse<Recipient> putRoutingMessageRecipient(ApiRequest<RecipientRequest> request) throws IOException Update a recipient- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingQueue
Update a queue- Parameters:
queueId- Queue ID (required)body- Queue (required)- Returns:
- Queue
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingQueueWithHttpInfo
public ApiResponse<Queue> putRoutingQueueWithHttpInfo(String queueId, QueueRequest body) throws IOException Update a queue- Parameters:
queueId- Queue ID (required)body- Queue (required)- Returns:
- Queue
- Throws:
IOException- if the request fails to be processed
-
putRoutingQueue
Update a queue- Parameters:
request- The request object- Returns:
- Queue
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingQueue
Update a queue- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingQueueIdentityresolution
public IdentityResolutionQueueConfig putRoutingQueueIdentityresolution(String queueId, IdentityResolutionQueueConfig body) throws IOException, ApiException Update Queue IdentityResolution Settings.- Parameters:
queueId- Queue ID (required)body- (required)- Returns:
- IdentityResolutionQueueConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingQueueIdentityresolutionWithHttpInfo
public ApiResponse<IdentityResolutionQueueConfig> putRoutingQueueIdentityresolutionWithHttpInfo(String queueId, IdentityResolutionQueueConfig body) throws IOException Update Queue IdentityResolution Settings.- Parameters:
queueId- Queue ID (required)body- (required)- Returns:
- IdentityResolutionQueueConfig
- Throws:
IOException- if the request fails to be processed
-
putRoutingQueueIdentityresolution
public IdentityResolutionQueueConfig putRoutingQueueIdentityresolution(PutRoutingQueueIdentityresolutionRequest request) throws IOException, ApiException Update Queue IdentityResolution Settings.- Parameters:
request- The request object- Returns:
- IdentityResolutionQueueConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingQueueIdentityresolution
public ApiResponse<IdentityResolutionQueueConfig> putRoutingQueueIdentityresolution(ApiRequest<IdentityResolutionQueueConfig> request) throws IOException Update Queue IdentityResolution Settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingSettings
Update an organization's routing settings- Parameters:
body- Organization Settings (required)- Returns:
- RoutingSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingSettingsWithHttpInfo
public ApiResponse<RoutingSettings> putRoutingSettingsWithHttpInfo(RoutingSettings body) throws IOException Update an organization's routing settings- Parameters:
body- Organization Settings (required)- Returns:
- RoutingSettings
- Throws:
IOException- if the request fails to be processed
-
putRoutingSettings
public RoutingSettings putRoutingSettings(PutRoutingSettingsRequest request) throws IOException, ApiException Update an organization's routing settings- Parameters:
request- The request object- Returns:
- RoutingSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingSettings
public ApiResponse<RoutingSettings> putRoutingSettings(ApiRequest<RoutingSettings> request) throws IOException Update an organization's routing settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingSettingsTranscription
public TranscriptionSettings putRoutingSettingsTranscription(TranscriptionSettings body) throws IOException, ApiException Update Transcription Settings- Parameters:
body- Organization Settings (required)- Returns:
- TranscriptionSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingSettingsTranscriptionWithHttpInfo
public ApiResponse<TranscriptionSettings> putRoutingSettingsTranscriptionWithHttpInfo(TranscriptionSettings body) throws IOException Update Transcription Settings- Parameters:
body- Organization Settings (required)- Returns:
- TranscriptionSettings
- Throws:
IOException- if the request fails to be processed
-
putRoutingSettingsTranscription
public TranscriptionSettings putRoutingSettingsTranscription(PutRoutingSettingsTranscriptionRequest request) throws IOException, ApiException Update Transcription Settings- Parameters:
request- The request object- Returns:
- TranscriptionSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingSettingsTranscription
public ApiResponse<TranscriptionSettings> putRoutingSettingsTranscription(ApiRequest<TranscriptionSettings> request) throws IOException Update Transcription Settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingSmsIdentityresolutionPhonenumber
public SmsIdentityResolutionConfig putRoutingSmsIdentityresolutionPhonenumber(String addressId, SmsIdentityResolutionConfig body) throws IOException, ApiException Update an SMS identity resolution settings.- Parameters:
addressId- Address ID (required)body- (required)- Returns:
- SmsIdentityResolutionConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingSmsIdentityresolutionPhonenumberWithHttpInfo
public ApiResponse<SmsIdentityResolutionConfig> putRoutingSmsIdentityresolutionPhonenumberWithHttpInfo(String addressId, SmsIdentityResolutionConfig body) throws IOException Update an SMS identity resolution settings.- Parameters:
addressId- Address ID (required)body- (required)- Returns:
- SmsIdentityResolutionConfig
- Throws:
IOException- if the request fails to be processed
-
putRoutingSmsIdentityresolutionPhonenumber
public SmsIdentityResolutionConfig putRoutingSmsIdentityresolutionPhonenumber(PutRoutingSmsIdentityresolutionPhonenumberRequest request) throws IOException, ApiException Update an SMS identity resolution settings.- Parameters:
request- The request object- Returns:
- SmsIdentityResolutionConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingSmsIdentityresolutionPhonenumber
public ApiResponse<SmsIdentityResolutionConfig> putRoutingSmsIdentityresolutionPhonenumber(ApiRequest<SmsIdentityResolutionConfig> request) throws IOException Update an SMS identity resolution settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingUserDirectroutingbackupSettings
public AgentDirectRoutingBackupSettings putRoutingUserDirectroutingbackupSettings(String userId, AgentDirectRoutingBackupSettings body) throws IOException, ApiException Update the user's Direct Routing Backup settings.- Parameters:
userId- User ID (required)body- directRoutingBackup (required)- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingUserDirectroutingbackupSettingsWithHttpInfo
public ApiResponse<AgentDirectRoutingBackupSettings> putRoutingUserDirectroutingbackupSettingsWithHttpInfo(String userId, AgentDirectRoutingBackupSettings body) throws IOException Update the user's Direct Routing Backup settings.- Parameters:
userId- User ID (required)body- directRoutingBackup (required)- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
IOException- if the request fails to be processed
-
putRoutingUserDirectroutingbackupSettings
public AgentDirectRoutingBackupSettings putRoutingUserDirectroutingbackupSettings(PutRoutingUserDirectroutingbackupSettingsRequest request) throws IOException, ApiException Update the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingUserDirectroutingbackupSettings
public ApiResponse<AgentDirectRoutingBackupSettings> putRoutingUserDirectroutingbackupSettings(ApiRequest<AgentDirectRoutingBackupSettings> request) throws IOException Update the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingUserUtilization
public AgentMaxUtilizationResponse putRoutingUserUtilization(String userId, UtilizationRequest body) throws IOException, ApiException Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.- Parameters:
userId- User ID (required)body- utilization (required)- Returns:
- AgentMaxUtilizationResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingUserUtilizationWithHttpInfo
public ApiResponse<AgentMaxUtilizationResponse> putRoutingUserUtilizationWithHttpInfo(String userId, UtilizationRequest body) throws IOException Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.- Parameters:
userId- User ID (required)body- utilization (required)- Returns:
- AgentMaxUtilizationResponse
- Throws:
IOException- if the request fails to be processed
-
putRoutingUserUtilization
public AgentMaxUtilizationResponse putRoutingUserUtilization(PutRoutingUserUtilizationRequest request) throws IOException, ApiException Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.- Parameters:
request- The request object- Returns:
- AgentMaxUtilizationResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingUserUtilization
public ApiResponse<AgentMaxUtilizationResponse> putRoutingUserUtilization(ApiRequest<UtilizationRequest> request) throws IOException Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingUtilization
public UtilizationResponse putRoutingUtilization(UtilizationRequest body) throws IOException, ApiException Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the system default values.- Parameters:
body- utilization (required)- Returns:
- UtilizationResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingUtilizationWithHttpInfo
public ApiResponse<UtilizationResponse> putRoutingUtilizationWithHttpInfo(UtilizationRequest body) throws IOException Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the system default values.- Parameters:
body- utilization (required)- Returns:
- UtilizationResponse
- Throws:
IOException- if the request fails to be processed
-
putRoutingUtilization
public UtilizationResponse putRoutingUtilization(PutRoutingUtilizationRequest request) throws IOException, ApiException Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the system default values.- Parameters:
request- The request object- Returns:
- UtilizationResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingUtilization
public ApiResponse<UtilizationResponse> putRoutingUtilization(ApiRequest<UtilizationRequest> request) throws IOException Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the system default values.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingUtilizationLabel
public UtilizationLabel putRoutingUtilizationLabel(String labelId, UpdateUtilizationLabelRequest body) throws IOException, ApiException Update a utilization label- Parameters:
labelId- Utilization Label ID (required)body- UtilizationLabel (required)- Returns:
- UtilizationLabel
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingUtilizationLabelWithHttpInfo
public ApiResponse<UtilizationLabel> putRoutingUtilizationLabelWithHttpInfo(String labelId, UpdateUtilizationLabelRequest body) throws IOException Update a utilization label- Parameters:
labelId- Utilization Label ID (required)body- UtilizationLabel (required)- Returns:
- UtilizationLabel
- Throws:
IOException- if the request fails to be processed
-
putRoutingUtilizationLabel
public UtilizationLabel putRoutingUtilizationLabel(PutRoutingUtilizationLabelRequest request) throws IOException, ApiException Update a utilization label- Parameters:
request- The request object- Returns:
- UtilizationLabel
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingUtilizationLabel
public ApiResponse<UtilizationLabel> putRoutingUtilizationLabel(ApiRequest<UpdateUtilizationLabelRequest> request) throws IOException Update a utilization label- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingWrapupcode
public WrapupCode putRoutingWrapupcode(String codeId, WrapupCodeRequest body) throws IOException, ApiException Update wrap-up code- Parameters:
codeId- Wrapup Code ID (required)body- WrapupCode (required)- Returns:
- WrapupCode
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingWrapupcodeWithHttpInfo
public ApiResponse<WrapupCode> putRoutingWrapupcodeWithHttpInfo(String codeId, WrapupCodeRequest body) throws IOException Update wrap-up code- Parameters:
codeId- Wrapup Code ID (required)body- WrapupCode (required)- Returns:
- WrapupCode
- Throws:
IOException- if the request fails to be processed
-
putRoutingWrapupcode
public WrapupCode putRoutingWrapupcode(PutRoutingWrapupcodeRequest request) throws IOException, ApiException Update wrap-up code- Parameters:
request- The request object- Returns:
- WrapupCode
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingWrapupcode
public ApiResponse<WrapupCode> putRoutingWrapupcode(ApiRequest<WrapupCodeRequest> request) throws IOException Update wrap-up code- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserRoutingskill
public UserRoutingSkill putUserRoutingskill(String userId, String skillId, UserRoutingSkill body) throws IOException, ApiException Update an assigned routing skill's proficiency- Parameters:
userId- User ID (required)skillId- skillId (required)body- Skill (required)- Returns:
- UserRoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserRoutingskillWithHttpInfo
public ApiResponse<UserRoutingSkill> putUserRoutingskillWithHttpInfo(String userId, String skillId, UserRoutingSkill body) throws IOException Update an assigned routing skill's proficiency- Parameters:
userId- User ID (required)skillId- skillId (required)body- Skill (required)- Returns:
- UserRoutingSkill
- Throws:
IOException- if the request fails to be processed
-
putUserRoutingskill
public UserRoutingSkill putUserRoutingskill(PutUserRoutingskillRequest request) throws IOException, ApiException Update an assigned routing skill's proficiency- Parameters:
request- The request object- Returns:
- UserRoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserRoutingskill
public ApiResponse<UserRoutingSkill> putUserRoutingskill(ApiRequest<UserRoutingSkill> request) throws IOException Update an assigned routing skill's proficiency- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserRoutingskillsBulk
public UserSkillEntityListing putUserRoutingskillsBulk(String userId, List<UserRoutingSkillPost> body) throws IOException, ApiException Assign multiple routing skills to a user, replacing any current assignments- Parameters:
userId- User ID (required)body- Skill (required)- Returns:
- UserSkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserRoutingskillsBulkWithHttpInfo
public ApiResponse<UserSkillEntityListing> putUserRoutingskillsBulkWithHttpInfo(String userId, List<UserRoutingSkillPost> body) throws IOException Assign multiple routing skills to a user, replacing any current assignments- Parameters:
userId- User ID (required)body- Skill (required)- Returns:
- UserSkillEntityListing
- Throws:
IOException- if the request fails to be processed
-
putUserRoutingskillsBulk
public UserSkillEntityListing putUserRoutingskillsBulk(PutUserRoutingskillsBulkRequest request) throws IOException, ApiException Assign multiple routing skills to a user, replacing any current assignments- Parameters:
request- The request object- Returns:
- UserSkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserRoutingskillsBulk
public ApiResponse<UserSkillEntityListing> putUserRoutingskillsBulk(ApiRequest<List<UserRoutingSkillPost>> request) throws IOException Assign multiple routing skills to a user, replacing any current assignments- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-