TCN API
  1. WFM
TCN API
  • API Edition 1
    • Acd
      • AgentGetStatusStream
      • AgentGetStatus
      • AgentGetConnectedParty
      • ManagerAgentGetConnectedParty
      • AgentIntercom
      • AgentIntercomAccept
      • AgentIntercomReject
      • AgentIntercomCancel
      • DialManualPrepare
      • DialManualCancel
      • DialPreviewPrepare
      • AgentPause
      • AgentSetReady
      • AgentGUIBusy
      • ReportAgentSessionEvent
      • CallerRequeue
      • AgentDisconnect
      • TransferWarmToOutboundCancel
      • TransferWarmToAgentCancel
      • TransferWarmToOutboundApprove
      • TransferWarmToAgentApprove
      • CallerSendToVoicemail
      • AgentInviteTransferCallerToConference
      • AgentMonitorCalls
      • TransferColdToOutbound
      • TransferColdToAgent
      • TransferWarmToOutboundStart
      • CreateWarmOutboundTransferMember
      • RemoveTransferMember
      • TransferWarmToAgentStart
      • AgentGetCallFromHold
      • AgentGetSpecificCallFromHold
      • ACDGetAllAgentsStatuses
      • AgentPutCallOnHold
      • AgentReceiveMessage
      • AgentPBXApproveCall
      • AgentPBXRejectCall
      • GetCallerLostPeer
      • CallerGetRawEvent
      • PeerAgentWithCaller
      • HoldTransferMember
      • UnholdTransferMember
      • GetAgentCallCounts
      • WarmCallerTransferStart
      • WarmCallerTransferCancel
      • WarmCallerTransferApprove
      • PlaySoundboardEntity
      • StopSoundboardEntity
      • UpdateAgentSkills
      • PlayDTMF
      • AgentMute
      • AgentUnmute
      • StartSecureForm
      • CollectSecureFormField
      • ResetSecureFormField
      • AcceptSecureFormField
      • ProcessSecureForm
      • FinishSecureFormHandling
      • PopulateWorkflowFields
      • ValidateField
      • ListAgentsVoiceStatuses
    • AgentSmith
      • FollowAgent
    • AgentTrainingService
      • CreateLearningOpportunity
      • ListLearningOpportunities
      • ListAgentLearningOpportunities
      • CompleteAgentLearningOpportunity
      • ListDashboards
      • ListManagerDashboards
      • UpdateLearningOpportunity
      • DeleteLearningOpportunity
      • GetLearningOpportunity
    • AgentTrainingSupportService
      • ListLearningOpportunitiesByOrgId
      • DeleteLearningOpportunityByOrgId
    • Ana
      • GetSpecifiedVisualizations
      • RegisterAccount
      • SetWeeks
      • SetDefaultTimeFilter
      • SetDefaultDashboard
      • GetAccount
      • GetSpecifiedAccount
      • GetAuthorizedAnalyticsLink
      • GenerateMonthlyBilling
      • GetTimeZone
      • SetTimeZone
      • CopyDashViz
      • GetSpecifiedBillingSummary
      • GetBillingSummary
      • EnableCustomReports
      • DisableCustomReports
      • MakeAdoptable
      • MakeUnadoptable
      • AdoptAnaAccount
      • DisownAnaAccount
      • GetAccessibleClients
      • GetFamily
      • GetAllowedDataVisibility
      • GetCurrentDataVisibility
      • GetIndicesVisibility
      • GetAuditableDataVisibility
      • GetOrganizationNames
      • GenerateVizDataById
      • GetClientStatus
      • ReloadClientData
      • ListVisualizationsLegacy
    • Asm
      • StreamAgentState
      • ManagerStreamAgentState
      • PushEvents
      • CreateSession
      • EndSession
      • GetCurrentSession
      • EnableVoice
      • DisableVoice
      • ListConversations
      • AssignNewConversation
      • ListAgents
      • SetConversationCollectedData
      • GetQueuesDetails
    • AsmApi
      • CreateSession
      • GetStatus
      • EndSession
      • GetCurrentSession
      • SwitchSubsession
      • ListConversations
      • AssignNewConversation
      • ListAgents
      • SetConversationCollectedData
      • GetQueuesDetails
    • AsmService
      • CreateSession
      • EndSession
      • GetCurrentSession
      • EnableVoice
      • DisableVoice
      • ListAsmUserDetails
      • PushEvents
    • AuthConnectionService
      • CreateAuthConnection
      • ListAuthConnectionIds
      • GetAuthConnectionSettings
      • GetAuthConnection
      • DeleteAuthConnection
      • UpdateAuthConnectionSecret
      • UpdateAuthConnectionGroups
    • Billing
      • GetBillingPlan
      • UpdateBillingPlan
      • GetInvoice
      • ExportGeneratedInvoice
    • BillingService
      • CommitBillingPlan
      • CommitDefaultBillingPlan
      • CreateBillingPlan
      • CreateDefaultBillingPlan
      • CreateDefaultRateDefinition
      • CreateInvoice
      • CreateRateDefinition
      • DeleteBillingPlan
      • DeleteDefaultBillingPlan
      • DeleteDefaultRateDefinition
      • DeleteInvoice
      • DeleteRateDefinition
      • DuplicateBillingPlan
      • DuplicateDefaultBillingPlan
      • ExportInvoice
      • GetActiveBillingPlan
      • GetBillingPlan
      • GetBillingPlanHistory
      • GetInvoice
      • GetRateDefinition
      • ListBillingPlans
      • ListInvoices
      • ListRateDefinitions
      • UpdateBillingPlan
      • UpdateDefaultBillingPlan
      • UpdateDefaultRateDefinition
      • UpdateInvoice
      • UpdateRateDefinition
      • CreateDefaultRateDefinition
      • CreateDefaultRateDefinitions
      • CreateRateDefinition
      • CreateRateDefinitions
      • DeleteDefaultRateDefinition
      • DeleteDefaultRateDefinitions
      • DeleteRateDefinition
      • DeleteRateDefinitions
      • ExportInvoice
      • GetRateDefinition
      • GetRateHistory
      • ListActiveRateDefinitions
      • ListRateDefinitions
      • UpdateDefaultRateDefinition
      • UpdateRateDefinition
      • ListProducts
      • ApplyBillingPlanDraft
      • CreateBillingPlan
      • DeleteBillingPlan
      • GetBillingPlan
      • ListBillingPlans
      • UpdateBillingPlan
      • ApplyDefaultBillingPlanDraft
      • CreateDefaultBillingPlan
      • DeleteDefaultBillingPlan
      • GetDefaultBillingPlan
      • ListDefaultBillingPlans
      • UpdateDefaultBillingPlan
      • CreateRateDefinition
      • DeleteRateDefinition
      • GetRateDefinition
      • ListRateDefinitions
      • UpdateRateDefinition
      • CreateDefaultRateDefinition
      • DeleteDefaultRateDefinition
      • GetDefaultRateDefinition
      • ListDefaultRateDefinitions
      • UpdateDefaultRateDefinition
      • ExportInvoice
      • ApplyBillingPlanDraft
      • CloneBillingPlan
      • CreateBillingPlan
      • DeleteBillingPlan
      • GetBillingPlan
      • ListBillingPlans
      • UpdateBillingPlan
      • ApplyDefaultBillingPlanDraft
      • CloneDefaultBillingPlan
      • CreateDefaultBillingPlan
      • DeleteDefaultBillingPlan
      • GetDefaultBillingPlan
      • ListDefaultBillingPlans
      • UpdateDefaultBillingPlan
      • CreateRateDefinition
      • DeleteRateDefinition
      • GetRateDefinition
      • ListRateDefinitions
      • UpdateRateDefinition
      • CreateDefaultRateDefinition
      • DeleteDefaultRateDefinition
      • GetDefaultRateDefinition
      • ListDefaultRateDefinitions
      • UpdateDefaultRateDefinition
      • CreateMatchingRule
      • DeleteMatchingRule
      • GetMatchingRule
      • ListMatchingRules
      • UpdateMatchingRule
      • CreateBillingTag
      • DeleteBillingTag
      • GetBillingTag
      • ListBillingTags
      • UpdateBillingTag
      • ExportInvoice
    • BIReportGeneratorService
      • CreateReportJob
      • ListReportJobs
      • UpdateReportJob
      • DeleteReportJob
      • GetReportJob
      • GenerateReport
      • ListReportLogsStream
    • BusinessHoursService
      • ListBusinessHours
      • GetBusinessHours
      • SetBusinessHours
      • AddIntervalToBusinessHours
      • RemoveIntervalFromBusinessHours
      • UpdateBusinessHoursInfo
      • DeleteBusinessHours
      • EvaluateBusinessHours
    • CallMonitorService
      • GetHoldQueueStats
    • CallQueue
      • DequeuePreviewRecordOrCall
      • EnqueuePreviewRecord
      • DequeueScrubbedCallForPreviewRecord
      • ClearPreviewRecordReturnQueue
      • EnqueuePreviewDialCall
      • ClearManualDialQueue
      • ProcessManualDialCall
      • DequeueCallForManualApproval
      • EnqueueManuallyApprovedCall
      • EnqueueManuallyRejectedCall
      • RequeueManuallyApprovedCall
      • EnqueueManuallyApprovedSms
      • EnqueueManuallyRejectedSms
      • RequeueManuallyApprovedSms
      • DequeueSmsMamForManualApproval
      • DequeuePreviewRecordOrCall
      • EnqueuePreviewRecord
      • DequeueScrubbedCallForPreviewRecord
      • ClearPreviewRecordReturnQueue
      • EnqueuePreviewDialCall
      • ClearManualDialQueue
      • ProcessManualDialCall
      • DequeueCallForManualApproval
      • EnqueueManuallyApprovedCall
      • EnqueueManuallyRejectedCall
      • RequeueManuallyApprovedCall
      • EnqueueManuallyApprovedSms
      • EnqueueManuallyRejectedSms
      • RequeueManuallyApprovedSms
      • DequeueSmsMamForManualApproval
    • CBS
      • CreateServiceId
      • CreateCallbackWithDetails
      • UpdateScheduledCallbackToReady
      • UpdateScheduledCallbackToCanceled
      • GetNextScheduledCallbackWithDetails
      • UpdateScheduledCallbackToClosed
      • UpdateScheduledCallback
      • GetScheduledCallbackWithDetails
      • ListScheduledCallbacksWithDetails
      • ListScheduledCallbacksWithDetailsBySkills
    • Cfg
      • GetWebAgentConfig
      • GetWebAgentConfig
    • ClassifierFileTemplates
      • ParseFile
      • ListEvents
      • PeekList
      • UpdateFileTemplate
      • DeleteFileTemplate
      • ListFileTemplates
      • GetFileTemplate
    • Compliance
      • RuleAutoComplete
      • CheckRuleSet
      • AssignRuleSet
      • ListRuleSets
      • GetRuleSet
      • GetRuleSetByName
      • CreateRuleSet
      • RenameRuleSet
      • EnableRuleSet
      • DisableRuleSet
      • CreateScrubList
      • UpdateScrubList
      • AddScrubListEntries
      • UpdateScrubEntry
      • DeleteScrubListEntries
      • DeleteAllListEntries
      • GetScrubList
      • DeleteScrubList
      • GetDefaultRules
      • GetScrubLists
      • SearchScrubList
      • GetScrubListUploadUrl
      • ProcessScrubListUpload
      • ScrubListDownload
      • ProcessScrubListDeleteUpload
      • ScrubListDelete
      • ExportScrubList
      • PurgeScrubList
      • CreateScenario
      • UpdateScenario
      • DeleteScenario
      • RunAssignedScenarios
      • ListAllScenarios
      • ListUnassignedScenarios
      • ListAssignedRuleSets
      • ListAssignedScenarios
      • AssignScenario
      • UnassignScenario
      • EnableScenario
      • DisableScenario
      • GetFieldNames
      • GetResultDescriptions
      • CreateConsentProfile
      • CreateConsent
      • GetConsentProfile
      • GetConsent
      • GetConsentByProfileAndContent
      • GetConsentByContent
      • SearchConsentByContent
      • UpdateConsent
      • ExpireConsent
      • RevokeConsent
      • DeleteConsent
      • ProcessConsentListDeleteUpload
      • ConsentListDownload
      • EnableConsentProfile
      • DisableConsentProfile
      • ListConsentProfiles
      • GetConsentUploadUrl
      • ProcessConsentUpload
      • ExportConsentList
      • ListConsentTopics
      • GetConsentTopic
      • CreateConsentTopic
      • DeleteConsentTopic
      • UpdateConsentTopic
      • ProcessOutboundCall
      • QueryHolidays
      • GetScenario
    • ContactManager
      • GetContactList
      • ListContactEntryList
      • GetEncContactEntry
      • GetKYCEncContactEntry
      • GetKYCKeys
      • AddContactEntry
      • EditContactEntry
      • ListContactsByEntity
      • GetContactFieldType
      • ListContactActivityLog
    • Dashboards
      • CreateDashboard
      • GetDashboard
      • GetDefaultDashboard
      • ListDashboards
      • ListProductTypes
      • DeleteDashboard
      • SetDefaultDashboard
      • UpdateDashboard
      • UpdateDashboardTitleAndDescription
      • UpdateDashboardView
      • UpdateDashboardLayout
      • PublishDashboard
      • CreateApplicationDashboard
      • ListApplicationsDashboards
      • DeleteApplicationDashboard
    • DeliveryApi
      • CreateTransferConfig
      • ListTransferConfigs
      • ListTransferConfigsByCredentialID
      • UpdateTransferConfig
      • DeleteTransferConfig
      • GetTransferConfig
      • GetTransferConfigByName
      • ListHistory
      • ListHistoryByTransferConfig
      • ListCredentials
      • GetCredential
      • CreateCredential
      • DeleteCredential
      • UpdateCredential
      • CreateDeliveryDefinition
      • DeleteDeliveryDefinition
      • GetDeliveryDefinition
      • GetDeliveryDefinitionByName
      • ListDeliveryDefinitions
      • ListDeliveryDefinitionsByCredentialID
      • UpdateDeliveryDefinition
      • CreateEncryption
      • DeleteEncryption
      • GetEncryption
      • ListEncryptions
      • UpdateEncryption
      • ListSMSNumbers
      • TriggerDemoOutboundDelivery
    • ExileCertificateManagerService
      • CreateExileCertificate
      • RevokeExileCertificate
      • AssignExileConfiguration
      • UnassignExileConfiguration
      • ListExileCertificates
      • CreateExileConfiguration
      • UpdateExileConfiguration
      • DeleteExileConfiguration
      • ListExileConfigurations
    • ExplorerService
      • ListDatasourceSchemas
      • Query
      • GetSupportQuery
      • GetQueryExplain
      • GetWeeksOfData
    • FTS
      • GetUploadFileUrl
    • FtsApi
      • GetUploadFileUrl
    • GenericFinviService
      • PopAccount
    • GhostNotifierApi
      • ListNotifications
    • HuntGroupsService
      • ListHuntGroupExileLinks
      • CopyHuntGroupExileLink
      • UpdateHuntGroupExileLinks
      • ListHuntGroupAgentTriggers
      • CopyHuntGroupAgentTrigger
      • UpdateHuntGroupAgentTriggers
      • CopyHuntGroupToOrganization
      • AdminCopyHuntGroupToOrganization
      • AdminListHuntGroups
      • ListAgentScripts
      • CreateAgentClientInfoDisplayTemplate
      • UpdateAgentClientInfoDisplayTemplate
      • GetAgentClientInfoDisplayTemplate
      • ListAgentClientInfoDisplayTemplates
      • DeleteAgentClientInfoDisplayTemplate
      • AssignAgentClientInfoDisplayTemplateToHuntGroups
      • UnassignAgentClientInfoDisplayTemplateFromHuntGroups
    • IdpService
      • CreateClient
      • UpdateClient
      • DeleteClient
      • ListClients
    • Insights
      • CreateInsight
      • ListInsights
      • ListInsightsStream
      • ListOrgInsights
      • UpdateInsight
      • DeleteInsight
      • GetInsight
      • CreateCommonsInsight
      • UpdateCommonsInsight
      • DeleteCommonsInsight
      • GetVfsSchema
      • ListVfses
      • ListVfsSchemas
      • PublishInsight
      • CreateOutputConfiguration
      • ListOutputConfigurations
      • UpdateOutputConfiguration
      • DeleteOutputConfiguration
      • GetOutputConfiguration
      • SetDefaultOutputConfiguration
      • GetDefaultOutputConfiguration
    • InstantDataService
      • StreamAgentEvents
      • StreamCallerEvents
    • Integrations
      • Process
      • GetIntegrationTransaction
      • GetIntegrationTransactionReport
      • GetIntegrationTransactionReportData
      • SearchPastTransactions
      • GetAggregatedMetadata
      • GetPortalLinksByDateRange
      • CreateIntegrationConfig
      • GetIntegrationConfig
      • UpdateIntegrationConfig
      • DeleteIntegrationConfig
      • ListIntegrations
      • ListIntegrationsForOrg
      • ListIntegrationConfigNames
      • ListJourneyConfigs
      • ListNonJourneyConfigs
      • CreatePortalConfig
      • ListPortalConfigs
      • UpdatePortalConfig
      • GetPortalConfig
      • DeletePortalConfig
      • UpdatePortalLogo
      • GetPortalLogo
      • CreatePaymentPortalLinks
      • Summary
      • ListIntegrationTemplatesByConfig
      • CallEpicPatient
      • HangUpEpicPatientCall
      • GenerateEpicKeyPairs
      • PopulateIntegrationLink
      • ProcessWorkflow
      • InsertPrivateField
      • CalculateFees
      • GetIntegrationSettings
      • UpsertIntegrationSettings
      • DeliverReceipt
    • IntegrationsPublic
      • GetLinkData
      • SubmitVerification
      • SessionKeepAlive
      • GetInvoice
      • SubmitPayment
      • GetReceipt
      • ProcessWorkflow
      • GetLinkDetails
      • CalculateFees
      • DeliverReceipt
    • LabelsService
      • CreateLabel
      • GetLabel
      • UpdateLabel
      • ListLabels
      • DeleteLabel
      • AttachLabel
      • DetachLabel
      • GetLabeledEntityMap
      • AssignLabels
      • RevokeLabels
    • Learn
      • Exist
      • Content
      • ExportMany
      • SearchContent
      • ListSearchResults
      • Standalone
      • ContentEditorData
      • Update
      • StoreStaticImage
      • UploadDynamicScreenshot
      • DeleteStandalone
      • Snippet
      • DeleteLearnPages
      • CreateEditVersion
      • PublishVersion
      • ContentByVersion
      • UpdateByVersion
      • ListSearchResultsByVersion
      • ReviewFileVersions
      • ReviewVersion
      • ExportManyStream
      • ListVersions
      • ReviewVersionStream
      • DeleteVersion
      • UploadStaticImage
      • GetUpdateUrl
      • AdvancedSearch
    • Projects
      • CreateProject
      • ListProjects
      • GetProject
      • DeleteProject
      • UpdateProject
    • LMS
      • GetPublicKey
      • CreateFileTemplate
      • ListFileTemplates
      • UpdateFileTemplate
      • DeleteFileTemplate
      • GetFileTemplate
      • CreateField
      • ListFields
      • GetField
      • UpdateField
      • DeleteField
      • ListAvailableFieldsByElementId
      • ListFieldsForElement
      • ListAutocompleteFields
      • ListCampaignLinks
      • PeekList
      • GetHistory
      • CreateElement
      • ListElements
      • GetElement
      • UpdateElement
      • DeleteElement
      • CopyPipelineUpstream
      • CopyPipelineDownstream
      • ProcessElement
      • GetAvailableFields
      • ListNewEvents
      • ViewQueue
      • Autocomplete
      • GetComplianceScrubLists
      • FindFieldUsages
      • FindInvalidElements
      • CreateCollection
      • GetCollection
      • UpdateCollection
      • RetypeCollection
      • DeleteCollection
      • ListCollections
      • ResetCollection
      • AddCollectionEntry
      • DeleteCollectionEntry
      • UpdateCollectionEntry
      • StreamCollection
      • SearchCollectionsPaginated
      • GetCollectionEntries
      • CreateCjsSearchDefinition
      • GetCjsSearchDefinition
      • UpdateCjsSearchDefinition
      • DeleteCjsSearchDefinition
      • ListCjsSearchDefinitions
      • ExecuteCjsSearchDefinition
      • GetCjsSecureSearchCriteria
      • CreateCjsSecureSearchCriteria
      • UpdateCjsSecureSearchCriteria
      • SampleEndpoint
      • GetAvailableEHRFields
      • GetQueuedEventsStatusByElementId
      • ListPools
      • CreatePipelineCanvas
      • ListPipelineCanvases
      • UpdatePipelineCanvas
      • DeletePipelineCanvas
      • GetPipelineCanvas
      • GetPipelineCanvasEvents
      • DeleteFileTemplate
      • GetFileTemplate
      • ListFileTemplates
      • ParseFileTemplate
      • UpdateFileTemplate
      • ProcessList
      • StreamList
    • NewsroomAPI
      • CreateNewsArticle
      • ListNewsArticles
      • GetNewsArticleById
      • UpdateNewsArticle
      • CreatePublishedArticle
      • ListPublishedArticles
      • GetPublishedArticleById
      • UserActivity
      • GetNewsForUser
      • StoreNewsArticleImage
      • ListImagesForNewsArticle
      • UploadNewsArticleImage
      • CreateClientArticle
      • UpdateClientArticle
      • ListClientArticles
      • CreatePublishedClientArticle
      • GetPublishedClientArticleById
      • StoreClientArticleImage
      • ListImagesForClientArticle
      • UploadClientArticleImage
      • ListPublishedClientArticles
      • GetClientArticleById
    • Notifier
      • GetNotify
    • OauthService
      • GetConnectedInboxOAuthURL
    • ObservedHolidaysService
      • ListObservedHolidays
      • GetObservedHolidays
      • SetObservedHolidays
      • AddToObservedHolidays
      • RemoveObservedHolidays
      • UpdateObservedHolidaysInfo
      • DeleteObservedHolidays
      • EvaluateObservedHolidays
    • OmniApi
      • ArchiveCampaign
      • CreateCampaign
      • GetCampaignById
      • PauseCampaign
      • ResumeCampaign
      • UpdateCampaign
      • UpdateCampaignPacingSpeed
      • SendOmniMessage
      • ManagerSendOmniMessage
      • CreateDisposition
      • DeleteDisposition
      • ListDispositions
      • UpdateDisposition
      • ListCustomUnsubscribeLinks
      • CreateCustomUnsubscribeLink
      • UpdateCustomUnsubscribeLink
      • DeleteCustomUnsubscribeLink
      • ListCampaigns
      • ManagerListMessages
      • ListMessages
      • ManagerListConversations
      • ListContactLists
      • GetAvailableHeaders
      • GetOmniExchangeElements
      • GetFieldsForElement
      • ApproveTask
      • GetNextQueuedTask
      • GetTask
      • ListTasks
      • RejectTask
      • RequeueTask
      • CreateConnectedInbox
      • DeleteConnectedInboxBySid
      • GetConnectedInboxBySid
      • PerformSendgridAccountChecks
      • ListConnectedInboxes
      • TestConnectedInbox
      • UpdateConnectedInbox
      • CreateVerifiedEmail
      • DeleteVerifiedEmail
      • GetVerifiedEmailBySid
      • ListVerifiedEmails
      • ResendVerifiedEmail
      • UpdateVerifiedEmail
      • GetPendingGoogleXOAuth2Data
      • SendEmailNotification
      • SendFeedbackEmail
      • GetOmniAttachment
      • CreateTasks
      • CreateSignature
      • DeleteSignature
      • ListSignatures
      • UpdateSignature
      • SuggestResponse
      • CreateProject
      • ListProjects
      • EditProjectById
      • CloseProjectById
      • GetProjectById
      • CreateCannedMessage
      • ListCannedMessages
      • UpdateCannedMessage
      • GetCannedMessageById
      • DeleteCannedMessageById
      • CreateCannedMessageGroup
      • ListCannedMessageGroups
      • UpdateCannedMessageGroup
      • DeleteCannedMessageGroup
      • ListCannedMessagesByGroupId
      • GetCannedMessageGroupById
      • ListUserSkills
      • ListWhatsAppNumbers
      • CreateWhatsAppNumber
      • UpdateWhatsAppNumber
      • CreateManualTask
    • Org
      • RegisterOrganization
      • ConvertOrgToManual
      • UpdateOrganization
      • ArchiveOrganization
      • UnArchiveOrganization
      • ListArchivedOrganizations
      • GetOrganizationProfile
      • GetOrganizationProfileById
      • ListOrganizationDescriptions
      • ListRegionalOrganizations
      • UpdateP3OwningOrg
      • GetP3OwningOrg
      • ListOrganizationUserDescriptions
      • AdminListUserDescriptions
      • ListUserDescriptions
      • GetUserDirectory
      • GetRegions
      • GetMyUserDetails
      • GetUserDetails
      • AdminGetUserDetails
      • GetAgentUsers
      • GetAgentSettings
      • GetAgentProfileGroup
      • UpdateAgentProfileGroup
      • CreateAgentProfileGroup
      • ListAgentProfileGroups
      • DeleteAgentProfileGroup
      • AssignAgentProfileGroups
      • UpdateUser
      • UpdateMyUser
      • UpdateUserCallerId
      • CreateUser
      • CreateUserByOrgId
      • CreateDelegatedUser
      • UpdateUserPassword
      • UpdateMyUserPassword
      • UpdateUserPasswordByOrgId
      • ResetUserRequirePasswordReset
      • GetUserPasswordResetLink
      • GetMyUserPasswordResetLink
      • GetUserPasswordResetLinkByOrgId
      • GetUserEmailVerified
      • GetUserEmailVerifiedByOrgId
      • SendUserVerificationEmailByOrgId
      • SendUserVerificationEmail
      • ManualUserEmailVerificationByOrgId
      • ManualUserEmailVerification
      • GetTempUserToken
      • GetTempUserTokenByUserId
      • GetCountriesList
      • GetAdminClientPreferences
      • UpdateAdminClientPreferences
      • GetPermissions
      • RevokeAccountOwnerPermissionFromUser
      • UpdateUserDisabled
      • UpdateUserDisabledByOrgId
      • UpdateBulkUsersDisabled
      • GetOrgBillingSettingsByOrgId
      • GetOrgBillingSettings
      • SetOrgBillingSettings
      • AddOrgBillingOverride
      • RemoveOrgBillingOverride
      • GetSystemDefaultBillingRates
      • ListPermissionGroupsByOrgId
      • ListPermissionGroups
      • CreatePermissionGroup
      • UpdatePermissionGroup
      • DeletePermissionGroup
      • AssignUserToAccountOwnerPermissionGroup
      • AssignUserPermissionGroup
      • AssignUsersPermissionGroup
      • UpdateUserNeoPermissionGroups
      • RevokeUserPermissionGroup
      • RevokeUsersPermissionGroup
      • InitDefaultPermissionGroups
      • AddPermissionToAccountOwnerPermissionGroup
      • RevokePermissionToAccountOwnerPermissionGroup
      • AddPermissionToOrgDefaultGroup
      • RemovePermissionFromOrgDefaultGroup
      • GetOrgDefaultSuperUserGroup
      • ListP3PermissionGroupsByOrgId
      • ListP3PermissionGroups
      • AddUserRegion
      • RemoveUserRegion
      • CreateP3PermissionGroup
      • UpdateP3PermissionGroupByOrgId
      • UpdateP3PermissionGroup
      • DeleteP3PermissionGroup
      • AssignUsersP3PermissionGroup
      • AddLoginToUser
      • RevokeUsersP3PermissionGroup
      • GetContactPreferences
      • UpdateContactPreferences
      • GetCompliancePreferences
      • UpdateCompliancePreferences
      • GetAgentPreferences
      • UpdateAgentPreferences
      • GetOrganizationPreferences
      • UpdateOrganizationPreferences
      • GetSchedulePreferences
      • UpdateSchedulePreferences
      • GetBusinessPreferences
      • UpdateBusinessPreferences
      • GetEndOfDayPreferences
      • UpdateEndOfDayPreferences
      • GetReportFilterPreferences
      • UpdateReportFilterPreferences
      • GetPhonePreferences
      • UpdatePhonePreferences
      • GetDashboardGeneralPreferences
      • UpdateDashboardGeneralPreferences
      • GetWebhookPreferences
      • UpdateWebhookPreferences
      • GetBroadcastPreferences
      • UpdateBroadcastPreferences
      • GetAuthenticationPreferences
      • UpdateAuthenticationPreferences
      • GetRecordingPreferences
      • UpdateRecordingPreferences
      • GetDashboardQueuePreferences
      • UpdateDashboardQueuePreferences
      • GetAgentQuickViewPreferences
      • GetVoiceAnalyticsPreferences
      • UpdateVoiceAnalyticsPreferences
      • UpdateVoiceAnalyticsPreferencesEnabled
      • GetScorecardsPreferences
      • UpdateScorecardsPreferences
      • GetEmailSmsPreferences
      • UpdateEmailSmsPreferences
      • EditAgentQuickViewPreferences
      • EditBackofficeThemePreference
      • GetBackofficeThemePreference
      • AcceptLinkbackRecordingTerms
      • LinkbackUpdateBroadcastTemplates
      • RecordEmailUnsubscribeAcknowledgement
      • ClearEmailUnsubscribeAcknowledgement
      • CreateWebLinkTemplate
      • ListWebLinkTemplates
      • GetWebLinkTemplate
      • UpdateWebLinkTemplate
      • DeleteWebLinkTemplate
      • CreateAgentTriggerTemplate
      • ListAgentTriggerTemplates
      • GetAgentTriggerTemplate
      • UpdateAgentTriggerTemplate
      • DeleteAgentTriggerTemplate
      • CreateClientInfoDisplayTemplate
      • ListClientInfoDisplayTemplates
      • UpdateClientInfoDisplayTemplate
      • DeleteClientInfoDisplayTemplate
      • GetClientInfoDisplayTemplate
      • ListAgentPauseCodes
      • CreateAgentPauseCode
      • UpdateAgentPauseCode
      • DeleteAgentPauseCode
      • ListCustomReportFilters
      • CreateCustomReportFilter
      • UpdateCustomReportFilter
      • DeleteCustomReportFilter
      • ListAgentResponseGroups
      • ListLastTemplateElements
      • ListQueueConfigsByOrgId
      • DeleteQueueConfig
      • GetQueueConfig
      • CreateQueueConfig
      • UpdateQueueConfig
      • CopyQueueConfig
      • GetAllQueueConfigSounds
      • GetQueueConfigSound
      • SetQueueConfigSound
      • SetAllQueueConfigSoundsFromSource
      • GetUserBlocked
      • UnblockUser
      • ListP3UnMigratedUsers
      • MigrateP3User
      • UpdateP3UserName
      • ListOwnedUsers
      • ListOwnedOrgsByOrgId
      • ListOwnedOrgs
      • RemoveLoginStrikes
      • RemoveUserLoginStrikes
      • ListLoginHistory
      • UpdateP3UserSids
      • CreateAuthConnection
      • GetAuthConnectionSettings
      • UpdateAuthConnectionSettings
      • DeleteAuthConnection
      • GetUserSubscription
      • GetMyUserSubscription
      • AddUserSubscription
      • AddMyUserSubscription
      • RemoveUserSubscription
      • RemoveMyUserSubscription
      • UpdateUserSubscription
      • UpdateMyUserSubscription
      • ListUserSubscriptions
      • ListMyUserSubscriptions
      • ListOrgSubscriptions
      • GetSystemEnvironmentDetails
      • ListAgentStatisticsTemplates
      • CreateAgentStatisticsTemplate
      • UpdateAgentStatisticsTemplate
      • DeleteAgentStatisticsTemplate
      • CreateOrganization
      • GetOrganization
      • GetOrganizationById
      • UpdateOrganization
      • ArchiveOrganization
      • UnArchiveOrganization
      • ListAllOrganizationsGlobally
      • ListOrganizationsByRegion
      • ListArchivedOrganizations
      • ConvertOrgToManual
      • ListOwnedOrgs
      • GetOrganizationPreferences
      • UpdateOrganizationPreferences
      • GetAgentPreferences
      • UpdateAgentPreferences
      • GetContactPreferences
      • UpdateContactPreferences
      • GetAuthenticationPreferences
      • UpdateAuthenticationPreferences
      • GetWebhookPreferences
      • UpdateWebhookPreferences
      • GetDashboardGeneralPreferences
      • UpdateDashboardGeneralPreferences
      • GetDashboardQueuePreferences
      • UpdateDashboardQueuePreferences
      • GetPhonePreferences
      • UpdatePhonePreferences
      • GetCompliancePreferences
      • UpdateCompliancePreferences
      • GetBroadcastPreferences
      • UpdateBroadcastPreferences
      • GetSchedulePreferences
      • UpdateSchedulePreferences
      • GetEmailSmsPreferences
      • UpdateEmailSmsPreferences
      • GetBusinessPreferences
      • UpdateBusinessPreferences
      • UpdateAdminBusinessPreferences
      • GetScorecardsPreferences
      • UpdateScorecardsPreferences
      • GetVoiceAnalyticsPreferences
      • ListVoiceAnalyticsPreferences
      • UpdateVoiceAnalyticsPreferences
      • GetEndOfDayPreferences
      • UpdateEndOfDayPreferences
      • GetReportFilterPreferences
      • UpdateReportFilterPreferences
      • GetRecordingPreferences
      • UpdateRecordingPreferences
      • GetAdminClientPreferences
      • UpdateAdminClientPreferences
      • AcceptLinkbackRecordingTerms
      • LinkbackUpdateBroadcastTemplates
      • RecordEmailUnsubscribeAcknowledgement
      • ClearEmailUnsubscribeAcknowledgement
      • ListBusinessHours
      • GetBusinessHours
      • SetBusinessHours
      • AddIntervalToBusinessHours
      • RemoveIntervalFromBusinessHours
      • UpdateBusinessHoursInfo
      • DeleteBusinessHours
      • EvaluateBusinessHours
      • CreateUser
      • CreateDelegatedUser
      • GetMyUser
      • GetUser
      • GetUserByOrgId
      • ListAgents
      • ListPublicUsers
      • ListUsers
      • ListUsersByOrgId
      • ListUsersByRegion
      • UpdateMyUser
      • UpdateUser
      • UpdateUserLabels
      • UpdateUserCallerId
      • UpdateUserDisabled
      • UpdateUserDisabledByOrgId
      • GetMyUserPasswordResetLink
      • GetUserPasswordResetLink
      • GetUserPasswordResetLinkByOrgId
      • CreatePasswordResetLink
      • CreatePasswordResetLinkByOrgId
      • GetUserLoginInfo
      • GetUserEmailVerified
      • GetUserEmailVerifiedByOrgId
      • ResetMyPassword
      • ResetUserPassword
      • ResetUserPasswordByOrgId
      • SendUserEmailVerification
      • SendUserEmailVerificationByOrgId
      • SendPasswordReset
      • SendPasswordResetByOrgId
      • GetUserSessionData
      • GetAgentProfileGroup
      • ListAgentProfileGroups
      • UpdateAgentProfileGroup
      • CreateAgentProfileGroup
      • DeleteAgentProfileGroup
      • AssignAgentProfileGroups
      • AddUserSubscription
      • AddUserSubscriptionByUserId
      • GetUserSubscription
      • GetUserSubscriptionByUserId
      • UpdateUserSubscription
      • UpdateUserSubscriptionByUserId
      • RemoveUserSubscription
      • RemoveUserSubscriptionByUserId
      • ListUserSubscriptions
      • ListUserSubscriptionsByUserId
      • ListOrgSubscriptions
      • CreateAuthToken
      • CreateAuthTokenByUserId
      • ListAuthTokens
      • ListAuthTokensByUserId
      • SetAuthTokenExpiration
      • SetAuthTokenExpirationByUserId
      • DeleteAuthToken
      • DeleteAuthTokenByUserId
      • GetHuntGroupSettings
      • UpdateHuntGroupSettings
      • CreateHuntGroup
      • UpdateHuntGroupGeneralDetails
      • DeleteHuntGroup
      • GetHuntGroupDetails
      • ListCallerIdBuckets
      • GetDataDipTemplate
      • ListDataDipTemplates
      • CreateDataDipTemplate
      • UpdateDataDipTemplate
      • DeleteDataDipTemplate
      • CopyDataDipTemplate
      • CopyDataDipTemplateToOrganization
      • ListBroadcastTemplateGeneralDetails
      • ListAgentResponseAutoRules
      • CreateAgentResponseAutoRules
      • UpdateAgentResponseAutoRules
      • DeleteAgentResponseAutoRules
      • ListHuntGroupWebLinks
      • CopyHuntGroupWebLink
      • UpdateHuntGroupWebLinks
      • ListHuntGroupIntegrationLinks
      • CopyHuntGroupIntegrationLink
      • UpdateHuntGroupIntegrationLinks
      • GetHuntGroupClientInfoDisplayTemplate
      • CreateHuntGroupClientInfoDisplayTemplate
      • UpdateHuntGroupClientInfoDisplayTemplate
      • DeleteHuntGroupClientInfoDisplayTemplate
      • CopyHuntGroupClientInfoDisplayTemplate
      • CreateCampaignClientInfoDisplayTemplate
      • ListHuntGroupsWithClientInfoTemplateData
      • ListAgentTriggers
      • CopyAgentTrigger
      • UpdateAgentTriggers
      • ListHuntGroupScripts
      • ListOrgHuntGroupScripts
      • GetHuntGroupScript
      • CreateHuntGroupScript
      • UpdateHuntGroupScript
      • DeleteHuntGroupScript
      • AssignScriptToHuntGroups
      • UnassignScriptFromHuntGroups
      • CreateTrust
      • AcceptTrust
      • RejectTrust
      • GetTrust
      • ListIncomingTrusts
      • ListGivenTrusts
      • ListAssignableTrusts
      • DeleteTrust
      • AssignTrust
      • UnassignTrust
      • CreateLabel
      • DeleteLabel
      • ListLabels
      • GetLabel
      • UpdateLabel
      • AssignLabel
      • UnassignLabel
      • GetAssignmentCounts
      • GetAssignableLabels
      • GetPermissions
      • GetUserPermissions
      • CreatePermissionGroup
      • UpdatePermissionGroup
      • DeletePermissionGroup
      • ListPermissionGroups
      • ListPermissionGroupsByOrgId
      • AssignUsersPermissionGroup
      • RevokeUsersPermissionGroup
      • AssignLabels
      • RevokeLabels
      • AssignAccountOwnerPermissionToUser
      • RevokeAccountOwnerPermissionFromUser
      • InitDefaultPermissionGroups
      • GetAccountOwnerGroup
      • GetLicenses
      • GetOrgLicenses
      • UpdateLicenses
      • RemovePermissionFromAllPermissionGroups
      • ListP3PermissionGroups
      • ListP3PermissionGroupsByOrgId
      • CreateP3PermissionGroup
      • UpdateP3PermissionGroup
      • UpdateP3PermissionGroupByOrgId
      • DeleteP3PermissionGroup
      • AssignUsersP3PermissionGroup
      • RevokeUsersP3PermissionGroup
      • RefreshMfaLockout
      • RefreshMfaLockoutByOrgId
      • SetMfaType
      • SetMyMfaType
      • EnableUserMfa
      • EnableMyUserMfa
      • GetUserMfaInfo
      • GetMyUserMfaInfo
      • GetMyAllowedMfaMethods
      • GenerateTOTPSecret
      • VerifyTOTPCode
      • CreateBusinessHours
      • UpdateBusinessHours
      • CreateCertificateInfo
      • DeleteCertificateInfo
      • RevokeCertificateInfo
      • ListCertificateInfo
      • AddGroupedUserIPRestrictions
      • RemoveGroupedUserIPRestrictions
      • ListUsersAllowedIps
      • ListResponseEvaluators
      • GetResponseEvaluator
      • CreateResponseEvaluator
      • UpdateResponseEvaluator
      • DeleteResponseEvaluator
    • OrgLegacy
      • RegisterOrganization
    • P3Api
      • GetAgentHuntGroup
      • GetAgentSession
      • GetAgentSkills
      • CreateAgentSkill
      • UpdateAgentSkill
      • DeleteAgentSkill
      • ListAgentSkills
      • ListSkillsForCurrentAgent
      • ListSkills
      • UpdateAgentSkills
      • GetCurrentAgent
      • GetClientInfoData
      • GetClientInfoDisplayTemplate
      • ListAgentStatisticsData
      • ListPBXExtensions
      • ListAgentExtensions
      • ListHuntGroupExtensions
      • CreateExtension
      • DeleteExtension
      • UpdateExtension
      • UpdatePBXExtension
      • CreateDNCLNumbers
      • GetScriptOrResponses
      • GetHuntGroupAgentSettings
      • ListHuntGroupWebLinks
      • GetHuntGroupPauseCodes
      • ListAgentCallHistory
      • ListClientPhoneBookEntries
      • ListHuntGroupPhoneBookEntries
      • CreatePhoneBookEntry
      • UpdatePhoneBookEntry
      • DeletePhoneBookEntry
      • ListPhoneBooks
      • ListAgentTriggers
      • GetCampaignCompletionStatus
      • GetLostPeerInfo
      • GetDispositionKeys
      • GetReadyAgents
      • ListAgentQueueAndOnHoldCallData
      • SaveAgentCallResponses
      • ListAgentTransferOptions
      • UpdateAgentCallResponseValue
      • GetIntercomPeerInfo
      • ListOrgResponseEvaluators
      • GetQueueConfigurationOptionsArray
      • GetConditionalDNCLRules
      • ManualDialStart
      • ListExtendedCallHistory
      • ListWhiteListPhoneBooks
      • DownloadCallRecording
      • DownloadCallRecordings
      • PlacePreviewDialCall
      • CancelPreviewDialCall
      • UpdateTaskStatus
      • ListCallbackRoutingAgents
      • ListCallbackRoutingSkills
      • HandleRecordingDelay
      • UpdateAgentAssignedHuntGroup
      • GetCallData
      • ListHuntGroups
      • ListReassignmentHuntGroups
      • GetOrgAgentSettings
      • ListCallerIdsFromBucket
      • SaveLastCallResponse
      • ListAgentCallLogsByCallSidAndType
      • ListAgentCallResponseValues
      • GetContactSchemaByContactGroup
      • ListContactGroupDetailsByClientSid
      • GetContactGroupDetails
      • GetContactGroupSize
      • CreateContactFieldDescription
      • UpdateContactFieldDescription
      • DeleteContactFieldDescription
      • ListContactFieldDescriptions
      • ListContactFieldDescriptionsByCGSid
      • ListContactImportTemplates
      • UpdatePreviewRecordToFinished
      • UpdateAgentHuntGroup
      • MultiAgentHuntGroupAssignment
      • GetAgentProfile
      • RecalculateBilling
      • ListOutboundBroadcastTemplateData
      • MultiAgentSkillAssignment
      • MultiAgentSkillUnassignment
      • ListMAMAgentHuntGroupsByClientSid
      • ListTtsVoices
      • CreateTtsVoice
      • DeleteTtsVoice
      • ListCustomDataKeys
      • CreateCustomDataKey
      • DeleteCustomDataKey
      • UpdateCustomDataKey
      • GetActivityLogHistory
      • ListTableTemplateProperties
      • ListAgentSkillsFilters
      • ListScheduleRules
      • ListCustomReportFilters
      • ListSmsNumbers
      • GetMailMerge
      • ListDistinctPauseCodes
      • GetAgentHuntGroup
      • GetAgentSession
      • GetAgentSkills
      • CreateAgentSkill
      • UpdateAgentSkill
      • DeleteAgentSkill
      • ListSkillsForCurrentAgent
      • ListSkills
      • UpdateAgentSkills
      • GetCurrentAgent
      • GetClientInfoData
      • GetClientInfoDisplayTemplate
      • ListAgentStatisticsData
      • ListPBXExtensions
      • ListAgentExtensions
      • ListHuntGroupExtensions
      • CreateExtension
      • DeleteExtension
      • UpdateExtension
      • UpdatePBXExtension
      • CreateDNCLNumbers
      • GetScriptOrResponses
      • GetHuntGroupAgentSettings
      • ListHuntGroupWebLinks
      • GetHuntGroupPauseCodes
      • ListAgentCallHistory
      • ListClientPhoneBookEntries
      • ListHuntGroupPhoneBookEntries
      • CreatePhoneBookEntry
      • UpdatePhoneBookEntry
      • DeletePhoneBookEntry
      • ListPhoneBooks
      • ListAgentTriggers
      • GetCampaignCompletionStatus
      • GetLostPeerInfo
      • GetDispositionKeys
      • GetReadyAgents
      • ListAgentQueueAndOnHoldCallData
      • SaveAgentCallResponses
      • ListAgentTransferOptions
      • UpdateAgentCallResponseValue
      • GetIntercomPeerInfo
      • ListOrgResponseEvaluators
      • GetQueueConfigurationOptionsArray
      • GetConditionalDNCLRules
      • ManualDialStart
      • GetExtendedCallHistories
      • ListWhiteListPhoneBooks
      • DownloadCallRecording
      • DownloadCallRecordings
      • PlacePreviewDialCall
      • CancelPreviewDialCall
      • UpdateTaskStatus
      • ListCallbackRoutingAgents
      • ListCallbackRoutingSkills
      • HandleRecordingDelay
      • UpdateAgentAssignedHuntGroup
      • GetCallData
      • ListHuntGroups
      • ListReassignmentHuntGroups
      • GetOrgAgentSettings
      • ListCallerIdsFromBucket
      • SaveLastCallResponse
      • ListAgentCallLogsByCallSidAndType
      • ListAgentCallResponseValues
      • GetContactSchemaByContactGroup
      • ListContactGroupDetailsByClientSid
      • GetContactGroupDetails
      • GetContactGroupSize
      • CreateContactFieldDescription
      • DeleteContactFieldDescription
      • ListContactFieldDescriptions
      • ListContactFieldDescriptionsByCGSid
      • ListContactImportTemplates
      • UpdatePreviewRecordToFinished
      • UpdateAgentHuntGroup
      • MultiAgentHuntGroupAssignment
      • GetAgentProfile
      • RecalculateBilling
      • ListOutboundBroadcastTemplateData
      • MultiAgentSkillAssignment
      • MultiAgentSkillUnassignment
      • ListMAMAgentHuntGroupsByClientSid
      • ListTtsVoices
      • CreateTtsVoice
      • DeleteTtsVoice
      • ListCustomDataKeys
      • CreateCustomDataKey
      • DeleteCustomDataKey
      • UpdateCustomDataKey
      • GetActivityLogHistories
      • ListTableTemplateProperties
      • ListAgentSkillsFilters
      • ListScheduleRules
      • ListCustomReportFilters
      • ListSmsNumbers
    • PBXService
      • QueryPbxUsers
      • QueryRingGroups
      • UpdatePbxUser
      • UpdateRingGroup
      • CreateRingGroup
      • DeleteRingGroup
      • AssignRandomExtension
      • ListPBXUsers
      • GetPBXUser
      • ListRingGroups
      • ListRingGroupsBySipId
      • GetRingGroup
      • GetSIPAccount
      • GetSIPAccountByUserId
      • GetSIPCredentials
      • ListSIPAccounts
      • ListSIPAccountsByRingGroupId
      • UpdateSIPAccount
      • UpdateRingGroup
      • CreateRingGroup
      • DeleteRingGroup
      • AssignRandomExtension
    • PortalManagerApi
      • UpsertPortalConfig
      • ListPortalConfigs
      • GetPortalConfig
      • DeletePortalConfig
      • UpdatePortalConfigLogo
      • GetPortalConfigLogo
      • ListPortalLinks
      • GetPortalLink
      • DeletePortalLink
      • CreatePortalLinks
      • UpsertPortal
      • GetPortal
      • DeletePortal
      • ListPortals
      • ListDetailedPortals
      • GetDetailedPortal
      • UpsertPluginInstance
      • GetPluginInstance
      • DeletePluginInstance
      • ClonePluginInstance
      • ListPluginInstance
      • ListFlowFieldNames
      • ListAvailableVerificationFields
      • ListAvailablePaymentFields
      • ListPortalTypes
      • ListPortalWorkflows
      • ListAllActionDefinitions
      • ListPluginsByMethod
    • Scorecards
      • CreateScorecard
      • ListScorecards
      • UpdateScorecard
      • DeleteScorecard
      • GetScorecard
      • CreateQuestion
      • ListQuestions
      • UpdateQuestion
      • DeleteQuestion
      • GetQuestion
      • BulkCreateQuestions
      • CreateCategory
      • ListCategories
      • UpdateCategory
      • DeleteCategory
      • GetCategory
      • CreateScorecardQuestion
      • UpdateScorecardQuestion
      • DeleteScorecardQuestion
      • GetScorecardQuestion
      • CreateSection
      • ListSections
      • UpdateSection
      • GetSection
      • DeleteSection
      • CreateQuestionCategory
      • DeleteQuestionCategory
      • CreateEvaluation
      • DeleteEvaluation
      • ScoreEvaluation
      • UpdateEvaluation
      • GetEvaluation
      • ListEvaluations
      • CreateEvaluationQuestion
      • UpdateEvaluationQuestion
      • DeleteEvaluationQuestion
      • SampleCallsByCategory
      • SampleAgentConversations
      • CreateAutoQuestion
      • UpdateAutoQuestion
      • DeleteAutoQuestion
      • GetAutoQuestion
      • GetAutoEvaluation
      • ListAutoEvaluations
      • StreamAutoEvaluations
      • DeleteAutoEvaluation
      • PreviewEvaluationScore
      • RestoreEvaluation
      • CreateSmartQuestion
      • UpdateSmartQuestion
      • DeleteSmartQuestion
      • ListSmartEvaluations
      • DeleteSmartEvaluation
      • GetSmartEvaluation
    • ScorecardsSupport
      • ListEvaluationsByOrgId
      • ListAutoEvaluationsByOrgId
      • BulkDeleteEvaluations
      • BulkDeleteAutoEvaluations
      • DeleteEvaluationByOrgId
      • DeleteAutoEvaluationByOrgId
      • ListScorecardsByOrgId
      • ListCategoriesByOrgId
    • Sds
      • GetAgentResponseData
      • GetCall
      • UpdateAgentResponseData
      • UpdateVoicemailBox
    • Sentinel
      • SendEvents
      • SendEvents
    • SkillsService
      • CreateSkillGroup
      • ListSkillGroups
      • UpdateSkillGroup
      • GetSkillGroup
      • DeleteSkillGroup
      • RemoveSkillFromAllGroups
      • AssignSkillGroups
      • UpdateUsersOnSkillGroup
      • RevokeSkillGroups
      • GetUserSkillGroups
      • GetUserSkills
      • GetSkillGroupMembers
      • ListSkillGroupsMembers
      • GetAgentSkills
      • ListSkillsForCurrentAgent
      • ListAssignedSkillGroups
      • AssignOwnSkillGroups
      • RevokeOwnSkillGroups
    • SmsApi
      • ListSmsTemplates
      • CreateSmsTemplate
      • UpdateSmsTemplate
      • DeleteSmsTemplate
      • GetSmsTemplateBySid
      • ListSmsIntentTemplates
      • CreateSmsIntentTemplate
      • UpdateSmsIntentTemplate
      • DeleteSmsIntentTemplate
      • GetSmsIntentTemplateBySid
      • ListSmsSourceNumbers
      • CreateSmsSourceNumber
      • UpdateSmsSourceNumber
      • DeleteSmsSourceNumber
      • GetSmsSourceNumberBySid
      • SendSmsNotification
      • ListSmsGroupByFilters
      • ListSmsGroupsByGroupSids
      • ListSmsTasksByGroupSids
      • ListSmsGroupByFiltersForAudit
      • ListSmsGroupsByGroupSidsForAudit
      • ListSmsTasksByGroupSidsForAudit
      • ListSmsTasksWithDetailedStatus
      • UpdateSmsGroupStatus
      • UpdateSmsGroupSendsPerMinute
      • UpdateSmsGroupScheduleTimes
      • ScheduleSms
      • ResendUnconnectedSms
      • SmsActivitySearch
      • CreateInboundSmsTemplate
      • UpdateInboundSmsTemplate
      • DeleteInboundSmsTemplate
      • ListInboundSmsTemplates
      • GetInboundSmsTemplateById
      • CreateInboundSmsGroup
      • UpdateInboundSmsGroup
      • DeleteInboundSmsGroup
      • ListInboundSmsGroups
      • ListActiveInboundSmsGroups
      • ListInboundSmsGroupByFilters
      • GetInboundSmsGroupById
      • ListInboundSmsGroupsByGroupIds
      • StopInboundSmsGroup
      • ScheduleInboundSms
      • CreateSmsConversation
      • UpdateSmsConversation
      • DeleteSmsConversation
      • ListSmsConversations
      • GetSmsConversationById
      • GetSmsMessage
      • CreateSmsConversationAudit
      • ListSmsConversationAudits
      • GetSmsConversationAuditById
      • CreateSmsConversationAssignedAgent
      • ListSmsConversationAssignedAgents
      • GetSmsConversationAssignedAgentById
      • ListInboundSmsTasksByGroupIds
      • StopAllOutboundSmsGroups
      • StopAllInboundSmsGroups
    • Soundboard
      • GetSoundboardFile
      • CreateSoundboard
      • ListSoundboards
      • UpdateSoundboard
      • DeleteSoundboard
    • Srec
      • ListScreenRecordings
      • GetScreenRecordingURL
      • DeleteScreenRecording
    • TasksService
      • CancelTasks
      • BulkCancelTasks
    • Tickets
      • CreateTicket
      • EditTicket
      • ListTickets
      • AssignTicket
      • CloseTicket
      • ViewTicket
      • CreateComment
      • EnableProject
      • ListEnabledProjects
      • CreateSLA
      • ListSLA
      • UpdateSLA
      • ListSLACondition
      • ReplyComment
      • ListTicketAuditLog
      • AssignSelf
      • EditMaskTicket
      • ListAllocatedTickets
      • ListAvailableAgentTickets
      • ListAgentTickets
      • ListSkills
      • ListUsers
      • CloseTicketAction
      • AssignTicketAction
      • CreateTicketAction
      • ChangeTicketStatus
      • CreateTicketTemplate
      • EditTicketTemplate
      • ListTicketTemplate
      • AssignTicketTemplate
      • GetAllActionType
      • GetPhoneNumberType
      • AddEntityRef
      • ListTicketsByEntityRef
      • ListEntityRefsByTicket
      • CreateCustomField
      • EditCustomField
      • ListCustomFields
    • TranslationsService
      • TranslateTemplate
      • ListTranslations
      • ListLanguages
      • ListContexts
      • CreateTranslation
      • UpdateTranslation
      • TriggerLLMTranslation
      • TriggerLLMTranslations
      • SetSystemMessage
      • GetSystemMessage
      • TestSystemMessage
      • EnableContext
      • DisableContext
      • DeleteTranslationsByTemplate
      • BulkDeleteTranslations
    • TrustsService
      • CreateTrust
      • AcceptTrust
      • RejectTrust
      • GetTrust
      • ListIncomingTrusts
      • ListGivenTrusts
      • ListAssignableTrusts
      • DeleteTrust
      • AssignTrust
      • UnassignTrust
    • UsersService
      • CreateUser
      • CreateDelegatedUser
      • GetMyUser
      • GetUser
      • GetUserByOrgId
      • ListAgents
      • ListPublicUsers
      • ListUsers
      • ListUsersByOrgId
      • ListUsersByRegion
      • UpdateMyUser
      • UpdateUser
      • UpdateUserLabels
      • UpdateUserCallerId
      • UpdateUserDisabled
      • UpdateUserDisabledByOrgId
      • GetMyUserPasswordResetLink
      • GetUserPasswordResetLink
      • GetUserPasswordResetLinkByOrgId
      • CreatePasswordResetLink
      • CreatePasswordResetLinkByOrgId
      • GetUserLoginInfo
      • GetUserEmailVerified
      • GetUserEmailVerifiedByOrgId
      • ResetMyPassword
      • ResetUserPassword
      • ResetUserPasswordByOrgId
      • SendUserEmailVerification
      • SendUserEmailVerificationByOrgId
      • SendPasswordReset
      • SendPasswordResetByOrgId
      • GetUserSessionData
      • GetAgentProfileGroup
      • ListAgentProfileGroups
      • UpdateAgentProfileGroup
      • CreateAgentProfileGroup
      • DeleteAgentProfileGroup
      • AssignAgentProfileGroups
      • AddUserSubscription
      • AddUserSubscriptionByUserId
      • GetUserSubscription
      • GetUserSubscriptionByUserId
      • UpdateUserSubscription
      • UpdateUserSubscriptionByUserId
      • RemoveUserSubscription
      • RemoveUserSubscriptionByUserId
      • ListUserSubscriptions
      • ListUserSubscriptionsByUserId
      • ListOrgSubscriptions
      • CreateAuthToken
      • CreateAuthTokenByUserId
      • ListAuthTokens
      • ListAuthTokensByUserId
      • SetAuthTokenExpiration
      • SetAuthTokenExpirationByUserId
      • DeleteAuthToken
      • DeleteAuthTokenByUserId
      • RefreshMfaLockout
      • RefreshMfaLockoutByOrgId
      • SetMfaType
      • SetMyMfaType
      • EnableUserMfa
      • EnableMyUserMfa
      • GetUserMfaInfo
      • GetMyUserMfaInfo
      • AddGroupedUserIPRestrictions
      • RemoveGroupedUserIPRestrictions
      • ListUsersAllowedIps
    • Vanalytics
      • Audit
      • GetRecordingUrl
      • ListBillingSpan
      • Search
      • ListTranscriptGroupNames
      • BulkDeleteTranscripts
      • BulkRestoreTranscripts
      • ListAgentResponseValues
      • GetTranscriptSummary
      • CreateFilter
      • ListFilters
      • UpdateFilter
      • DeleteFilter
      • GetFilter
      • GetFlag
      • CreateFlag
      • ListFlags
      • UpdateFlag
      • DeleteFlag
      • CreateFlagReview
      • BulkCreateFlagReview
      • ListFlagReviews
      • CreateFlagTranscript
      • SearchFlagTranscripts
      • CreateFlagFilter
      • ListFlagFilters
      • DeleteFlagFilter
      • ListFlagSnapshots
      • ListFlagTranscriptFilters
      • CreateCorrection
      • GetCorrection
      • DeleteCorrection
      • ListCorrections
      • UpdateCorrection
      • Audit
      • GetRecordingUrl
      • ListBillingSpan
      • SearchTranscripts
      • BulkDeleteTranscripts
      • BulkRestoreTranscripts
      • ListTranscriptGroupNames
      • ListAgentResponseValues
      • GetTranscriptSummary
      • CreateFilter
      • ListFilters
      • UpdateFilter
      • DeleteFilter
      • GetFilter
      • ListFlagTranscriptFilters
      • ListFlagFilters
      • GetFlag
      • CreateFlag
      • ListFlags
      • UpdateFlag
      • DeleteFlag
      • CreateFlagReview
      • BulkCreateFlagReview
      • ListFlagReviews
      • CreateFlagTranscript
      • ListFlagSnapshots
      • CreateCorrection
      • GetCorrection
      • DeleteCorrection
      • ListCorrections
      • UpdateCorrection
    • VanalyticsSupport
      • DeleteFlagTranscript
      • SearchByOrgId
    • Vmds
      • GetVoicemailMetadata
      • GetVoicemailMessageCount
      • DeleteVoicemail
      • DeleteGreeting
      • UpdateUploadName
      • UpdateVoicemailFlagRead
      • DownloadMessage
      • DownloadMessages
      • DownloadGreetingForExtension
      • DownloadGreeting
      • GetUploadGreetingUrl
      • ProcessGreetingUpload
      • UpdateGreetingForExtension
      • ListAvailableGreetings
    • VmdsService
      • DownloadSpecifiedMessages
    • WFM
      • PerformInitialClientSetup
        POST
      • CreateInitialDemoActivities
        POST
      • ListSkillProfiles
        POST
      • UpdateSkillProfile
        POST
      • UpdateSkillProfileProficiencies
        POST
      • GetSkillProfile
        POST
      • ResyncSkillProfiles
        POST
      • GetLastSkillProfileResyncDate
        POST
      • UpsertForecastingParameters
        POST
      • GetForecastingParameters
        POST
      • GetClientHistoryCacheInfo
        POST
      • ListHistoricalData
        POST
      • UpsertHistoricalDataDelta
        POST
      • UpsertHistoricalDataDeltas
        POST
      • ListSkills
        POST
      • BuildCallProfileTemplateForSkillProfile
        POST
      • BuildCallProfileTemplate
        POST
      • CreateInactiveSkillProfileMapping
        POST
      • GetAvailableRegressionForecasterModelTypes
        POST
      • DisconnectInactiveSkillProfileMapping
        POST
      • CreateSkillProfileGroup
        POST
      • UpdateSkillProfileGroup
        POST
      • ListSkillProfileGroups
        POST
      • UpdateSkillProfileGroupAssociations
        POST
      • DeleteHistoricalDataDeltas
        POST
      • ListTopSkillProfiles
        POST
      • GetSkillProfilesCount
        POST
      • BuildProfileForecastByInterval
        POST
      • BuildProfileForecastByIntervalWithStats
        POST
      • UpsertProfileForecast
        POST
      • CreateCallProfileTemplate
        POST
      • DeleteCallProfileTemplate
        POST
      • CreateRegressionTemplate
        POST
      • DeleteRegressionTemplate
        POST
      • ListRegressionTemplates
        POST
      • ListForecastIntervalsForSkillProfile
        POST
      • ListForecastIntervals
        POST
      • ListForecastIntervalsV2
        POST
      • BuildRegressionForecastByInterval
        POST
      • BuildRegressionForecastByIntervalWithStats
        POST
      • ListCallProfileTemplates
        POST
      • UpsertRegressionForecast
        POST
      • UpsertForecastDataDelta
        POST
      • UpsertForecastDataDeltas
        POST
      • DeleteForecastIntervals
        POST
      • ListHistoricalDataForAllSkillProfiles
        POST
      • BuildDOWAndMOYProfiles
        POST
      • CalculateTrainingDataAveragesForSkillProfile
        POST
      • UpdateSkillProfileAveragesUsingHistoricalData
        POST
      • UpdateCallCenterNode
        POST
      • CreateClientNode
        POST
      • UpdateClientNode
        POST
      • CreateLocationNode
        POST
      • UpdateLocationNode
        POST
      • CreateProgramNode
        POST
      • UpdateProgramNode
        POST
      • ListProgramNodesBySid
        POST
      • CreateConstraintRule
        POST
      • UpdateConstraintRule
        POST
      • DeleteConstraintRule
        POST
      • CreateNonSkillActivity
        POST
      • UpdateNonSkillActivity
        POST
      • ListNonSkillActivities
        POST
      • ListNonSkillActivityAssociations
        POST
      • ListCandidateSchedulingActivities
        POST
      • ListSchedulingActivities
        POST
      • GetOnCallSchedulingActivity
        POST
      • CreateSchedulingActivityPauseCodes
        POST
      • DeleteSchedulingActivityPauseCodes
        POST
      • ListPatternsForSchedulingActivityClassifications
        POST
      • GetTimeOffSchedulingActivity
        POST
      • CreateAgentGroup
        POST
      • ListAgentScheduleGroups
        POST
      • UpdateAgentGroup
        POST
      • CreateUnassignedWFMAgent
        POST
      • UpdateWFMAgent
        POST
      • ListAllWFMAgents
        POST
      • ListCandidateWFMAgents
        POST
      • ListUngroupedWFMAgents
        POST
      • ListWFMAgentSids
        POST
      • ListUnassignedWFMAgents
        POST
      • ListWFMAgentsAssociatedWithAgentGroup
        POST
      • CreateWFMAgentMemberships
        POST
      • CopyWFMAgentMemberships
        POST
      • DeleteWFMAgentMemberships
        POST
      • DeleteWFMAgentsMemberships
        POST
      • RemoveAgentFromFutureShifts
        POST
      • BuildAgentDiagnostics
        POST
      • CreateShiftTemplate
        POST
      • UpdateShiftTemplate
        POST
      • ListShiftTemplatesBySids
        POST
      • BuildShiftTemplateDiagnostics
        POST
      • CreatePlacementRule
        POST
      • UpdatePlacementRule
        POST
      • DeletePlacementRule
        POST
      • CreateOpenTimesPattern
        POST
      • UpdateOpenTimesPattern
        POST
      • DeleteOpenTimesPattern
        POST
      • GetOpenTimesBitmaps
        POST
      • ListOpenDateRangesForNodeOpenTimesBitmaps
        POST
      • CreateAgentAvailabilityPattern
        POST
      • UpdateAgentAvailabilityPattern
        POST
      • DeleteAgentAvailabilityPattern
        POST
      • GetAvailabilityBitmaps
        POST
      • UpsertNonSkillActivityAssociation
        POST
      • CreateSkillProficiencies
        POST
      • UpdateSkillProficiencies
        POST
      • DeleteSkillProficiency
        POST
      • CopyScenario
        POST
      • CreateScheduleScenarioWithNodes
        POST
      • UpdateScheduleScenario
        POST
      • ListConfigEntities
        POST
      • CreateReasonCode
        POST
      • UpdateReasonCode
        POST
      • GetDefaultReasonCode
        POST
      • ListReasonCodes
        POST
      • DeleteShiftInstances
        POST
      • BuildNodeDiagnostics
        POST
      • BuildGlobalDiagnostics
        POST
      • GetPublishedSchedule
        POST
      • GetPublishedScheduleRequiredCalls
        POST
      • GetDraftScheduleRequiredCalls
        POST
      • CreateDraftSchedule
        POST
      • UpdateDraftSchedule
        POST
      • BuildDraftSchedule
        POST
      • PollBuildInProgress
        POST
      • CancelBuildInProgress
        POST
      • PublishDraftSchedule
        POST
      • ResetDraftSchedule
        POST
      • GetDraftSchedule
        POST
      • ListDraftSchedules
        POST
      • ClearSchedule
        POST
      • DeleteDraftSchedule
        POST
      • ListShiftInstancesBySid
        POST
      • CopyScheduleToSchedule
        POST
      • CreateShiftInstance
        POST
      • CreateShiftInstanceV2
        POST
      • CreateShiftInstanceWithSegments
        POST
      • SplitShiftInstance
        POST
      • SwapShiftInstances
        POST
      • UpdateShiftInstance
        POST
      • UpdateShiftInstanceV2
        POST
      • UpdateShiftInstanceWithSegments
        POST
      • CopyShiftInstancesToSchedule
        POST
      • ListShiftInstanceSidsForAgent
        POST
      • ListShiftInstanceSidsForSchedule
        POST
      • ListShiftSegmentsByShiftInstanceSids
        POST
      • SetSchedulingTarget
        POST
      • GetSchedulingTarget
        POST
      • DeleteSchedulingTarget
        POST
      • GetDefaultSchedulingTarget
        POST
      • SetDefaultSchedulingTarget
        POST
      • GetPerformanceMetrics
        POST
      • ListRequiredCallsIntervals
        POST
      • CreateTourPattern
        POST
      • GetTourPatternDiagnostics
        POST
      • UpsertTourPatternWithMembers
        POST
      • GetTourPattern
        POST
      • GetTourPatternWithMembers
        POST
      • DeleteTourPattern
        POST
      • CreateTourWeekPattern
        POST
      • ListTourWeekPatterns
        POST
      • DeleteTourWeekPatterns
        POST
      • CreateTourShiftInstanceConfig
        POST
      • UpdateTourShiftInstanceConfig
        POST
      • ListTourShiftInstanceConfigs
        POST
      • DeleteTourShiftInstanceConfigs
        POST
      • CreateTourShiftSegmentConfig
        POST
      • UpdateTourShiftSegmentConfig
        POST
      • ListTourShiftSegmentConfigs
        POST
      • DeleteTourShiftSegmentConfigs
        POST
      • CreateTourAgentCollection
        POST
      • UpdateTourAgentCollection
        POST
      • ListTourAgentCollections
        POST
      • DeleteTourAgentCollections
        POST
      • CreateTourAgentCollectionWFMAgents
        POST
      • ListTourAgentCollectionWFMAgents
        POST
      • DeleteTourAgentCollectionWFMAgents
        POST
      • GenerateTourWeekPatterns
        POST
      • ListValidAgentsForReplacement
        POST
      • ReplaceAgentOnSchedule
        POST
      • ReplaceAgentOnScheduleV1
        POST
      • RemoveAgentFromSchedule
        POST
      • CreatePublishedShift
        POST
      • CreatePublishedShiftWithSegments
        POST
      • UpdatePublishedShift
        POST
      • UpdatePublishedShiftWithSegments
        POST
      • SplitPublishedShift
        POST
      • SwapPublishedShifts
        POST
      • DeletePublishedShifts
        POST
      • ReplaceAgentOnPublishedSchedule
        POST
      • RemoveAgentFromPublishedSchedule
        POST
      • CopyShiftsToPublishedSchedule
        POST
      • CreateAgentLeavePetition
        POST
      • ListAgentLeavePetitions
        POST
      • ArchiveAgentLeavePetition
        POST
      • ResolveAgentLeavePetition
        POST
      • CancelAgentLeavePetition
        POST
      • HelloWorldWFMAdherence
        POST
      • ListAdherenceDiagnostics
        POST
      • ListAgentStatesForDay
        POST
      • ListRealTimeManagementStates
        POST
      • ListAdherenceAgentStates
        POST
      • ListAdherenceAgentStateViolations
        POST
      • ResolveAdherenceAgentStateViolation
        POST
      • UpsertRealTimeManagementStateColor
        POST
      • ListRealTimeManagementStateColors
        POST
      • DeleteRealTimeManagementStateColor
        POST
      • CreateRgbaColor
        POST
      • ListRgbaColors
        POST
      • UpdateRgbaColor
        POST
      • DeleteRgbaColor
        POST
      • CreateAdherenceRuleNotificationConfig
        POST
      • UpdateAdherenceRuleNotificationConfig
        POST
      • CreateAdherenceRuleNotificationConfigEntry
        POST
      • UpdateAdherenceRuleNotificationConfigEntry
        POST
      • DeleteAdherenceRuleNotificationConfigEntry
        POST
      • ListAdherenceRuleNotificationConfigs
        POST
      • CreateAdherenceDepartmentalRule
        POST
      • UpdateAdherenceDepartmentalRule
        POST
      • CreateAdherenceDepartmentalRuleClause
        POST
      • UpdateAdherenceDepartmentalRuleClause
        POST
      • DeleteAdherenceDepartmentalRuleClause
        POST
      • ListAdherenceDepartmentalRules
        POST
      • CreateAdherenceAgentRule
        POST
      • UpdateAdherenceAgentRule
        POST
      • CreateAdherenceAgentRuleClause
        POST
      • UpdateAdherenceAgentRuleClause
        POST
      • ListAdherenceAgentRules
        POST
      • DeleteAdherenceAgentRuleClause
        POST
      • AgentGetSchedule
        POST
      • AgentListLeavePetitions
        POST
      • AgentCreateLeavePetition
        POST
      • AgentCancelLeavePetition
        POST
      • SetAgentStateSimulationLevelForOrg
        POST
    • WorkflowDefinitionPersistService
      • GetWorkflowDefinition
      • ListWorkflowDefinitions
      • UpdateWorkflowDefinition
      • DeleteWorkflowDefinition
      • ValidateWorkflowDefinition
    • Room303API
      • AddRoomMember
      • RemoveRoomMember
      • ListRoomMembers
      • SetAdminForRoomMember
      • JoinRoom
      • GetRoomMember
      • CreateMessage
      • EditMessage
      • DeleteMessage
      • GetMessages
      • StreamMessageUpdates
      • GetUnreadStats
      • MarkMessageRead
      • MarkAllMessagesRead
      • BulkMarkMessageRead
      • CreateRoom
      • GetRoom
      • ListAllRooms
      • ListRoomsForMember
      • ArchiveRoom
      • ListUsersNames
      • UpdateRoomConfig
      • UpdateGlobalConfig
      • GetGlobalConfig
      • UpdateRoom
  • Third Party
    • FTS Initiate
    • FTS Upload
  • Use Cases
    • Click to Call
    • Virtual Agent
    • LMS File Upload
  1. WFM

BuildDraftSchedule

POST
https://api.cbf.tcn.com/api/v1alpha1/wfm/builddraftschedule
WFM
Builds a draft schedule for the given @node_selector in @schedule_scenario_sid over @schedule_scenario_scheduling_range for @draft_schedule_sid and the org making the request.
The @schedule_scenario_scheduling_range field is optional. If not set, the draft schedule will be obtained with it's default range from it's start to end time.
Returns the draft schedule without any shift instances.
Will return diagnostics for the newly built schedule, or just diagnostics if the schedule cannot be built successfully due to diagnostic error.
If @auto_generate_agents is set to true, unassigned agents will automatically be generated to meet the requirements of the shift templates min and max agents.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
Request message for the BuildDraftSchedule RPC.
schedule_scenario_scheduling_range
object (DatetimeRange) 
schedule_scenario_scheduling_range
optional
Datetime range to set for the schedule scenario used to make the draft schedule.
If left blank, the current scheduling range for the scenario will be used
start_datetime
string <date-time>
start_datetime
optional
begining datetime
Examples:
1s1.000340012s
end_datetime
string <date-time>
end_datetime
optional
ending datetime
Examples:
1s1.000340012s
node_selector
object (ParentEntity) 
node_selector
optional
The node that the shifts should be associated with.
parent_type
enum<string> 
parent_type
optional
Type of entity that the @parent_sid will reference.
Allowed values:
CALL_CENTER_NODECLIENT_NODELOCATION_NODEPROGRAM_NODEAGENT_GROUPSHIFT_TEMPLATEWFM_AGENTPLACEMENT_RULECONSTRAINT_RULENON_SKILL_ACTIVITYAGENT_AVAILABILITYOPEN_TIMESSCHEDULING_ACTIVITYSKILL_PROFICIENCYSCHEDULE_SCENARIOSKILLTOUR_PATTERNTOUR_WEEK_PATTERNTOUR_SHIFT_INSTANCE_CONFIGTOUR_SHIFT_SEGMENT_CONFIGTOUR_AGENT_COLLECTION
parent_sid
integer <int64> | string 
parent_sid
optional
ID of a parent entity
scheduling_target
object (SchedulingTarget) 
scheduling_target
deprecated
The scheduling target. Not used. If given, it is still ignored.
scheduling_target_type
enum<string> 
scheduling_target_type
deprecated
Target type for the @node to override the inherited value.
Allowed values:
COVERAGESERVICE_LEVEL
service_level_target_duration_seconds
service_level_target_duration_seconds
deprecated
Number of seconds allowed to answer call for the scheduling if @scheduling_target_type is set to SERVICE_LEVEL.
If @scheduling_target_type is not SERVICE_LEVEL then this field must be set to nil
node_entity
object (ParentEntity) 
node_entity
deprecated
The node that the scheduling target if used by.
May be set to nil if associated with the master scheduling target.
scheduling_target_percentage
number <float>
scheduling_target_percentage
deprecated
Target percentage for scheduling.
scheduling_target_sid
integer <int64> | string 
scheduling_target_sid
deprecated
ID of the scheduling target.
include_shift_instances
boolean 
include_shift_instances
deprecated
Set to true to include shift instances.
include_shift_template
boolean 
include_shift_template
deprecated
Set to true to include shift template in each of the returned shift instances.
Only effective when include_shift_instances is also set to true.
include_shift_segments
boolean 
include_shift_segments
deprecated
Set to true to include shift segments in each of the returned shift instances.
Only effective when include_shift_instances is also set to true.
include_scheduling_activity
boolean 
include_scheduling_activity
deprecated
Set to true to include scheduling activity in each of the returned shift segments.
Only effective when include_shift_instances and include_shift_segments are also set to true.
include_activity
boolean 
include_activity
deprecated
Set to true to include non skill activity in each of the returned scheduling activities.
Only effective when include_scheduling_activity, include_shift_segments and include_shift_instances are also set to true.
auto_generate_agents
boolean 
auto_generate_agents
optional
Set to true to automatically generate agents to meet the requirements of the shift templates min and max agents.
Otherwise, no agents will be generated to meet these requirements.
draft_schedule_sid
integer <int64> | string 
draft_schedule_sid
optional
ID of the draft schedule.
schedule_scenario_sid
integer <int64> | string 
schedule_scenario_sid
optional
ID of the node's schedule scenario sid.
Example
{
  "schedule_scenario_scheduling_range": {
    "start_datetime": "1s",
    "end_datetime": "1s"
  },
  "node_selector": {
    "parent_type": "CALL_CENTER_NODE",
    "parent_sid": 0
  },
  "scheduling_target": {
    "scheduling_target_type": "COVERAGE",
    "service_level_target_duration_seconds": "string",
    "node_entity": {
      "parent_type": "CALL_CENTER_NODE",
      "parent_sid": 0
    },
    "scheduling_target_percentage": 0,
    "scheduling_target_sid": 0
  },
  "include_shift_instances": true,
  "include_shift_template": true,
  "include_shift_segments": true,
  "include_scheduling_activity": true,
  "include_activity": true,
  "auto_generate_agents": true,
  "draft_schedule_sid": 0,
  "schedule_scenario_sid": 0
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/builddraftschedule' \
--header 'Content-Type: application/json' \
--data-raw '{
    "schedule_scenario_scheduling_range": {
        "start_datetime": "1s",
        "end_datetime": "1s"
    },
    "node_selector": {
        "parent_type": "CALL_CENTER_NODE",
        "parent_sid": 0
    },
    "scheduling_target": {
        "scheduling_target_type": "COVERAGE",
        "service_level_target_duration_seconds": "string",
        "node_entity": {
            "parent_type": "CALL_CENTER_NODE",
            "parent_sid": 0
        },
        "scheduling_target_percentage": 0,
        "scheduling_target_sid": 0
    },
    "include_shift_instances": true,
    "include_shift_template": true,
    "include_shift_segments": true,
    "include_scheduling_activity": true,
    "include_activity": true,
    "auto_generate_agents": true,
    "draft_schedule_sid": 0,
    "schedule_scenario_sid": 0
}'

Responses

🟢200OK
application/json
Success
Body
Response message for the BuildDraftSchedule RPC
draft_schedule
object (DraftSchedule) 
draft_schedule
optional
The built draft schedule.
created_at
string <date-time>
created_at
optional
Time that this the schedule was created.
Examples:
1s1.000340012s
last_updated_at
string <date-time>
last_updated_at
optional
Time that this schedule was last updated.
Examples:
1s1.000340012s
datetime_range
object (DatetimeRange) 
datetime_range
optional
Datetime range over which this draft schedule spans.
Is the range used when copying shifts from published schedule.
Also used when publishing shifts from the draft to the published schedule.
name
string 
name
optional
Name of the draft schedule.
description
string 
description
optional
A description of the draft schedule.
created_by_user_id
string 
created_by_user_id
optional
ID of the user who originally drafted the schedule.
shift_instances
array[object (ShiftInstance) {12}] 
shift_instances
optional
The following field is only return of List requests of the entity.
Shifts that this schedule has.
performance_metrics
array[object (PerformanceMetric) {13}] 
performance_metrics
deprecated
Deprecated. Performance metrics that this schedule has.
performance_metrics_v2
array[object (PerformanceMetricV2) {19}] 
performance_metrics_v2
optional
Performance metrics that this schedule has.
draft_schedule_sid
integer <int64> | string 
draft_schedule_sid
optional
ID of the draft schedule.
schedule_scenario_sid
integer <int64> | string 
schedule_scenario_sid
optional
Schedule Scenario of the draft schedule.
scheduling_result_metric
object (SchedulingResultMetric) 
scheduling_result_metric
optional
The scheduling result metric for the built schedule range.
total_internal_intervals
integer <int32>
total_internal_intervals
optional
The total number of minute-width intervals that were scheduled and measured.
total_intervals_with_fte_required
integer <int32>
total_intervals_with_fte_required
optional
The total number of minute-width intervals that had enough scheduled ftes to meet the predicted call FTEs.
total_intervals_with_ftes_remaining
integer <int32>
total_intervals_with_ftes_remaining
optional
The total number of intervals that have unmet predicted call FTEs (not enough scheduled FTEs).
coverage
number <float>
coverage
optional
The average ratio of interval metrics (min(1, scheduled/predicted)). A value of 1 means every interval
with predicted call FTEs has enough scheduled FTEs to meet requirements.
root_mean_square
number <float>
root_mean_square
optional
Root Mean Square metric for predicted - scheduled FTEs.
has_result
boolean 
has_result
optional
Set to TRUE if this object contains valid metrics.
metrics_by_skill_collection
array[object (SchedulingResultMetricForSkillCollection) {7}] 
metrics_by_skill_collection
optional
Per-skill metrics.
diagnostics
array[object (Diagnostic) {4}] 
diagnostics
optional
Set of diagnostic reports for the given @draft_schedule_sid.
level
enum<string> 
level
optional
The diagnostic level describes the class of the diagnostic message.
Allowed values:
INFORMATIONSUGGESTIONWARNINGDIAGNOSTIC_ERRORINTERNAL_ERROR
code
enum<string> 
code
optional
A code to describe the diagnostic when possible. Default value of General when a more specific code is not available.
Allowed values:
GENERALOKNO_SKILLS_IN_DICTIONARYAGENT_HAS_NO_SKILL_PROFICIENCIESAGENT_HAS_NO_SKILLSNO_SCHEDULING_ACTIVITIES_FOR_CONSTRAINT_RULESSCHEDULING_ACTIVITY_FOR_CONSTRAINT_RULE_NOT_FOUNDSHIFT_TEMPLATE_CANNOT_BE_NONESHIFT_TEMPLATE_HAS_NO_PLACEMENT_RULESNO_ONCALL_IN_SHIFT_TEMPLATE_PLACEMENT_RULESMIN_GT_MAX_DURATION_IN_SHIFT_TEMPLATE_PLACEMENT_RULESMIN_GT_MAX_AGENTS_IN_SHIFT_TEMPLATENO_PLACEMENT_RULES_FOR_SHIFT_TEMPLATEACTIVITIES_SHORTER_THAN_SHIFTNOT_ENOUGH_AGENTS_FOR_SHIFTPROGRAM_HAS_NO_AGENT_GROUPSPROGRAM_HAS_NO_SHIFT_TEMPLATESLOCATION_HAS_NO_PROGRAMSCLIENT_HAS_NO_LOCATIONSCALL_CENTER_HAS_NO_CLIENTSPROGRAM_HAS_INVALID_PARENT_LOCATIONLOCATION_HAS_INVALID_PARENT_CLIENTCLIENT_HAS_INVALID_PARENT_CALL_CENTERAGENT_GROUP_HAS_INVALID_PARENT_NODESHIFT_TEMPLATE_HAS_INVALID_PARENT_PROGRAMNO_SKILL_PROFICIENCY_FOR_MIN_SKILL_PROFICIENCY_CONSTRAINT_RULETOO_MANY_AGENTS_WITH_LOCKED_SHIFTS_FOR_MIN_AGENTSAGENT_DOES_NOT_BELONG_TO_AN_AGENT_GROUPINVALID_CONSTRAINT_VAL_UNITSCONSTRAINT_GENERAL_FAILURECANDIDATE_SHIFT_COLLISION_DETECTEDCANDIDATE_SHIFT_AGENT_NOT_AVAILABLECANDIDATE_CLOSEDCONSTRAINT_ACTIVITY_NOT_FOUNDCONSTRAINT_AGENT_DOES_NOT_HAVE_PROFICIENCYCONSTRAINT_AGENT_PROFICIENCY_TOO_LOWCONSTRAINT_MAX_TOTAL_ON_FAILURECONSTRAINT_MIN_TOTAL_ON_FAILURECONSTRAINT_MAX_TOTAL_OFF_FAILURECONSTRAINT_MIN_TOTAL_OFF_FAILURECONSTRAINT_MAX_CONSEC_ON_FAILURECONSTRAINT_MIN_CONSEC_ON_FAILURECONSTRAINT_MAX_CONSEC_OFF_FAILURECONSTRAINT_MIN_CONSEC_OFF_FAILURECONSTRAINT_CANNOT_HAVE_DAY_WEEK_MONTH_YEAR_SHIFT__PER_SHIFTCONSTRAINT_CANNOT_HAVE_DAY_WEEK_MONTH_YEAR__PER_MINUTES_HOURSCONSTRAINT_CONSECUTIVE_SHIFTS_RULE_NOT_ALLOWEDCONSTRAINT_WITH_LARGER_PERIOD_PER_SMALL_PERIOD_NOT_ALLOWEDCONSTRAINT_MIN_MAX_OFF_TIME_FOR_SHIFTS_NOT_ALLOWEDCONSTRAINT_CANNOT_HAVE_CONSECUTIVE_TIME_PER_MULTIPLE_SHIFTSCANNOT_GENERATE_TOUR_PATTERNS_FOR_NON_TOUR_SHIFT_TEMPLATETOUR_PATTERNS_NEEDED_TO_SCHEDULE_TOURSHIFT_TEMPLATE_ACTIVITY_PLACEMENT_MIN_MAX_MUST_BE_MULTIPLE_OF_5_MINUTESNO_SHIFT_TEMPLATE_ACTIVITY_PLACEMENT_SEQUENCES_MATCH_SHIFT_MIN_MAX_WIDTHINVALID_TOUR_PATTERNINVALID_TOUR_AGENT_COLLECTIONINVALID_TOUR_SHIFT_INSTANCE_CONFIGINVALID_TOUR_SHIFT_SEGMENT_CONFIGTOUR_SHIFT_SEGMENT_CONFIG_OVERLAPTOUR_SHIFT_SEGMENT_CONFIG_DOES_NOT_FITTOUR_SHIFT_INSTANCE_CONFIG_OVERLAPWEEK_PATTERN_NUMBERS_NOT_UNIQUE_IN_TOUR_WEEK_PATTERNSWFM_AGENT_SIDS_NOT_UNIQUE_IN_TOUR_AGENT_COLLECTIONSFIST_WEEK_PATTERN_NUMBERS_NOT_UNIQUE_IN_TOUR_AGENT_COLLECTIONSFIRST_WEEK_PATTERN_NUMBERS_NOT_FOUND_IN_TOUR_WEEK_PATTERNSSHIFT_TEMPLATE_HAS_NO_ASSOCIATED_SCHEDULING_AGENT_GROUPSATTEMPT_TO_BUILD_SCHEDULES_FOR_INVALID_PARENT_NODESCHEDULABLE_AGENTS_DO_NOT_MEET_TEMPLATE_MINIMUMSCHEDULABLE_AGENTS_DO_NOT_MEET_TEMPLATE_MAXIMUMNO_OPEN_TIMES_SET_OR_INHERITED_BY_PROGRAMTOUR_AGENT_COLLECTIONS_NEEDED_TO_SCHEDULE_TOURNO_PREDICTED_CALLS_IN_SCHEDULING_RANGESHIFT_TEMPLATE_MIN_WIDTH_DOW_MISMATCH
source_entity
object (ParentEntity) 
source_entity
optional
The entity that the diagnostic was built in reference to.
message
string 
message
optional
The message detailing the diagnostic.
Example
{
  "draft_schedule": {
    "created_at": "1s",
    "last_updated_at": "1s",
    "datetime_range": {
      "start_datetime": "1s",
      "end_datetime": "1s"
    },
    "name": "string",
    "description": "string",
    "created_by_user_id": "string",
    "shift_instances": [
      {
        "start_datetime": "1s",
        "schedule_type": "DRAFT",
        "shift_template": {
          "datetime_set_to_inactive": "1s",
          "name": "string",
          "description": "string",
          "is_tourshift": true,
          "min_shift_width": 0,
          "max_shift_width": 0,
          "min_agents": 0,
          "max_agents": 0,
          "shift_start_boundary_minutes": 0,
          "same_time_each_DOW": true,
          "same_length_per_agent": true,
          "member_placement_rules": [
            {
              "member_scheduling_activity": {
                "activity_sid": "string",
                "member_non_skill_activity": {
                  "datetime_set_to_inactive": "1s",
                  "inherited_from_entity": {
                    "parent_type": "CALL_CENTER_NODE",
                    "parent_sid": 0
                  },
                  "name": "string",
                  "description": "string",
                  "red": 0,
                  "green": 0,
                  "blue": 0,
                  "transparency": 0,
                  "non_skill_activity_sid": 0
                },
                "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                "is_skill_activity": true,
                "reason_codes": [
                  {
                    "datetime_set_to_inactive": "1s",
                    "name": "string",
                    "is_planned": true,
                    "is_paid": true,
                    "is_default": true,
                    "reason_code_id": 0,
                    "scheduling_activity_sid": 0
                  }
                ],
                "scheduling_activity_sid": 0,
                "pause_codes": [
                  "string"
                ]
              },
              "activity_order": 0,
              "min_duration_minutes": 0,
              "max_duration_minutes": 0,
              "placement_rule_sid": 0,
              "shift_template_sid": 0,
              "scheduling_activity_sid": 0,
              "schedule_scenario_sid": 0
            }
          ],
          "DOW_placements": [
            {
              "placement_type": "MUST_NOT",
              "day_of_week": "MON",
              "start_minute": 0,
              "end_minute": 0,
              "week_number": 0
            }
          ],
          "member_agent_groups": [
            {
              "parent_entity": {
                "parent_type": "CALL_CENTER_NODE",
                "parent_sid": 0
              },
              "datetime_set_to_inactive": "1s",
              "name": "string",
              "description": "string",
              "member_constraint_rules": [
                {
                  "scheduling_activity": {
                    "activity_sid": "string",
                    "member_non_skill_activity": {
                      "datetime_set_to_inactive": "1s",
                      "inherited_from_entity": {
                        "parent_type": "CALL_CENTER_NODE",
                        "parent_sid": 0
                      },
                      "name": "string",
                      "description": "string",
                      "red": 0,
                      "green": 0,
                      "blue": 0,
                      "transparency": 0,
                      "non_skill_activity_sid": 0
                    },
                    "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                    "is_skill_activity": true,
                    "reason_codes": [
                      {
                        "datetime_set_to_inactive": "1s",
                        "name": "string",
                        "is_planned": true,
                        "is_paid": true,
                        "is_default": true,
                        "reason_code_id": 0,
                        "scheduling_activity_sid": 0
                      }
                    ],
                    "scheduling_activity_sid": 0,
                    "pause_codes": [
                      "string"
                    ]
                  }
                }
              ],
              "member_wfm_agents": [
                {
                  "tcn_agent_sid": "string",
                  "datetime_set_to_inactive": "1s",
                  "created_at": "1s",
                  "name": "string",
                  "member_constraint_rules": [
                    {
                      "scheduling_activity": {
                        "activity_sid": "string",
                        "member_non_skill_activity": {
                          "datetime_set_to_inactive": "1s",
                          "inherited_from_entity": {
                            "parent_type": "CALL_CENTER_NODE",
                            "parent_sid": 0
                          },
                          "name": "string",
                          "description": "string",
                          "red": 0,
                          "green": 0,
                          "blue": 0,
                          "transparency": 0,
                          "non_skill_activity_sid": 0
                        },
                        "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                        "is_skill_activity": true,
                        "reason_codes": [
                          {
                            "datetime_set_to_inactive": "1s",
                            "name": "string",
                            "is_planned": true,
                            "is_paid": true,
                            "is_default": true,
                            "reason_code_id": 0,
                            "scheduling_activity_sid": 0
                          }
                        ],
                        "scheduling_activity_sid": 0,
                        "pause_codes": [
                          "string"
                        ]
                      }
                    }
                  ],
                  "member_skill_proficiencies": [
                    {
                      "preferred_skill_profile_sid": "string",
                      "parent_entity": {
                        "parent_type": "CALL_CENTER_NODE",
                        "parent_sid": 0
                      },
                      "manual_proficiency_value": 0,
                      "skill_name": "string",
                      "skill_profile_name": "string",
                      "skill_profile_proficiency_value": 0,
                      "skill_proficiency_sid": 0,
                      "skill_sid": 0
                    }
                  ],
                  "member_agent_availability_patterns": [
                    {
                      "parent_entity": {
                        "parent_type": "CALL_CENTER_NODE",
                        "parent_sid": 0
                      },
                      "datetime_pattern": {
                        "week_maps": [
                          {
                            "datetime_range": {},
                            "day_maps": [
                              null
                            ]
                          }
                        ],
                        "calendar_items": [
                          {
                            "datetime_range": {},
                            "value": {}
                          }
                        ]
                      },
                      "scheduling_activity_sid": "string",
                      "agent_availability_pattern_sid": 0,
                      "schedule_scenario_sid": 0
                    }
                  ],
                  "tcn_agent_is_enabled": true,
                  "wfm_agent_sid": 0
                }
              ],
              "member_skill_proficiencies": [
                {
                  "preferred_skill_profile_sid": "string",
                  "parent_entity": {
                    "parent_type": "CALL_CENTER_NODE",
                    "parent_sid": 0
                  },
                  "manual_proficiency_value": 0,
                  "skill_name": "string",
                  "skill_profile_name": "string",
                  "skill_profile_proficiency_value": 0,
                  "skill_proficiency_sid": 0,
                  "skill_sid": 0
                }
              ],
              "member_agent_availability_patterns": [
                {
                  "parent_entity": {
                    "parent_type": "CALL_CENTER_NODE",
                    "parent_sid": 0
                  },
                  "datetime_pattern": {
                    "week_maps": [
                      {
                        "datetime_range": {
                          "start_datetime": "1s",
                          "end_datetime": "1s"
                        },
                        "day_maps": [
                          {
                            "day_of_week": "MON",
                            "value": {},
                            "start_minute_in_day": 0,
                            "end_minute_in_day": 0
                          }
                        ]
                      }
                    ],
                    "calendar_items": [
                      {
                        "datetime_range": {
                          "start_datetime": "1s",
                          "end_datetime": "1s"
                        },
                        "value": {
                          "availability_option": "AVAILABLE"
                        }
                      }
                    ]
                  },
                  "scheduling_activity_sid": "string",
                  "agent_availability_pattern_sid": 0,
                  "schedule_scenario_sid": 0
                }
              ],
              "agent_group_sid": 0,
              "schedule_scenario_sid": 0
            }
          ],
          "shift_template_sid": 0,
          "program_node_sid": 0,
          "schedule_scenario_sid": 0
        },
        "is_locked": true,
        "width_in_minutes": 0,
        "shift_segments": [
          {
            "scheduling_activity": {
              "activity_sid": "string",
              "member_non_skill_activity": {
                "datetime_set_to_inactive": "1s",
                "inherited_from_entity": {
                  "parent_type": "CALL_CENTER_NODE",
                  "parent_sid": 0
                },
                "name": "string",
                "description": "string",
                "red": 0,
                "green": 0,
                "blue": 0,
                "transparency": 0,
                "non_skill_activity_sid": 0
              },
              "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
              "is_skill_activity": true,
              "reason_codes": [
                {
                  "datetime_set_to_inactive": "1s",
                  "name": "string",
                  "is_planned": true,
                  "is_paid": true,
                  "is_default": true,
                  "reason_code_id": 0,
                  "scheduling_activity_sid": 0
                }
              ],
              "scheduling_activity_sid": 0,
              "pause_codes": [
                "string"
              ]
            },
            "order_in_shift_instance": 0,
            "width_in_minutes": 0,
            "start_minute_in_shift": 0,
            "call_stats_by_skill_collection": [
              {
                "skill_collection": {
                  "skill_profile_category_type": "SINGLE_SKILL_PROFILE",
                  "skill_profile_category_sid": 0
                },
                "num_calls": 0,
                "percent_fit": 0
              }
            ],
            "shift_segment_sid": 0,
            "shift_instance_sid": 0,
            "scheduling_activity_sid": 0,
            "reason_code_id": 0
          }
        ],
        "planned_shrinkage_percent": 0,
        "shift_instance_sid": 0,
        "shift_template_sid": 0,
        "originating_program_node_sid": 0,
        "schedule_sid": 0,
        "wfm_agent_sid": 0
      }
    ],
    "performance_metrics": [
      {
        "date_range": {
          "start_datetime": "1s",
          "end_datetime": "1s"
        },
        "metric_type": "FTE_REQUIRED_VS_ACHIEVED_SIMPLE",
        "total_calls_required": 0,
        "total_ftes_achieved": 0,
        "num_intervals_with_required_calls": 0,
        "num_intervals_with_ftes_but_no_schedules": 0,
        "num_intervals_with_ftes_but_no_forecasted_calls": 0,
        "total_unscheduled_calls": 0,
        "total_unnecessary_ftes": 0,
        "interval_width_in_minutes": 0,
        "fte_intervals": [
          {
            "start_datetime": "1s",
            "required_calls": 0,
            "achieved_ftes": 0
          }
        ],
        "service_level_intervals": [
          {
            "start_datetime": "1s",
            "service_level_achieved": 0
          }
        ],
        "metrics_by_skill_collection": [
          {
            "date_range": {
              "start_datetime": "1s",
              "end_datetime": "1s"
            },
            "metric_type": "FTE_REQUIRED_VS_ACHIEVED_SIMPLE",
            "skill_collection": {
              "skill_profile_category_type": "SINGLE_SKILL_PROFILE",
              "skill_profile_category_sid": 0
            },
            "total_calls_required": 0,
            "total_ftes_achieved": 0,
            "num_intervals_with_required_calls": 0,
            "num_intervals_with_ftes_but_no_schedules": 0,
            "num_intervals_with_ftes_but_no_forecasted_calls": 0,
            "total_unscheduled_calls": 0,
            "total_unnecessary_ftes": 0,
            "interval_width_in_minutes": 0,
            "fte_intervals": [
              {
                "start_datetime": "1s",
                "required_calls": 0,
                "achieved_ftes": 0
              }
            ],
            "service_level_intervals": [
              {
                "start_datetime": "1s",
                "service_level_achieved": 0
              }
            ]
          }
        ]
      }
    ],
    "performance_metrics_v2": [
      {
        "date_range": {
          "start_datetime": "1s",
          "end_datetime": "1s"
        },
        "metric_type": "FTE_REQUIRED_VS_ACHIEVED_SIMPLE",
        "total_fte_intervals_required": 0,
        "total_fte_intervals_achieved": 0,
        "num_intervals_with_call_ftes": 0,
        "num_intervals_with_shift_ftes": 0,
        "num_intervals_with_call_ftes_but_no_shifts": 0,
        "num_intervals_with_shifts_but_no_call_ftes": 0,
        "total_underscheduled_call_ftes": 0,
        "total_overscheduled_call_ftes": 0,
        "interval_width_in_minutes": 0,
        "fte_occupancy_intervals": [
          {
            "start_datetime": "1s",
            "required_fte_occupancy": 0,
            "achieved_fte_occupancy": 0,
            "required_fte": 0,
            "achieved_fte": 0,
            "productive_fte": 0,
            "achieved_fte_with_shrinkage_applied": 0,
            "productive_fte_with_shrinkage_applied": 0
          }
        ],
        "service_level_intervals": [
          {
            "start_datetime": "1s",
            "service_level_achieved": 0
          }
        ],
        "metrics_by_skill_collection": [
          {
            "date_range": {
              "start_datetime": "1s",
              "end_datetime": "1s"
            },
            "metric_type": "FTE_REQUIRED_VS_ACHIEVED_SIMPLE",
            "skill_collection": {
              "skill_profile_category_type": "SINGLE_SKILL_PROFILE",
              "skill_profile_category_sid": 0
            },
            "total_fte_intervals_required": 0,
            "total_fte_intervals_achieved": 0,
            "num_intervals_with_call_ftes": 0,
            "num_intervals_with_shift_ftes": 0,
            "num_intervals_with_call_ftes_but_no_shifts": 0,
            "num_intervals_with_shifts_but_no_call_ftes": 0,
            "total_underscheduled_call_ftes": 0,
            "total_overscheduled_call_ftes": 0,
            "interval_width_in_minutes": 0,
            "fte_occupancy_intervals": [
              {
                "start_datetime": "1s",
                "required_fte_occupancy": 0,
                "achieved_fte_occupancy": 0,
                "required_fte": 0,
                "achieved_fte": 0,
                "productive_fte": 0,
                "achieved_fte_with_shrinkage_applied": 0,
                "productive_fte_with_shrinkage_applied": 0
              }
            ],
            "service_level_intervals": [
              {
                "start_datetime": "1s",
                "service_level_achieved": 0
              }
            ],
            "total_required_fte": 0,
            "total_achieved_fte": 0,
            "total_productive_fte": 0,
            "total_achieved_fte_with_shrinkage_applied": 0,
            "total_productive_fte_with_shrinkage_applied": 0
          }
        ],
        "total_required_fte": 0,
        "total_achieved_fte": 0,
        "total_productive_fte": 0,
        "total_achieved_fte_with_shrinkage_applied": 0,
        "total_productive_fte_with_shrinkage_applied": 0
      }
    ],
    "draft_schedule_sid": 0,
    "schedule_scenario_sid": 0
  },
  "scheduling_result_metric": {
    "total_internal_intervals": 0,
    "total_intervals_with_fte_required": 0,
    "total_intervals_with_ftes_remaining": 0,
    "coverage": 0,
    "root_mean_square": 0,
    "has_result": true,
    "metrics_by_skill_collection": [
      {
        "skill_collection": {
          "skill_profile_category_type": "SINGLE_SKILL_PROFILE",
          "skill_profile_category_sid": 0
        },
        "total_internal_intervals": 0,
        "total_intervals_with_fte_required": 0,
        "total_intervals_with_ftes_remaining": 0,
        "coverage": 0,
        "root_mean_square": 0,
        "has_result": true
      }
    ]
  },
  "diagnostics": [
    {
      "level": "INFORMATION",
      "code": "GENERAL",
      "source_entity": {
        "parent_type": "CALL_CENTER_NODE",
        "parent_sid": 0
      },
      "message": "string"
    }
  ]
}
🔴500Server Error
Previous
UpdateDraftSchedule
Next
PollBuildInProgress
Built with