TCN API
  1. Org
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
        POST
      • ConvertOrgToManual
        POST
      • UpdateOrganization
        POST
      • ArchiveOrganization
        POST
      • UnArchiveOrganization
        POST
      • ListArchivedOrganizations
        POST
      • GetOrganizationProfile
        POST
      • GetOrganizationProfileById
        POST
      • ListOrganizationDescriptions
        POST
      • ListRegionalOrganizations
        POST
      • UpdateP3OwningOrg
        POST
      • GetP3OwningOrg
        POST
      • ListOrganizationUserDescriptions
        POST
      • AdminListUserDescriptions
        POST
      • ListUserDescriptions
        POST
      • GetUserDirectory
        POST
      • GetRegions
        POST
      • GetMyUserDetails
        POST
      • GetUserDetails
        POST
      • AdminGetUserDetails
        POST
      • GetAgentUsers
        POST
      • GetAgentSettings
        POST
      • GetAgentProfileGroup
        POST
      • UpdateAgentProfileGroup
        POST
      • CreateAgentProfileGroup
        POST
      • ListAgentProfileGroups
        POST
      • DeleteAgentProfileGroup
        POST
      • AssignAgentProfileGroups
        POST
      • UpdateUser
        POST
      • UpdateMyUser
        POST
      • UpdateUserCallerId
        POST
      • CreateUser
        POST
      • CreateUserByOrgId
        POST
      • CreateDelegatedUser
        POST
      • UpdateUserPassword
        POST
      • UpdateMyUserPassword
        POST
      • UpdateUserPasswordByOrgId
        POST
      • ResetUserRequirePasswordReset
        POST
      • GetUserPasswordResetLink
        POST
      • GetMyUserPasswordResetLink
        POST
      • GetUserPasswordResetLinkByOrgId
        POST
      • GetUserEmailVerified
        POST
      • GetUserEmailVerifiedByOrgId
        POST
      • SendUserVerificationEmailByOrgId
        POST
      • SendUserVerificationEmail
        POST
      • ManualUserEmailVerificationByOrgId
        POST
      • ManualUserEmailVerification
        POST
      • GetTempUserToken
        POST
      • GetTempUserTokenByUserId
        POST
      • GetCountriesList
        POST
      • GetAdminClientPreferences
        POST
      • UpdateAdminClientPreferences
        POST
      • GetPermissions
        POST
      • RevokeAccountOwnerPermissionFromUser
        POST
      • UpdateUserDisabled
        POST
      • UpdateUserDisabledByOrgId
        POST
      • UpdateBulkUsersDisabled
        POST
      • GetOrgBillingSettingsByOrgId
        POST
      • GetOrgBillingSettings
        POST
      • SetOrgBillingSettings
        POST
      • AddOrgBillingOverride
        POST
      • RemoveOrgBillingOverride
        POST
      • GetSystemDefaultBillingRates
        POST
      • ListPermissionGroupsByOrgId
        POST
      • ListPermissionGroups
        POST
      • CreatePermissionGroup
        POST
      • UpdatePermissionGroup
        POST
      • DeletePermissionGroup
        POST
      • AssignUserToAccountOwnerPermissionGroup
        POST
      • AssignUserPermissionGroup
        POST
      • AssignUsersPermissionGroup
        POST
      • UpdateUserNeoPermissionGroups
        POST
      • RevokeUserPermissionGroup
        POST
      • RevokeUsersPermissionGroup
        POST
      • InitDefaultPermissionGroups
        POST
      • AddPermissionToAccountOwnerPermissionGroup
        POST
      • RevokePermissionToAccountOwnerPermissionGroup
        POST
      • AddPermissionToOrgDefaultGroup
        POST
      • RemovePermissionFromOrgDefaultGroup
        POST
      • GetOrgDefaultSuperUserGroup
        POST
      • ListP3PermissionGroupsByOrgId
        POST
      • ListP3PermissionGroups
        POST
      • AddUserRegion
        POST
      • RemoveUserRegion
        POST
      • CreateP3PermissionGroup
        POST
      • UpdateP3PermissionGroupByOrgId
        POST
      • UpdateP3PermissionGroup
        POST
      • DeleteP3PermissionGroup
        POST
      • AssignUsersP3PermissionGroup
        POST
      • AddLoginToUser
        POST
      • RevokeUsersP3PermissionGroup
        POST
      • GetContactPreferences
        POST
      • UpdateContactPreferences
        POST
      • GetCompliancePreferences
        POST
      • UpdateCompliancePreferences
        POST
      • GetAgentPreferences
        POST
      • UpdateAgentPreferences
        POST
      • GetOrganizationPreferences
        POST
      • UpdateOrganizationPreferences
        POST
      • GetSchedulePreferences
        POST
      • UpdateSchedulePreferences
        POST
      • GetBusinessPreferences
        POST
      • UpdateBusinessPreferences
        POST
      • GetEndOfDayPreferences
        POST
      • UpdateEndOfDayPreferences
        POST
      • GetReportFilterPreferences
        POST
      • UpdateReportFilterPreferences
        POST
      • GetPhonePreferences
        POST
      • UpdatePhonePreferences
        POST
      • GetDashboardGeneralPreferences
        POST
      • UpdateDashboardGeneralPreferences
        POST
      • GetWebhookPreferences
        POST
      • UpdateWebhookPreferences
        POST
      • GetBroadcastPreferences
        POST
      • UpdateBroadcastPreferences
        POST
      • GetAuthenticationPreferences
        POST
      • UpdateAuthenticationPreferences
        POST
      • GetRecordingPreferences
        POST
      • UpdateRecordingPreferences
        POST
      • GetDashboardQueuePreferences
        POST
      • UpdateDashboardQueuePreferences
        POST
      • GetAgentQuickViewPreferences
        POST
      • GetVoiceAnalyticsPreferences
        POST
      • UpdateVoiceAnalyticsPreferences
        POST
      • UpdateVoiceAnalyticsPreferencesEnabled
        POST
      • GetScorecardsPreferences
        POST
      • UpdateScorecardsPreferences
        POST
      • GetEmailSmsPreferences
        POST
      • UpdateEmailSmsPreferences
        POST
      • EditAgentQuickViewPreferences
        POST
      • EditBackofficeThemePreference
        POST
      • GetBackofficeThemePreference
        POST
      • AcceptLinkbackRecordingTerms
        POST
      • LinkbackUpdateBroadcastTemplates
        POST
      • RecordEmailUnsubscribeAcknowledgement
        POST
      • ClearEmailUnsubscribeAcknowledgement
        POST
      • CreateWebLinkTemplate
        POST
      • ListWebLinkTemplates
        POST
      • GetWebLinkTemplate
        POST
      • UpdateWebLinkTemplate
        POST
      • DeleteWebLinkTemplate
        POST
      • CreateAgentTriggerTemplate
        POST
      • ListAgentTriggerTemplates
        POST
      • GetAgentTriggerTemplate
        POST
      • UpdateAgentTriggerTemplate
        POST
      • DeleteAgentTriggerTemplate
        POST
      • CreateClientInfoDisplayTemplate
        POST
      • ListClientInfoDisplayTemplates
        POST
      • UpdateClientInfoDisplayTemplate
        POST
      • DeleteClientInfoDisplayTemplate
        POST
      • GetClientInfoDisplayTemplate
        POST
      • ListAgentPauseCodes
        POST
      • CreateAgentPauseCode
        POST
      • UpdateAgentPauseCode
        POST
      • DeleteAgentPauseCode
        POST
      • ListCustomReportFilters
        POST
      • CreateCustomReportFilter
        POST
      • UpdateCustomReportFilter
        POST
      • DeleteCustomReportFilter
        POST
      • ListAgentResponseGroups
        POST
      • ListLastTemplateElements
        POST
      • ListQueueConfigsByOrgId
        POST
      • DeleteQueueConfig
        POST
      • GetQueueConfig
        POST
      • CreateQueueConfig
        POST
      • UpdateQueueConfig
        POST
      • CopyQueueConfig
        POST
      • GetAllQueueConfigSounds
        POST
      • GetQueueConfigSound
        POST
      • SetQueueConfigSound
        POST
      • SetAllQueueConfigSoundsFromSource
        POST
      • GetUserBlocked
        POST
      • UnblockUser
        POST
      • ListP3UnMigratedUsers
        POST
      • MigrateP3User
        POST
      • UpdateP3UserName
        POST
      • ListOwnedUsers
        POST
      • ListOwnedOrgsByOrgId
        POST
      • ListOwnedOrgs
        POST
      • RemoveLoginStrikes
        POST
      • RemoveUserLoginStrikes
        POST
      • ListLoginHistory
        POST
      • UpdateP3UserSids
        POST
      • CreateAuthConnection
        POST
      • GetAuthConnectionSettings
        POST
      • UpdateAuthConnectionSettings
        POST
      • DeleteAuthConnection
        POST
      • GetUserSubscription
        POST
      • GetMyUserSubscription
        POST
      • AddUserSubscription
        POST
      • AddMyUserSubscription
        POST
      • RemoveUserSubscription
        POST
      • RemoveMyUserSubscription
        POST
      • UpdateUserSubscription
        POST
      • UpdateMyUserSubscription
        POST
      • ListUserSubscriptions
        POST
      • ListMyUserSubscriptions
        POST
      • ListOrgSubscriptions
        POST
      • GetSystemEnvironmentDetails
        POST
      • ListAgentStatisticsTemplates
        POST
      • CreateAgentStatisticsTemplate
        POST
      • UpdateAgentStatisticsTemplate
        POST
      • DeleteAgentStatisticsTemplate
        POST
      • CreateOrganization
        POST
      • GetOrganization
        POST
      • GetOrganizationById
        POST
      • UpdateOrganization
        POST
      • ArchiveOrganization
        POST
      • UnArchiveOrganization
        POST
      • ListAllOrganizationsGlobally
        POST
      • ListOrganizationsByRegion
        POST
      • ListArchivedOrganizations
        POST
      • ConvertOrgToManual
        POST
      • ListOwnedOrgs
        POST
      • GetOrganizationPreferences
        POST
      • UpdateOrganizationPreferences
        POST
      • GetAgentPreferences
        POST
      • UpdateAgentPreferences
        POST
      • GetContactPreferences
        POST
      • UpdateContactPreferences
        POST
      • GetAuthenticationPreferences
        POST
      • UpdateAuthenticationPreferences
        POST
      • GetWebhookPreferences
        POST
      • UpdateWebhookPreferences
        POST
      • GetDashboardGeneralPreferences
        POST
      • UpdateDashboardGeneralPreferences
        POST
      • GetDashboardQueuePreferences
        POST
      • UpdateDashboardQueuePreferences
        POST
      • GetPhonePreferences
        POST
      • UpdatePhonePreferences
        POST
      • GetCompliancePreferences
        POST
      • UpdateCompliancePreferences
        POST
      • GetBroadcastPreferences
        POST
      • UpdateBroadcastPreferences
        POST
      • GetSchedulePreferences
        POST
      • UpdateSchedulePreferences
        POST
      • GetEmailSmsPreferences
        POST
      • UpdateEmailSmsPreferences
        POST
      • GetBusinessPreferences
        POST
      • UpdateBusinessPreferences
        POST
      • UpdateAdminBusinessPreferences
        POST
      • GetScorecardsPreferences
        POST
      • UpdateScorecardsPreferences
        POST
      • GetVoiceAnalyticsPreferences
        POST
      • ListVoiceAnalyticsPreferences
        POST
      • UpdateVoiceAnalyticsPreferences
        POST
      • GetEndOfDayPreferences
        POST
      • UpdateEndOfDayPreferences
        POST
      • GetReportFilterPreferences
        POST
      • UpdateReportFilterPreferences
        POST
      • GetRecordingPreferences
        POST
      • UpdateRecordingPreferences
        POST
      • GetAdminClientPreferences
        POST
      • UpdateAdminClientPreferences
        POST
      • AcceptLinkbackRecordingTerms
        POST
      • LinkbackUpdateBroadcastTemplates
        POST
      • RecordEmailUnsubscribeAcknowledgement
        POST
      • ClearEmailUnsubscribeAcknowledgement
        POST
      • ListBusinessHours
        POST
      • GetBusinessHours
        POST
      • SetBusinessHours
        POST
      • AddIntervalToBusinessHours
        POST
      • RemoveIntervalFromBusinessHours
        POST
      • UpdateBusinessHoursInfo
        POST
      • DeleteBusinessHours
        POST
      • EvaluateBusinessHours
        POST
      • CreateUser
        POST
      • CreateDelegatedUser
        POST
      • GetMyUser
        POST
      • GetUser
        POST
      • GetUserByOrgId
        POST
      • ListAgents
        POST
      • ListPublicUsers
        POST
      • ListUsers
        POST
      • ListUsersByOrgId
        POST
      • ListUsersByRegion
        POST
      • UpdateMyUser
        POST
      • UpdateUser
        POST
      • UpdateUserLabels
        POST
      • UpdateUserCallerId
        POST
      • UpdateUserDisabled
        POST
      • UpdateUserDisabledByOrgId
        POST
      • GetMyUserPasswordResetLink
        POST
      • GetUserPasswordResetLink
        POST
      • GetUserPasswordResetLinkByOrgId
        POST
      • CreatePasswordResetLink
        POST
      • CreatePasswordResetLinkByOrgId
        POST
      • GetUserLoginInfo
        POST
      • GetUserEmailVerified
        POST
      • GetUserEmailVerifiedByOrgId
        POST
      • ResetMyPassword
        POST
      • ResetUserPassword
        POST
      • ResetUserPasswordByOrgId
        POST
      • SendUserEmailVerification
        POST
      • SendUserEmailVerificationByOrgId
        POST
      • SendPasswordReset
        POST
      • SendPasswordResetByOrgId
        POST
      • GetUserSessionData
        POST
      • GetAgentProfileGroup
        POST
      • ListAgentProfileGroups
        POST
      • UpdateAgentProfileGroup
        POST
      • CreateAgentProfileGroup
        POST
      • DeleteAgentProfileGroup
        POST
      • AssignAgentProfileGroups
        POST
      • AddUserSubscription
        POST
      • AddUserSubscriptionByUserId
        POST
      • GetUserSubscription
        POST
      • GetUserSubscriptionByUserId
        POST
      • UpdateUserSubscription
        POST
      • UpdateUserSubscriptionByUserId
        POST
      • RemoveUserSubscription
        POST
      • RemoveUserSubscriptionByUserId
        POST
      • ListUserSubscriptions
        POST
      • ListUserSubscriptionsByUserId
        POST
      • ListOrgSubscriptions
        POST
      • CreateAuthToken
        POST
      • CreateAuthTokenByUserId
        POST
      • ListAuthTokens
        POST
      • ListAuthTokensByUserId
        POST
      • SetAuthTokenExpiration
        POST
      • SetAuthTokenExpirationByUserId
        POST
      • DeleteAuthToken
        POST
      • DeleteAuthTokenByUserId
        POST
      • GetHuntGroupSettings
        POST
      • UpdateHuntGroupSettings
        POST
      • CreateHuntGroup
        POST
      • UpdateHuntGroupGeneralDetails
        POST
      • DeleteHuntGroup
        POST
      • GetHuntGroupDetails
        POST
      • ListCallerIdBuckets
        POST
      • GetDataDipTemplate
        POST
      • ListDataDipTemplates
        POST
      • CreateDataDipTemplate
        POST
      • UpdateDataDipTemplate
        POST
      • DeleteDataDipTemplate
        POST
      • CopyDataDipTemplate
        POST
      • CopyDataDipTemplateToOrganization
        POST
      • ListBroadcastTemplateGeneralDetails
        POST
      • ListAgentResponseAutoRules
        POST
      • CreateAgentResponseAutoRules
        POST
      • UpdateAgentResponseAutoRules
        POST
      • DeleteAgentResponseAutoRules
        POST
      • ListHuntGroupWebLinks
        POST
      • CopyHuntGroupWebLink
        POST
      • UpdateHuntGroupWebLinks
        POST
      • ListHuntGroupIntegrationLinks
        POST
      • CopyHuntGroupIntegrationLink
        POST
      • UpdateHuntGroupIntegrationLinks
        POST
      • GetHuntGroupClientInfoDisplayTemplate
        POST
      • CreateHuntGroupClientInfoDisplayTemplate
        POST
      • UpdateHuntGroupClientInfoDisplayTemplate
        POST
      • DeleteHuntGroupClientInfoDisplayTemplate
        POST
      • CopyHuntGroupClientInfoDisplayTemplate
        POST
      • CreateCampaignClientInfoDisplayTemplate
        POST
      • ListHuntGroupsWithClientInfoTemplateData
        POST
      • ListAgentTriggers
        POST
      • CopyAgentTrigger
        POST
      • UpdateAgentTriggers
        POST
      • ListHuntGroupScripts
        POST
      • ListOrgHuntGroupScripts
        POST
      • GetHuntGroupScript
        POST
      • CreateHuntGroupScript
        POST
      • UpdateHuntGroupScript
        POST
      • DeleteHuntGroupScript
        POST
      • AssignScriptToHuntGroups
        POST
      • UnassignScriptFromHuntGroups
        POST
      • CreateTrust
        POST
      • AcceptTrust
        POST
      • RejectTrust
        POST
      • GetTrust
        POST
      • ListIncomingTrusts
        POST
      • ListGivenTrusts
        POST
      • ListAssignableTrusts
        POST
      • DeleteTrust
        POST
      • AssignTrust
        POST
      • UnassignTrust
        POST
      • CreateLabel
        POST
      • DeleteLabel
        POST
      • ListLabels
        POST
      • GetLabel
        POST
      • UpdateLabel
        POST
      • AssignLabel
        POST
      • UnassignLabel
        POST
      • GetAssignmentCounts
        POST
      • GetAssignableLabels
        POST
      • GetPermissions
        POST
      • GetUserPermissions
        POST
      • CreatePermissionGroup
        POST
      • UpdatePermissionGroup
        POST
      • DeletePermissionGroup
        POST
      • ListPermissionGroups
        POST
      • ListPermissionGroupsByOrgId
        POST
      • AssignUsersPermissionGroup
        POST
      • RevokeUsersPermissionGroup
        POST
      • AssignLabels
        POST
      • RevokeLabels
        POST
      • AssignAccountOwnerPermissionToUser
        POST
      • RevokeAccountOwnerPermissionFromUser
        POST
      • InitDefaultPermissionGroups
        POST
      • GetAccountOwnerGroup
        POST
      • GetLicenses
        POST
      • GetOrgLicenses
        POST
      • UpdateLicenses
        POST
      • RemovePermissionFromAllPermissionGroups
        POST
      • ListP3PermissionGroups
        POST
      • ListP3PermissionGroupsByOrgId
        POST
      • CreateP3PermissionGroup
        POST
      • UpdateP3PermissionGroup
        POST
      • UpdateP3PermissionGroupByOrgId
        POST
      • DeleteP3PermissionGroup
        POST
      • AssignUsersP3PermissionGroup
        POST
      • RevokeUsersP3PermissionGroup
        POST
      • RefreshMfaLockout
        POST
      • RefreshMfaLockoutByOrgId
        POST
      • SetMfaType
        POST
      • SetMyMfaType
        POST
      • EnableUserMfa
        POST
      • EnableMyUserMfa
        POST
      • GetUserMfaInfo
        POST
      • GetMyUserMfaInfo
        POST
      • GetMyAllowedMfaMethods
        POST
      • GenerateTOTPSecret
        POST
      • VerifyTOTPCode
        POST
      • CreateBusinessHours
        POST
      • UpdateBusinessHours
        POST
      • CreateCertificateInfo
        POST
      • DeleteCertificateInfo
        POST
      • RevokeCertificateInfo
        POST
      • ListCertificateInfo
        POST
      • AddGroupedUserIPRestrictions
        POST
      • RemoveGroupedUserIPRestrictions
        POST
      • ListUsersAllowedIps
        POST
      • ListResponseEvaluators
        POST
      • GetResponseEvaluator
        POST
      • CreateResponseEvaluator
        POST
      • UpdateResponseEvaluator
        POST
      • DeleteResponseEvaluator
        POST
    • 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
      • CreateInitialDemoActivities
      • ListSkillProfiles
      • UpdateSkillProfile
      • UpdateSkillProfileProficiencies
      • GetSkillProfile
      • ResyncSkillProfiles
      • GetLastSkillProfileResyncDate
      • UpsertForecastingParameters
      • GetForecastingParameters
      • GetClientHistoryCacheInfo
      • ListHistoricalData
      • UpsertHistoricalDataDelta
      • UpsertHistoricalDataDeltas
      • ListSkills
      • BuildCallProfileTemplateForSkillProfile
      • BuildCallProfileTemplate
      • CreateInactiveSkillProfileMapping
      • GetAvailableRegressionForecasterModelTypes
      • DisconnectInactiveSkillProfileMapping
      • CreateSkillProfileGroup
      • UpdateSkillProfileGroup
      • ListSkillProfileGroups
      • UpdateSkillProfileGroupAssociations
      • DeleteHistoricalDataDeltas
      • ListTopSkillProfiles
      • GetSkillProfilesCount
      • BuildProfileForecastByInterval
      • BuildProfileForecastByIntervalWithStats
      • UpsertProfileForecast
      • CreateCallProfileTemplate
      • DeleteCallProfileTemplate
      • CreateRegressionTemplate
      • DeleteRegressionTemplate
      • ListRegressionTemplates
      • ListForecastIntervalsForSkillProfile
      • ListForecastIntervals
      • ListForecastIntervalsV2
      • BuildRegressionForecastByInterval
      • BuildRegressionForecastByIntervalWithStats
      • ListCallProfileTemplates
      • UpsertRegressionForecast
      • UpsertForecastDataDelta
      • UpsertForecastDataDeltas
      • DeleteForecastIntervals
      • ListHistoricalDataForAllSkillProfiles
      • BuildDOWAndMOYProfiles
      • CalculateTrainingDataAveragesForSkillProfile
      • UpdateSkillProfileAveragesUsingHistoricalData
      • UpdateCallCenterNode
      • CreateClientNode
      • UpdateClientNode
      • CreateLocationNode
      • UpdateLocationNode
      • CreateProgramNode
      • UpdateProgramNode
      • ListProgramNodesBySid
      • CreateConstraintRule
      • UpdateConstraintRule
      • DeleteConstraintRule
      • CreateNonSkillActivity
      • UpdateNonSkillActivity
      • ListNonSkillActivities
      • ListNonSkillActivityAssociations
      • ListCandidateSchedulingActivities
      • ListSchedulingActivities
      • GetOnCallSchedulingActivity
      • CreateSchedulingActivityPauseCodes
      • DeleteSchedulingActivityPauseCodes
      • ListPatternsForSchedulingActivityClassifications
      • GetTimeOffSchedulingActivity
      • CreateAgentGroup
      • ListAgentScheduleGroups
      • UpdateAgentGroup
      • CreateUnassignedWFMAgent
      • UpdateWFMAgent
      • ListAllWFMAgents
      • ListCandidateWFMAgents
      • ListUngroupedWFMAgents
      • ListWFMAgentSids
      • ListUnassignedWFMAgents
      • ListWFMAgentsAssociatedWithAgentGroup
      • CreateWFMAgentMemberships
      • CopyWFMAgentMemberships
      • DeleteWFMAgentMemberships
      • DeleteWFMAgentsMemberships
      • RemoveAgentFromFutureShifts
      • BuildAgentDiagnostics
      • CreateShiftTemplate
      • UpdateShiftTemplate
      • ListShiftTemplatesBySids
      • BuildShiftTemplateDiagnostics
      • CreatePlacementRule
      • UpdatePlacementRule
      • DeletePlacementRule
      • CreateOpenTimesPattern
      • UpdateOpenTimesPattern
      • DeleteOpenTimesPattern
      • GetOpenTimesBitmaps
      • ListOpenDateRangesForNodeOpenTimesBitmaps
      • CreateAgentAvailabilityPattern
      • UpdateAgentAvailabilityPattern
      • DeleteAgentAvailabilityPattern
      • GetAvailabilityBitmaps
      • UpsertNonSkillActivityAssociation
      • CreateSkillProficiencies
      • UpdateSkillProficiencies
      • DeleteSkillProficiency
      • CopyScenario
      • CreateScheduleScenarioWithNodes
      • UpdateScheduleScenario
      • ListConfigEntities
      • CreateReasonCode
      • UpdateReasonCode
      • GetDefaultReasonCode
      • ListReasonCodes
      • DeleteShiftInstances
      • BuildNodeDiagnostics
      • BuildGlobalDiagnostics
      • GetPublishedSchedule
      • GetPublishedScheduleRequiredCalls
      • GetDraftScheduleRequiredCalls
      • CreateDraftSchedule
      • UpdateDraftSchedule
      • BuildDraftSchedule
      • PollBuildInProgress
      • CancelBuildInProgress
      • PublishDraftSchedule
      • ResetDraftSchedule
      • GetDraftSchedule
      • ListDraftSchedules
      • ClearSchedule
      • DeleteDraftSchedule
      • ListShiftInstancesBySid
      • CopyScheduleToSchedule
      • CreateShiftInstance
      • CreateShiftInstanceV2
      • CreateShiftInstanceWithSegments
      • SplitShiftInstance
      • SwapShiftInstances
      • UpdateShiftInstance
      • UpdateShiftInstanceV2
      • UpdateShiftInstanceWithSegments
      • CopyShiftInstancesToSchedule
      • ListShiftInstanceSidsForAgent
      • ListShiftInstanceSidsForSchedule
      • ListShiftSegmentsByShiftInstanceSids
      • SetSchedulingTarget
      • GetSchedulingTarget
      • DeleteSchedulingTarget
      • GetDefaultSchedulingTarget
      • SetDefaultSchedulingTarget
      • GetPerformanceMetrics
      • ListRequiredCallsIntervals
      • CreateTourPattern
      • GetTourPatternDiagnostics
      • UpsertTourPatternWithMembers
      • GetTourPattern
      • GetTourPatternWithMembers
      • DeleteTourPattern
      • CreateTourWeekPattern
      • ListTourWeekPatterns
      • DeleteTourWeekPatterns
      • CreateTourShiftInstanceConfig
      • UpdateTourShiftInstanceConfig
      • ListTourShiftInstanceConfigs
      • DeleteTourShiftInstanceConfigs
      • CreateTourShiftSegmentConfig
      • UpdateTourShiftSegmentConfig
      • ListTourShiftSegmentConfigs
      • DeleteTourShiftSegmentConfigs
      • CreateTourAgentCollection
      • UpdateTourAgentCollection
      • ListTourAgentCollections
      • DeleteTourAgentCollections
      • CreateTourAgentCollectionWFMAgents
      • ListTourAgentCollectionWFMAgents
      • DeleteTourAgentCollectionWFMAgents
      • GenerateTourWeekPatterns
      • ListValidAgentsForReplacement
      • ReplaceAgentOnSchedule
      • ReplaceAgentOnScheduleV1
      • RemoveAgentFromSchedule
      • CreatePublishedShift
      • CreatePublishedShiftWithSegments
      • UpdatePublishedShift
      • UpdatePublishedShiftWithSegments
      • SplitPublishedShift
      • SwapPublishedShifts
      • DeletePublishedShifts
      • ReplaceAgentOnPublishedSchedule
      • RemoveAgentFromPublishedSchedule
      • CopyShiftsToPublishedSchedule
      • CreateAgentLeavePetition
      • ListAgentLeavePetitions
      • ArchiveAgentLeavePetition
      • ResolveAgentLeavePetition
      • CancelAgentLeavePetition
      • HelloWorldWFMAdherence
      • ListAdherenceDiagnostics
      • ListAgentStatesForDay
      • ListRealTimeManagementStates
      • ListAdherenceAgentStates
      • ListAdherenceAgentStateViolations
      • ResolveAdherenceAgentStateViolation
      • UpsertRealTimeManagementStateColor
      • ListRealTimeManagementStateColors
      • DeleteRealTimeManagementStateColor
      • CreateRgbaColor
      • ListRgbaColors
      • UpdateRgbaColor
      • DeleteRgbaColor
      • CreateAdherenceRuleNotificationConfig
      • UpdateAdherenceRuleNotificationConfig
      • CreateAdherenceRuleNotificationConfigEntry
      • UpdateAdherenceRuleNotificationConfigEntry
      • DeleteAdherenceRuleNotificationConfigEntry
      • ListAdherenceRuleNotificationConfigs
      • CreateAdherenceDepartmentalRule
      • UpdateAdherenceDepartmentalRule
      • CreateAdherenceDepartmentalRuleClause
      • UpdateAdherenceDepartmentalRuleClause
      • DeleteAdherenceDepartmentalRuleClause
      • ListAdherenceDepartmentalRules
      • CreateAdherenceAgentRule
      • UpdateAdherenceAgentRule
      • CreateAdherenceAgentRuleClause
      • UpdateAdherenceAgentRuleClause
      • ListAdherenceAgentRules
      • DeleteAdherenceAgentRuleClause
      • AgentGetSchedule
      • AgentListLeavePetitions
      • AgentCreateLeavePetition
      • AgentCancelLeavePetition
      • SetAgentStateSimulationLevelForOrg
    • 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. Org

UpdateHuntGroupSettings

POST
https://api.cbf.tcn.com/api/v1alpha1/org/huntgroup/update
Org
UpdateHuntGroupSettings updates the selected/masked hunt group settings
for the given hunt group.

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 UpdateHuntGroupSettings RPC method.
general_settings
object (GeneralSettings) 
general_settings
optional
Hunt group general settings to be updated.
initial_agent_status
enum<string> 
initial_agent_status
optional
Initial agent status. Initial Agent Status
Allowed values:
INITIAL_AGENT_STATUS_READYINITIAL_AGENT_STATUS_PAUSED
agent_pause_option_set
object (PauseOptionSet) 
agent_pause_option_set
optional
Pause option sets per hunt group. Use Agent Pause Codes
hold_queue_monitoring
object (HoldQueueMonitoring) 
hold_queue_monitoring
optional
Agent hold queue monitoring.
display_data_dipped_data
object (DataDipDataDisplay) 
display_data_dipped_data
optional
Whether to display the Data Dip'ed data in the data panel.
integration_data_display
object (IntegrationDataDisplay) 
integration_data_display
optional
Payment Integration data display
journey_data_display
object (JourneyDataDisplay) 
journey_data_display
optional
Whether to display the Journey Integration returned data in the data panel.
agent_call_history_scope
enum<string> 
agent_call_history_scope
optional
Whether and what call history statistics to display in the UI.
Allowed values:
AGENT_CALL_HISTORY_SCOPE_NONEAGENT_CALL_HISTORY_SCOPE_AGENT_SESSION_STATISTICSAGENT_CALL_HISTORY_SCOPE_TODAYS_STATISTICS
agent_login_gui_statistics_display
object (AgentLoginGuiStatisticsDisplay) 
agent_login_gui_statistics_display
optional
Agent Login Gui Statistics display and template
phone_zip_metadata_display
object (PhoneZipMetadataDisplay) 
phone_zip_metadata_display
optional
Phone / Postal Metadata display
disallowed_hunt_groups
object (DisallowedHuntGroups) 
disallowed_hunt_groups
optional
Limited available hunt groups. Hunt Group Reassignment Disallowed
alphanumeric_keypad
object (AlphanumericKeypad) 
alphanumeric_keypad
optional
Alphanumeric keypad properties. Alphanumeric Keypad
inbound_compliance_metadata
object (InboundComplianceMetadata) 
inbound_compliance_metadata
optional
Inbound natural language compliance metadata.
Optional Inbound Compliance Metadata
Required Inbound Compliance Metadata
prepare_state_call_delivery
object (PrepareStateCallDelivery) 
prepare_state_call_delivery
optional
Enables the delivery of incoming calls to the agent
depending on the dial status prior to them clicking "Dial".
enable_agent_gateway_title_bar
boolean 
enable_agent_gateway_title_bar
optional
Displays browser window tab information. UseAdvancedGatewayTitle
default_agent_dial_in
string 
default_agent_dial_in
optional
Default agent phone number dialing into IVR system. AgentDialInNumber
require_end_call_confirmation
boolean 
require_end_call_confirmation
optional
Requires secondary confirmation to end call. DisconnectConfirmation
enable_authorization_by_ip
boolean 
enable_authorization_by_ip
optional
Enables authorization and whitelist by IP. UseIpBasedAuth
enable_agent_pause
boolean 
enable_agent_pause
optional
Enable agents to pause calls. Allow Agent Pause
default_agent_pause_option
string 
default_agent_pause_option
optional
Default agent pause code. Default Agent Pause Code
enable_pause_option_reset
boolean 
enable_pause_option_reset
optional
Enable agents to switch between pause options. Agent Pause Reset
triggered_pause_status_pause_code_waiting
string 
triggered_pause_status_pause_code_waiting
deprecated
Use this pause code instead of the trigger generated one.
triggered_pause_status_pause_code_wrapup
string 
triggered_pause_status_pause_code_wrapup
deprecated
Use this pause code instead of the trigger generated one.
display_recording_indicator
boolean 
display_recording_indicator
optional
Display recording indicator. Display Recording Indicator
enable_call_recording_pause
boolean 
enable_call_recording_pause
optional
Enable pausing of agent call recording. Enable Recording Pause
call_recording_pause_confirmation
boolean 
call_recording_pause_confirmation
optional
Require call recording pause confirmation. Recording Pause Confirmation
enable_pause_recording_on_hold
boolean 
enable_pause_recording_on_hold
optional
Automatically pauses recording when starting hold.
Pause Recording on Hold
enable_envision_screen_recording
boolean 
enable_envision_screen_recording
optional
Enable envision agent screen recording. Use Agent Screen Recording
agent_screen_recording
boolean 
agent_screen_recording
optional
Read only- shows if the Agent Screen Recording is enabled for the Org
enable_agent_simple_hold
boolean 
enable_agent_simple_hold
optional
Enable agent simple hold. Allow Agent Hold
enable_agent_multi_accept
boolean 
enable_agent_multi_accept
optional
Enable agent multi-accept hold. Allow Agent Hold
pause_agent_after_multi_accept
boolean 
pause_agent_after_multi_accept
optional
Automatically pause agent after multi-accept hold. AutoPauseOnMultiHold
display_machine_deliver
boolean 
display_machine_deliver
optional
Whether to display the machine-deliver button on the UI.
display_linkback_hunt_group
boolean 
display_linkback_hunt_group
optional
Whether to display the call's linkback Hunt Group in the data panel.
display_sip_header_data
boolean 
display_sip_header_data
optional
Whether to display SIP header data in the data panel.
display_ivr_navigation_keys
boolean 
display_ivr_navigation_keys
optional
Whether to display the IVR navigation (Keys Pressed) in the data panel.
display_data_collect_data
boolean 
display_data_collect_data
optional
Whether to display Data Collect data in the data panel.
display_skills
boolean 
display_skills
optional
Whether to display the call and agent skills to the agent Display Skills
display_web_links
boolean 
display_web_links
optional
Whether to display Web Links to the agent Display Web Links
enable_agent_hunt_group_reassignment
boolean 
enable_agent_hunt_group_reassignment
optional
Enable agent to reassign hunt groups. Agent Skills Reassignment
enable_manual_approval_of_calls
boolean 
enable_manual_approval_of_calls
optional
Enable manual approval of calls. Allow Manual Approval
require_manual_approval_number
boolean 
require_manual_approval_number
optional
Require manual approval number confirmation. MAC Number Confirmation
enable_manual_approval_of_sms
boolean 
enable_manual_approval_of_sms
optional
Enable manual approval of SMS. Allow Manual Approval For Messaging
require_manual_approval_number_sms
boolean 
require_manual_approval_number_sms
optional
Require manual approval number confirmation for SMS.
MAM Number Confirmation
disable_reject_option_for_approvers
boolean 
disable_reject_option_for_approvers
optional
Control whether the reject option is available to the approvers.
enable_call_desktop_notifications
boolean 
enable_call_desktop_notifications
optional
Enable queued call desktop notifications. Allow Queued Call Notifications
enable_agent_intercom
boolean 
enable_agent_intercom
optional
Whether to allow the agent to intercom with other agents.
AllowAgentIntercom
authorized_ip_addresses
array[string]
authorized_ip_addresses
optional
Whitelisted IPs. AllowedIps
call_recording_delay
integer <int64> | string 
call_recording_delay
optional
Call recording delay in seconds. Recording Delay
communication_settings
object (CommunicationSettings) 
communication_settings
optional
Hunt group communication compliance settings to be updated.
compliance_default_country
enum<string> 
compliance_default_country
optional
Select compliance default country. Default DNCL Country
Allowed values:
COUNTRY_UNDEFINEDCOUNTRY_AFGHANISTANCOUNTRY_ALBANIACOUNTRY_ALGERIACOUNTRY_ANDORRACOUNTRY_ANGOLACOUNTRY_ANTARCTICACOUNTRY_ARGENTINACOUNTRY_ARMENIACOUNTRY_ARUBACOUNTRY_AUSTRALIACOUNTRY_AUSTRIACOUNTRY_AZERBAIJANCOUNTRY_BAHRAINCOUNTRY_BANGLADESHCOUNTRY_BELARUSCOUNTRY_BELGUIMCOUNTRY_BELIZECOUNTRY_BENINCOUNTRY_BERMUDACOUNTRY_BHUTANCOUNTRY_BOLIVIACOUNTRY_BOSNIA_AND_HERZEGOVINACOUNTRY_BOTSWANACOUNTRY_BRAZILCOUNTRY_BRUNEI_DARUSSALAMCOUNTRY_BULGARIACOUNTRY_BURKINA_FASOCOUNTRY_BURUNDICOUNTRY_CAMBODIACOUNTRY_CAMEROONCOUNTRY_CENTRAL_AFRICAN_REPUBLICCOUNTRY_CHADCOUNTRY_CHILECOUNTRY_CHINACOUNTRY_COLOMBIACOUNTRY_COMOROSCOUNTRY_CONGO_DEMOCRATIC_REPUBLICCOUNTRY_CONGOCOUNTRY_COOK_ISLANDSCOUNTRY_COSTA_RICACOUNTRY_CROATIACOUNTRY_CURACAOCOUNTRY_CYPRUSCOUNTRY_CZECHIACOUNTRY_DENMARKCOUNTRY_DJIBOUTICOUNTRY_ECUADORCOUNTRY_EGYPTCOUNTRY_EL_SALVADORCOUNTRY_EQUATORIAL_GUINEACOUNTRY_ERITREACOUNTRY_ESTONIACOUNTRY_ESWATINICOUNTRY_ETHIOPIACOUNTRY_FALKLAND_ISLANDSCOUNTRY_FIJICOUNTRY_FINLANDCOUNTRY_FRANCECOUNTRY_FRENCH_GUIANACOUNTRY_FRENCH_POLYNESIACOUNTRY_GABONCOUNTRY_GAMBIACOUNTRY_GEORGIACOUNTRY_GERMANYCOUNTRY_GHANACOUNTRY_GIBRALTARCOUNTRY_GREECECOUNTRY_GREENLANDCOUNTRY_GUADELOUPECOUNTRY_GUATEMALACOUNTRY_GUINEACOUNTRY_GUINEA_BISSAUCOUNTRY_GUYANACOUNTRY_HAITICOUNTRY_HONDURASCOUNTRY_HONG_KONGCOUNTRY_HUNGARYCOUNTRY_ICELANDCOUNTRY_INDIACOUNTRY_INDONESIACOUNTRY_IRAQCOUNTRY_IRELANDCOUNTRY_ISRAELCOUNTRY_ITALYCOUNTRY_JAPANCOUNTRY_JORDANCOUNTRY_KAZAKHSTANCOUNTRY_KENYACOUNTRY_KOREA_REPUBLICCOUNTRY_KUWAITCOUNTRY_KYRGYZSTANCOUNTRY_LAO_PEOPLES_DEMOCRATIC_REPUBLICCOUNTRY_LATVIACOUNTRY_LEBANONCOUNTRY_LESOTHOCOUNTRY_LIBERIACOUNTRY_LIBYACOUNTRY_LIECHTENSTEINCOUNTRY_LITHUANIACOUNTRY_LUXEMBOURGCOUNTRY_NORTH_MACEDONIACOUNTRY_MADAGASCARCOUNTRY_MALAWICOUNTRY_MALAYSIACOUNTRY_MALDIVESCOUNTRY_MALICOUNTRY_MALTACOUNTRY_MARSHALL_ISLANDSCOUNTRY_MARTINIQUECOUNTRY_MAURITANIACOUNTRY_MAURITIUSCOUNTRY_MEXICOCOUNTRY_MICRONESIACOUNTRY_MOLDOVACOUNTRY_MONACOCOUNTRY_MONGOLLIACOUNTRY_MONTENEGROCOUNTRY_MOROCCOCOUNTRY_MOZAMBIQUECOUNTRY_MYANMARCOUNTRY_NAMIBIACOUNTRY_NAURUCOUNTRY_NEPALCOUNTRY_NETHERLANDSCOUNTRY_NEW_CALEDONIACOUNTRY_NEW_ZEALANDCOUNTRY_NICARAGUACOUNTRY_NIGERCOUNTRY_NIGERIACOUNTRY_NIUECOUNTRY_NORWAYCOUNTRY_OMANCOUNTRY_PAKISTANCOUNTRY_PALAUCOUNTRY_PALESTINECOUNTRY_PANAMACOUNTRY_PAPUA_NEW_GUINEACOUNTRY_PARAGUAYCOUNTRY_PERUCOUNTRY_PHILIPPINESCOUNTRY_POLANDCOUNTRY_PORTUGALCOUNTRY_QATARCOUNTRY_ROMANIACOUNTRY_RUSSIAN_FEDERATIONCOUNTRY_RWANDACOUNTRY_SAINT_HELENACOUNTRY_SAINT_PIERRE_AND_MIQUELONCOUNTRY_SAMOACOUNTRY_SAN_MARINOCOUNTRY_SAUDI_ARABIACOUNTRY_SENAGALCOUNTRY_SERBIACOUNTRY_SIERRA_LEONECOUNTRY_SINGAPORECOUNTRY_SINT_MAARTENCOUNTRY_SLOVAKIACOUNTRY_SLOVENIACOUNTRY_SOLOMON_ISLANDSCOUNTRY_SOMALIACOUNTRY_SOUTH_AFRICACOUNTRY_SOUTH_SUDANCOUNTRY_SPAINCOUNTRY_SRI_LANKACOUNTRY_SUDANCOUNTRY_SURINAMECOUNTRY_SWEDENCOUNTRY_SWITZERLANDCOUNTRY_SYRIAN_ARAB_REPUBLICCOUNTRY_TAIWANCOUNTRY_TAJIKISTANCOUNTRY_TANZANIACOUNTRY_THAILANDCOUNTRY_TOGOCOUNTRY_TOKELAUCOUNTRY_TONGACOUNTRY_TUNISIACOUNTRY_TURKEYCOUNTRY_TURKMENISTANCOUNTRY_TURKS_AND_CAICOS_ISLANDSCOUNTRY_TUVALUCOUNTRY_UGANDACOUNTRY_UKRAINECOUNTRY_UNITED_ARAB_EMIRATESCOUNTRY_UNITED_KINGDOM_OF_GREAT_BRITAIN_AND_NORTHERN_IRELANDCOUNTRY_UNITED_STATES_OF_AMERICACOUNTRY_URUGUAYCOUNTRY_UZBEKISTANCOUNTRY_VANUATUCOUNTRY_VENEZUELACOUNTRY_VIET_NAMCOUNTRY_WALLIS_AND_FUTUNACOUNTRY_YEMENCOUNTRY_ZAMBIACOUNTRY_ZIMBABWECOUNTRY_GLOBAL_SIP
inbound_scrub_list_expiration
object (ScrubListExpiration) 
inbound_scrub_list_expiration
optional
Default inbound scrub list expiration. defaultIBCallDnclExpiration
manual_scrub_list_expiration
object (ScrubListExpiration) 
manual_scrub_list_expiration
optional
Default manual scrub list expiration. defaultMDCallDnclExpiration
outbound_scrub_list_expiration
object (ScrubListExpiration) 
outbound_scrub_list_expiration
optional
Default outbound scrub list expiration. defaultOBCallExpiration
preview_scrub_list_expiration
object (ScrubListExpiration) 
preview_scrub_list_expiration
optional
Default preview scrub list expiration. defaultPRCallDnclExpiration
automate_response_rules
object (AutomateResponseRules) 
automate_response_rules
optional
Automate response rules. AgentDispositionConditionalDncl
automate_scrub_list_call_data
object (AutomateScrubListCallData) 
automate_scrub_list_call_data
optional
Enable automatic addition of call data to scrub lists.
Call Data Scrub Lists Info
enable_scrub_list_adding
boolean 
enable_scrub_list_adding
optional
Enable the ability to add valuess from the compliance scrub list.
doAllowAddDncl
enable_scrub_list_removal
boolean 
enable_scrub_list_removal
optional
Enable the ability to remove values from the compliance scrub lists.
doAllowRemoveDncl
display_options_in_wrapup
boolean 
display_options_in_wrapup
optional
Display DNCL options in wrap up. Display DNCL Options In Wrapup
automate_manually_dialed_scrub_list
boolean 
automate_manually_dialed_scrub_list
optional
Automate manually dialed number scrub list. Manual Dial Auto Dncl Add
automate_preview_dialed_scrub_list
boolean 
automate_preview_dialed_scrub_list
optional
Automate preview dialed number scrub list. Preview Dial Auto Dncl Add
scrub_lists
array[string]
scrub_lists
optional
Hunt group compliance scrub lists. Hunt Group Compliance Scrub Lists
scrub_lists_removal_allowed
array[string]
scrub_lists_removal_allowed
optional
List of compliance scrub lists which can be removed.
Hunt Group Compliance Scrub Lists Removal Allowed
callback_settings
object (CallbackSettings) 
callback_settings
optional
Hunt group scheduled callback settings to be updated.
default_callback_routing
object (DefaultRouting) 
default_callback_routing
optional
Default callback routing. Default Callback Routing
callback_routing_disallowed
object (CallbackRoutingDisallowed) 
callback_routing_disallowed
optional
Indicates whether and how to limit callback routing.
Callback Routing Disallowed
enable_callback_scheduling
boolean 
enable_callback_scheduling
optional
Enable callback scheduling. Allow Callback Scheduling
enable_callback_calling
boolean 
enable_callback_calling
optional
Enable callback calling Allow Scheduled Callback Calling
enable_automatic_retrieval
boolean 
enable_automatic_retrieval
optional
Enable automatic callback retrieval Callbacks Retrieval Mode
enable_customizable_caller_id
boolean 
enable_customizable_caller_id
optional
Enable caller ID customization. 'Scheduled Callback Editable Caller ID'
default_caller_id
string 
default_caller_id
optional
Default scheduled callback caller ID.
Scheduled Callback Default Caller ID
enable_callback_calendar
boolean 
enable_callback_calendar
optional
Enable viewing the Scheduled Callback calendar.
Allow Scheduled Callback Calendar
preview_dial_settings
object (PreviewDialSettings) 
preview_dial_settings
optional
Hunt group Preview Dial settings to be updated.
enable_preview_dial_cancel
boolean 
enable_preview_dial_cancel
optional
Enable cancelling of Preview Dialing. AllowPreviewDialCancel
enable_auto_pause_on_cancel
boolean 
enable_auto_pause_on_cancel
optional
Enable automatic pausing when cancelling a Preview Dial call.
AutoPauseOnPreviewDial
require_number_confirmation
boolean 
require_number_confirmation
optional
Indicates if agents must confirm numbers before calling.
Preview Dial Confirmation
preview_queue_config
string 
preview_queue_config
optional
The name of the Call Queue Configuration (folder name).
PreviewQueueConfig
timeout_minutes
integer <int64> | string 
timeout_minutes
optional
Indicates when queued preview dial calls should no longer be presented
to agents.
Preview Dial Call Time-out
manual_dial_settings
object (ManualDialSettings) 
manual_dial_settings
optional
Hunt group Manual Dial settings to be updated.
default_call_recording
enum<string> 
default_call_recording
optional
The default setting for recording manual dial calls.
Allowed values:
HUNT_GROUP_USE_ORG_DEFAULTHUNT_GROUP_CUSTOM_ENABLEDHUNT_GROUP_CUSTOM_DISABLED
cell_phone_scrub
enum<string> 
cell_phone_scrub
optional
Determines whether to scrub cell phone calls.
Allowed values:
HUNT_GROUP_USE_ORG_DEFAULTHUNT_GROUP_CUSTOM_ENABLEDHUNT_GROUP_CUSTOM_DISABLED
time_zone_restriction
enum<string> 
time_zone_restriction
optional
Determines whether to scrub calls by time zone.
Allowed values:
HUNT_GROUP_USE_ORG_DEFAULTHUNT_GROUP_CUSTOM_ENABLEDHUNT_GROUP_CUSTOM_DISABLED
time_zone_validation_postal_code
enum<string> 
time_zone_validation_postal_code
optional
Determines whether to allow or require collection of ZIP/postal
for compliance.
Allowed values:
MANUAL_DIAL_TIME_ZONE_VALIDATION_DISABLEDMANUAL_DIAL_TIME_ZONE_VALIDATION_OPTIONALMANUAL_DIAL_TIME_ZONE_VALIDATION_REQUIRED
natural_compliance_scrub
object (NaturalLanguageComplianceScrub) 
natural_compliance_scrub
optional
Use Natural Language Compliance and rule set.
scrub_override
object (ScrubOverride) 
scrub_override
optional
Allow agent to override scrub options
default_outbound_country
enum<string> 
default_outbound_country
optional
The default selected country for outbound number.
Allowed values:
COUNTRY_UNDEFINEDCOUNTRY_AFGHANISTANCOUNTRY_ALBANIACOUNTRY_ALGERIACOUNTRY_ANDORRACOUNTRY_ANGOLACOUNTRY_ANTARCTICACOUNTRY_ARGENTINACOUNTRY_ARMENIACOUNTRY_ARUBACOUNTRY_AUSTRALIACOUNTRY_AUSTRIACOUNTRY_AZERBAIJANCOUNTRY_BAHRAINCOUNTRY_BANGLADESHCOUNTRY_BELARUSCOUNTRY_BELGUIMCOUNTRY_BELIZECOUNTRY_BENINCOUNTRY_BERMUDACOUNTRY_BHUTANCOUNTRY_BOLIVIACOUNTRY_BOSNIA_AND_HERZEGOVINACOUNTRY_BOTSWANACOUNTRY_BRAZILCOUNTRY_BRUNEI_DARUSSALAMCOUNTRY_BULGARIACOUNTRY_BURKINA_FASOCOUNTRY_BURUNDICOUNTRY_CAMBODIACOUNTRY_CAMEROONCOUNTRY_CENTRAL_AFRICAN_REPUBLICCOUNTRY_CHADCOUNTRY_CHILECOUNTRY_CHINACOUNTRY_COLOMBIACOUNTRY_COMOROSCOUNTRY_CONGO_DEMOCRATIC_REPUBLICCOUNTRY_CONGOCOUNTRY_COOK_ISLANDSCOUNTRY_COSTA_RICACOUNTRY_CROATIACOUNTRY_CURACAOCOUNTRY_CYPRUSCOUNTRY_CZECHIACOUNTRY_DENMARKCOUNTRY_DJIBOUTICOUNTRY_ECUADORCOUNTRY_EGYPTCOUNTRY_EL_SALVADORCOUNTRY_EQUATORIAL_GUINEACOUNTRY_ERITREACOUNTRY_ESTONIACOUNTRY_ESWATINICOUNTRY_ETHIOPIACOUNTRY_FALKLAND_ISLANDSCOUNTRY_FIJICOUNTRY_FINLANDCOUNTRY_FRANCECOUNTRY_FRENCH_GUIANACOUNTRY_FRENCH_POLYNESIACOUNTRY_GABONCOUNTRY_GAMBIACOUNTRY_GEORGIACOUNTRY_GERMANYCOUNTRY_GHANACOUNTRY_GIBRALTARCOUNTRY_GREECECOUNTRY_GREENLANDCOUNTRY_GUADELOUPECOUNTRY_GUATEMALACOUNTRY_GUINEACOUNTRY_GUINEA_BISSAUCOUNTRY_GUYANACOUNTRY_HAITICOUNTRY_HONDURASCOUNTRY_HONG_KONGCOUNTRY_HUNGARYCOUNTRY_ICELANDCOUNTRY_INDIACOUNTRY_INDONESIACOUNTRY_IRAQCOUNTRY_IRELANDCOUNTRY_ISRAELCOUNTRY_ITALYCOUNTRY_JAPANCOUNTRY_JORDANCOUNTRY_KAZAKHSTANCOUNTRY_KENYACOUNTRY_KOREA_REPUBLICCOUNTRY_KUWAITCOUNTRY_KYRGYZSTANCOUNTRY_LAO_PEOPLES_DEMOCRATIC_REPUBLICCOUNTRY_LATVIACOUNTRY_LEBANONCOUNTRY_LESOTHOCOUNTRY_LIBERIACOUNTRY_LIBYACOUNTRY_LIECHTENSTEINCOUNTRY_LITHUANIACOUNTRY_LUXEMBOURGCOUNTRY_NORTH_MACEDONIACOUNTRY_MADAGASCARCOUNTRY_MALAWICOUNTRY_MALAYSIACOUNTRY_MALDIVESCOUNTRY_MALICOUNTRY_MALTACOUNTRY_MARSHALL_ISLANDSCOUNTRY_MARTINIQUECOUNTRY_MAURITANIACOUNTRY_MAURITIUSCOUNTRY_MEXICOCOUNTRY_MICRONESIACOUNTRY_MOLDOVACOUNTRY_MONACOCOUNTRY_MONGOLLIACOUNTRY_MONTENEGROCOUNTRY_MOROCCOCOUNTRY_MOZAMBIQUECOUNTRY_MYANMARCOUNTRY_NAMIBIACOUNTRY_NAURUCOUNTRY_NEPALCOUNTRY_NETHERLANDSCOUNTRY_NEW_CALEDONIACOUNTRY_NEW_ZEALANDCOUNTRY_NICARAGUACOUNTRY_NIGERCOUNTRY_NIGERIACOUNTRY_NIUECOUNTRY_NORWAYCOUNTRY_OMANCOUNTRY_PAKISTANCOUNTRY_PALAUCOUNTRY_PALESTINECOUNTRY_PANAMACOUNTRY_PAPUA_NEW_GUINEACOUNTRY_PARAGUAYCOUNTRY_PERUCOUNTRY_PHILIPPINESCOUNTRY_POLANDCOUNTRY_PORTUGALCOUNTRY_QATARCOUNTRY_ROMANIACOUNTRY_RUSSIAN_FEDERATIONCOUNTRY_RWANDACOUNTRY_SAINT_HELENACOUNTRY_SAINT_PIERRE_AND_MIQUELONCOUNTRY_SAMOACOUNTRY_SAN_MARINOCOUNTRY_SAUDI_ARABIACOUNTRY_SENAGALCOUNTRY_SERBIACOUNTRY_SIERRA_LEONECOUNTRY_SINGAPORECOUNTRY_SINT_MAARTENCOUNTRY_SLOVAKIACOUNTRY_SLOVENIACOUNTRY_SOLOMON_ISLANDSCOUNTRY_SOMALIACOUNTRY_SOUTH_AFRICACOUNTRY_SOUTH_SUDANCOUNTRY_SPAINCOUNTRY_SRI_LANKACOUNTRY_SUDANCOUNTRY_SURINAMECOUNTRY_SWEDENCOUNTRY_SWITZERLANDCOUNTRY_SYRIAN_ARAB_REPUBLICCOUNTRY_TAIWANCOUNTRY_TAJIKISTANCOUNTRY_TANZANIACOUNTRY_THAILANDCOUNTRY_TOGOCOUNTRY_TOKELAUCOUNTRY_TONGACOUNTRY_TUNISIACOUNTRY_TURKEYCOUNTRY_TURKMENISTANCOUNTRY_TURKS_AND_CAICOS_ISLANDSCOUNTRY_TUVALUCOUNTRY_UGANDACOUNTRY_UKRAINECOUNTRY_UNITED_ARAB_EMIRATESCOUNTRY_UNITED_KINGDOM_OF_GREAT_BRITAIN_AND_NORTHERN_IRELANDCOUNTRY_UNITED_STATES_OF_AMERICACOUNTRY_URUGUAYCOUNTRY_UZBEKISTANCOUNTRY_VANUATUCOUNTRY_VENEZUELACOUNTRY_VIET_NAMCOUNTRY_WALLIS_AND_FUTUNACOUNTRY_YEMENCOUNTRY_ZAMBIACOUNTRY_ZIMBABWECOUNTRY_GLOBAL_SIP
default_caller_id_country
enum<string> 
default_caller_id_country
optional
Indicates the default Country to use with the caller ID number.
Manual Dial Default Caller ID Country
Allowed values:
COUNTRY_UNDEFINEDCOUNTRY_AFGHANISTANCOUNTRY_ALBANIACOUNTRY_ALGERIACOUNTRY_ANDORRACOUNTRY_ANGOLACOUNTRY_ANTARCTICACOUNTRY_ARGENTINACOUNTRY_ARMENIACOUNTRY_ARUBACOUNTRY_AUSTRALIACOUNTRY_AUSTRIACOUNTRY_AZERBAIJANCOUNTRY_BAHRAINCOUNTRY_BANGLADESHCOUNTRY_BELARUSCOUNTRY_BELGUIMCOUNTRY_BELIZECOUNTRY_BENINCOUNTRY_BERMUDACOUNTRY_BHUTANCOUNTRY_BOLIVIACOUNTRY_BOSNIA_AND_HERZEGOVINACOUNTRY_BOTSWANACOUNTRY_BRAZILCOUNTRY_BRUNEI_DARUSSALAMCOUNTRY_BULGARIACOUNTRY_BURKINA_FASOCOUNTRY_BURUNDICOUNTRY_CAMBODIACOUNTRY_CAMEROONCOUNTRY_CENTRAL_AFRICAN_REPUBLICCOUNTRY_CHADCOUNTRY_CHILECOUNTRY_CHINACOUNTRY_COLOMBIACOUNTRY_COMOROSCOUNTRY_CONGO_DEMOCRATIC_REPUBLICCOUNTRY_CONGOCOUNTRY_COOK_ISLANDSCOUNTRY_COSTA_RICACOUNTRY_CROATIACOUNTRY_CURACAOCOUNTRY_CYPRUSCOUNTRY_CZECHIACOUNTRY_DENMARKCOUNTRY_DJIBOUTICOUNTRY_ECUADORCOUNTRY_EGYPTCOUNTRY_EL_SALVADORCOUNTRY_EQUATORIAL_GUINEACOUNTRY_ERITREACOUNTRY_ESTONIACOUNTRY_ESWATINICOUNTRY_ETHIOPIACOUNTRY_FALKLAND_ISLANDSCOUNTRY_FIJICOUNTRY_FINLANDCOUNTRY_FRANCECOUNTRY_FRENCH_GUIANACOUNTRY_FRENCH_POLYNESIACOUNTRY_GABONCOUNTRY_GAMBIACOUNTRY_GEORGIACOUNTRY_GERMANYCOUNTRY_GHANACOUNTRY_GIBRALTARCOUNTRY_GREECECOUNTRY_GREENLANDCOUNTRY_GUADELOUPECOUNTRY_GUATEMALACOUNTRY_GUINEACOUNTRY_GUINEA_BISSAUCOUNTRY_GUYANACOUNTRY_HAITICOUNTRY_HONDURASCOUNTRY_HONG_KONGCOUNTRY_HUNGARYCOUNTRY_ICELANDCOUNTRY_INDIACOUNTRY_INDONESIACOUNTRY_IRAQCOUNTRY_IRELANDCOUNTRY_ISRAELCOUNTRY_ITALYCOUNTRY_JAPANCOUNTRY_JORDANCOUNTRY_KAZAKHSTANCOUNTRY_KENYACOUNTRY_KOREA_REPUBLICCOUNTRY_KUWAITCOUNTRY_KYRGYZSTANCOUNTRY_LAO_PEOPLES_DEMOCRATIC_REPUBLICCOUNTRY_LATVIACOUNTRY_LEBANONCOUNTRY_LESOTHOCOUNTRY_LIBERIACOUNTRY_LIBYACOUNTRY_LIECHTENSTEINCOUNTRY_LITHUANIACOUNTRY_LUXEMBOURGCOUNTRY_NORTH_MACEDONIACOUNTRY_MADAGASCARCOUNTRY_MALAWICOUNTRY_MALAYSIACOUNTRY_MALDIVESCOUNTRY_MALICOUNTRY_MALTACOUNTRY_MARSHALL_ISLANDSCOUNTRY_MARTINIQUECOUNTRY_MAURITANIACOUNTRY_MAURITIUSCOUNTRY_MEXICOCOUNTRY_MICRONESIACOUNTRY_MOLDOVACOUNTRY_MONACOCOUNTRY_MONGOLLIACOUNTRY_MONTENEGROCOUNTRY_MOROCCOCOUNTRY_MOZAMBIQUECOUNTRY_MYANMARCOUNTRY_NAMIBIACOUNTRY_NAURUCOUNTRY_NEPALCOUNTRY_NETHERLANDSCOUNTRY_NEW_CALEDONIACOUNTRY_NEW_ZEALANDCOUNTRY_NICARAGUACOUNTRY_NIGERCOUNTRY_NIGERIACOUNTRY_NIUECOUNTRY_NORWAYCOUNTRY_OMANCOUNTRY_PAKISTANCOUNTRY_PALAUCOUNTRY_PALESTINECOUNTRY_PANAMACOUNTRY_PAPUA_NEW_GUINEACOUNTRY_PARAGUAYCOUNTRY_PERUCOUNTRY_PHILIPPINESCOUNTRY_POLANDCOUNTRY_PORTUGALCOUNTRY_QATARCOUNTRY_ROMANIACOUNTRY_RUSSIAN_FEDERATIONCOUNTRY_RWANDACOUNTRY_SAINT_HELENACOUNTRY_SAINT_PIERRE_AND_MIQUELONCOUNTRY_SAMOACOUNTRY_SAN_MARINOCOUNTRY_SAUDI_ARABIACOUNTRY_SENAGALCOUNTRY_SERBIACOUNTRY_SIERRA_LEONECOUNTRY_SINGAPORECOUNTRY_SINT_MAARTENCOUNTRY_SLOVAKIACOUNTRY_SLOVENIACOUNTRY_SOLOMON_ISLANDSCOUNTRY_SOMALIACOUNTRY_SOUTH_AFRICACOUNTRY_SOUTH_SUDANCOUNTRY_SPAINCOUNTRY_SRI_LANKACOUNTRY_SUDANCOUNTRY_SURINAMECOUNTRY_SWEDENCOUNTRY_SWITZERLANDCOUNTRY_SYRIAN_ARAB_REPUBLICCOUNTRY_TAIWANCOUNTRY_TAJIKISTANCOUNTRY_TANZANIACOUNTRY_THAILANDCOUNTRY_TOGOCOUNTRY_TOKELAUCOUNTRY_TONGACOUNTRY_TUNISIACOUNTRY_TURKEYCOUNTRY_TURKMENISTANCOUNTRY_TURKS_AND_CAICOS_ISLANDSCOUNTRY_TUVALUCOUNTRY_UGANDACOUNTRY_UKRAINECOUNTRY_UNITED_ARAB_EMIRATESCOUNTRY_UNITED_KINGDOM_OF_GREAT_BRITAIN_AND_NORTHERN_IRELANDCOUNTRY_UNITED_STATES_OF_AMERICACOUNTRY_URUGUAYCOUNTRY_UZBEKISTANCOUNTRY_VANUATUCOUNTRY_VENEZUELACOUNTRY_VIET_NAMCOUNTRY_WALLIS_AND_FUTUNACOUNTRY_YEMENCOUNTRY_ZAMBIACOUNTRY_ZIMBABWECOUNTRY_GLOBAL_SIP
default_caller_id
object (DefaultCallerId) 
default_caller_id
optional
Indicates the default number to use as the caller ID.
Manual Dial Default Caller ID
natural_language_compliance_metadata
object (NaturalLanguageComplianceMetadata) 
natural_language_compliance_metadata
optional
Manual Dial natural language compliance metadata.
Optional Inbound Compliance Metadata
Required Inbound Compliance Metadata
data_dip_scope
enum<string> 
data_dip_scope
optional
Application scope; disabled, standard calls, scheduled callbacks or all.
Allowed values:
MANUAL_DIAL_DATA_DIP_SCOPE_DISABLEDMANUAL_DIAL_DATA_DIP_SCOPE_STANDARD_CALLSMANUAL_DIAL_DATA_DIP_SCOPE_SCHEDULED_CALLBACKSMANUAL_DIAL_DATA_DIP_SCOPE_ALL
data_dip_result_handling
enum<string> 
data_dip_result_handling
optional
The action to take if data dip execution fails.
Allowed values:
MANUAL_DIAL_DATA_DIP_HANDLING_CANCELMANUAL_DIAL_DATA_DIP_HANDLING_NOTIFY_AND_CANCELMANUAL_DIAL_DATA_DIP_HANDLING_NOTIFY_AND_CALLMANUAL_DIAL_DATA_DIP_HANDLING_CALL_WITH_ORIGINAL_VALUES
data_dip_integration_handling
enum<string> 
data_dip_integration_handling
optional
The action to take if the integration mapping fails.
Allowed values:
MANUAL_DIAL_DATA_DIP_HANDLING_CANCELMANUAL_DIAL_DATA_DIP_HANDLING_NOTIFY_AND_CANCELMANUAL_DIAL_DATA_DIP_HANDLING_NOTIFY_AND_CALLMANUAL_DIAL_DATA_DIP_HANDLING_CALL_WITH_ORIGINAL_VALUES
enable_manual_dial
boolean 
enable_manual_dial
optional
Allow the agent to make manual dial calls.
queue_configuration_name
string 
queue_configuration_name
optional
ACD queue configuration folder name.
enable_whitelist
boolean 
enable_whitelist
optional
Allow toll-free white list for manual dial calls.
display_outbound_country_selection
boolean 
display_outbound_country_selection
optional
Determines whether to display the country select menu to the agent.
display_outbound_number_phone_book
boolean 
display_outbound_number_phone_book
optional
Determines whether to display the outbound number phone book to the agent.
display_caller_id_country_selection
boolean 
display_caller_id_country_selection
optional
Determines whether to display the caller ID country select menu to
the agent.
Manual Dial Display Caller ID Country Select
display_caller_id_phone_book
boolean 
display_caller_id_phone_book
optional
Determines whether to display the caller ID phone book to the agent.
Manual Dial Display Phone Book
enable_customizable_caller_id
boolean 
enable_customizable_caller_id
optional
Determines whether the agent may customize/edit the caller ID.
Manual Dial Editable Caller ID
enable_caller_id_bucket
boolean 
enable_caller_id_bucket
optional
Determines whether to allow the use of caller ID buckets in the agent app.
Manual Dial Caller Id Bucket Enabled
automate_random_caller_id
boolean 
automate_random_caller_id
optional
Determines whether to automatically select a random caller ID.
Manual Dial Random Caller Id Enabled
enable_mask_caller_id
boolean 
enable_mask_caller_id
optional
Determines whether to mask the caller ID from the agent.
Mask Manual Dial Caller ID
enable_sip_address
boolean 
enable_sip_address
optional
Determines whether to enable SIP addresses as an optional outbound
number and/or caller ID format.
Enable SIP Address
data_dip_integration_mappings
array[object (DataDipIntegrationMapping) {3}] 
data_dip_integration_mappings
optional
Map data dip values to manual dial call values.
enable_reject_option_for_approvers
boolean 
enable_reject_option_for_approvers
deprecated
Control whether the reject option is available to the approvers.
Please use disable_reject_option_for_approvers under GeneralSettings.
random_caller_id_bucket
integer <int64> | string 
random_caller_id_bucket
optional
Indicates which caller ID bucket to use.
Manual Dial Random Caller Id Bucket
data_dip_config_sid
integer <int64> | string 
data_dip_config_sid
optional
The ID of the data dip config to execute.
transfer_call_settings
object (TransferCallSettings) 
transfer_call_settings
optional
Transfer Call hunt group settings.
hand_off_types
object (HandOffTypes) 
hand_off_types
optional
Allowed hand-off types for transfer calls.
recording_status
enum<string> 
recording_status
optional
Indicates start, stop or keep current recording status on transfer.
Allowed values:
TRANSFER_RECORDING_STATUS_KEEP_STATUSTRANSFER_RECORDING_STATUS_START_RECORDINGTRANSFER_RECORDING_STATUS_STOP_RECORDING
transfer_types
object (TransferTypes) 
transfer_types
optional
Indicates type of allowed transfer types.
transfer_number_country
enum<string> 
transfer_number_country
optional
The default country to use with the transfer number.
Allowed values:
COUNTRY_UNDEFINEDCOUNTRY_AFGHANISTANCOUNTRY_ALBANIACOUNTRY_ALGERIACOUNTRY_ANDORRACOUNTRY_ANGOLACOUNTRY_ANTARCTICACOUNTRY_ARGENTINACOUNTRY_ARMENIACOUNTRY_ARUBACOUNTRY_AUSTRALIACOUNTRY_AUSTRIACOUNTRY_AZERBAIJANCOUNTRY_BAHRAINCOUNTRY_BANGLADESHCOUNTRY_BELARUSCOUNTRY_BELGUIMCOUNTRY_BELIZECOUNTRY_BENINCOUNTRY_BERMUDACOUNTRY_BHUTANCOUNTRY_BOLIVIACOUNTRY_BOSNIA_AND_HERZEGOVINACOUNTRY_BOTSWANACOUNTRY_BRAZILCOUNTRY_BRUNEI_DARUSSALAMCOUNTRY_BULGARIACOUNTRY_BURKINA_FASOCOUNTRY_BURUNDICOUNTRY_CAMBODIACOUNTRY_CAMEROONCOUNTRY_CENTRAL_AFRICAN_REPUBLICCOUNTRY_CHADCOUNTRY_CHILECOUNTRY_CHINACOUNTRY_COLOMBIACOUNTRY_COMOROSCOUNTRY_CONGO_DEMOCRATIC_REPUBLICCOUNTRY_CONGOCOUNTRY_COOK_ISLANDSCOUNTRY_COSTA_RICACOUNTRY_CROATIACOUNTRY_CURACAOCOUNTRY_CYPRUSCOUNTRY_CZECHIACOUNTRY_DENMARKCOUNTRY_DJIBOUTICOUNTRY_ECUADORCOUNTRY_EGYPTCOUNTRY_EL_SALVADORCOUNTRY_EQUATORIAL_GUINEACOUNTRY_ERITREACOUNTRY_ESTONIACOUNTRY_ESWATINICOUNTRY_ETHIOPIACOUNTRY_FALKLAND_ISLANDSCOUNTRY_FIJICOUNTRY_FINLANDCOUNTRY_FRANCECOUNTRY_FRENCH_GUIANACOUNTRY_FRENCH_POLYNESIACOUNTRY_GABONCOUNTRY_GAMBIACOUNTRY_GEORGIACOUNTRY_GERMANYCOUNTRY_GHANACOUNTRY_GIBRALTARCOUNTRY_GREECECOUNTRY_GREENLANDCOUNTRY_GUADELOUPECOUNTRY_GUATEMALACOUNTRY_GUINEACOUNTRY_GUINEA_BISSAUCOUNTRY_GUYANACOUNTRY_HAITICOUNTRY_HONDURASCOUNTRY_HONG_KONGCOUNTRY_HUNGARYCOUNTRY_ICELANDCOUNTRY_INDIACOUNTRY_INDONESIACOUNTRY_IRAQCOUNTRY_IRELANDCOUNTRY_ISRAELCOUNTRY_ITALYCOUNTRY_JAPANCOUNTRY_JORDANCOUNTRY_KAZAKHSTANCOUNTRY_KENYACOUNTRY_KOREA_REPUBLICCOUNTRY_KUWAITCOUNTRY_KYRGYZSTANCOUNTRY_LAO_PEOPLES_DEMOCRATIC_REPUBLICCOUNTRY_LATVIACOUNTRY_LEBANONCOUNTRY_LESOTHOCOUNTRY_LIBERIACOUNTRY_LIBYACOUNTRY_LIECHTENSTEINCOUNTRY_LITHUANIACOUNTRY_LUXEMBOURGCOUNTRY_NORTH_MACEDONIACOUNTRY_MADAGASCARCOUNTRY_MALAWICOUNTRY_MALAYSIACOUNTRY_MALDIVESCOUNTRY_MALICOUNTRY_MALTACOUNTRY_MARSHALL_ISLANDSCOUNTRY_MARTINIQUECOUNTRY_MAURITANIACOUNTRY_MAURITIUSCOUNTRY_MEXICOCOUNTRY_MICRONESIACOUNTRY_MOLDOVACOUNTRY_MONACOCOUNTRY_MONGOLLIACOUNTRY_MONTENEGROCOUNTRY_MOROCCOCOUNTRY_MOZAMBIQUECOUNTRY_MYANMARCOUNTRY_NAMIBIACOUNTRY_NAURUCOUNTRY_NEPALCOUNTRY_NETHERLANDSCOUNTRY_NEW_CALEDONIACOUNTRY_NEW_ZEALANDCOUNTRY_NICARAGUACOUNTRY_NIGERCOUNTRY_NIGERIACOUNTRY_NIUECOUNTRY_NORWAYCOUNTRY_OMANCOUNTRY_PAKISTANCOUNTRY_PALAUCOUNTRY_PALESTINECOUNTRY_PANAMACOUNTRY_PAPUA_NEW_GUINEACOUNTRY_PARAGUAYCOUNTRY_PERUCOUNTRY_PHILIPPINESCOUNTRY_POLANDCOUNTRY_PORTUGALCOUNTRY_QATARCOUNTRY_ROMANIACOUNTRY_RUSSIAN_FEDERATIONCOUNTRY_RWANDACOUNTRY_SAINT_HELENACOUNTRY_SAINT_PIERRE_AND_MIQUELONCOUNTRY_SAMOACOUNTRY_SAN_MARINOCOUNTRY_SAUDI_ARABIACOUNTRY_SENAGALCOUNTRY_SERBIACOUNTRY_SIERRA_LEONECOUNTRY_SINGAPORECOUNTRY_SINT_MAARTENCOUNTRY_SLOVAKIACOUNTRY_SLOVENIACOUNTRY_SOLOMON_ISLANDSCOUNTRY_SOMALIACOUNTRY_SOUTH_AFRICACOUNTRY_SOUTH_SUDANCOUNTRY_SPAINCOUNTRY_SRI_LANKACOUNTRY_SUDANCOUNTRY_SURINAMECOUNTRY_SWEDENCOUNTRY_SWITZERLANDCOUNTRY_SYRIAN_ARAB_REPUBLICCOUNTRY_TAIWANCOUNTRY_TAJIKISTANCOUNTRY_TANZANIACOUNTRY_THAILANDCOUNTRY_TOGOCOUNTRY_TOKELAUCOUNTRY_TONGACOUNTRY_TUNISIACOUNTRY_TURKEYCOUNTRY_TURKMENISTANCOUNTRY_TURKS_AND_CAICOS_ISLANDSCOUNTRY_TUVALUCOUNTRY_UGANDACOUNTRY_UKRAINECOUNTRY_UNITED_ARAB_EMIRATESCOUNTRY_UNITED_KINGDOM_OF_GREAT_BRITAIN_AND_NORTHERN_IRELANDCOUNTRY_UNITED_STATES_OF_AMERICACOUNTRY_URUGUAYCOUNTRY_UZBEKISTANCOUNTRY_VANUATUCOUNTRY_VENEZUELACOUNTRY_VIET_NAMCOUNTRY_WALLIS_AND_FUTUNACOUNTRY_YEMENCOUNTRY_ZAMBIACOUNTRY_ZIMBABWECOUNTRY_GLOBAL_SIP
default_caller_id
object (DefaultCallerId) 
default_caller_id
optional
The default caller ID prepopulated in the text box.
caller_id_country
enum<string> 
caller_id_country
optional
The default country to use with the caller ID.
Allowed values:
COUNTRY_UNDEFINEDCOUNTRY_AFGHANISTANCOUNTRY_ALBANIACOUNTRY_ALGERIACOUNTRY_ANDORRACOUNTRY_ANGOLACOUNTRY_ANTARCTICACOUNTRY_ARGENTINACOUNTRY_ARMENIACOUNTRY_ARUBACOUNTRY_AUSTRALIACOUNTRY_AUSTRIACOUNTRY_AZERBAIJANCOUNTRY_BAHRAINCOUNTRY_BANGLADESHCOUNTRY_BELARUSCOUNTRY_BELGUIMCOUNTRY_BELIZECOUNTRY_BENINCOUNTRY_BERMUDACOUNTRY_BHUTANCOUNTRY_BOLIVIACOUNTRY_BOSNIA_AND_HERZEGOVINACOUNTRY_BOTSWANACOUNTRY_BRAZILCOUNTRY_BRUNEI_DARUSSALAMCOUNTRY_BULGARIACOUNTRY_BURKINA_FASOCOUNTRY_BURUNDICOUNTRY_CAMBODIACOUNTRY_CAMEROONCOUNTRY_CENTRAL_AFRICAN_REPUBLICCOUNTRY_CHADCOUNTRY_CHILECOUNTRY_CHINACOUNTRY_COLOMBIACOUNTRY_COMOROSCOUNTRY_CONGO_DEMOCRATIC_REPUBLICCOUNTRY_CONGOCOUNTRY_COOK_ISLANDSCOUNTRY_COSTA_RICACOUNTRY_CROATIACOUNTRY_CURACAOCOUNTRY_CYPRUSCOUNTRY_CZECHIACOUNTRY_DENMARKCOUNTRY_DJIBOUTICOUNTRY_ECUADORCOUNTRY_EGYPTCOUNTRY_EL_SALVADORCOUNTRY_EQUATORIAL_GUINEACOUNTRY_ERITREACOUNTRY_ESTONIACOUNTRY_ESWATINICOUNTRY_ETHIOPIACOUNTRY_FALKLAND_ISLANDSCOUNTRY_FIJICOUNTRY_FINLANDCOUNTRY_FRANCECOUNTRY_FRENCH_GUIANACOUNTRY_FRENCH_POLYNESIACOUNTRY_GABONCOUNTRY_GAMBIACOUNTRY_GEORGIACOUNTRY_GERMANYCOUNTRY_GHANACOUNTRY_GIBRALTARCOUNTRY_GREECECOUNTRY_GREENLANDCOUNTRY_GUADELOUPECOUNTRY_GUATEMALACOUNTRY_GUINEACOUNTRY_GUINEA_BISSAUCOUNTRY_GUYANACOUNTRY_HAITICOUNTRY_HONDURASCOUNTRY_HONG_KONGCOUNTRY_HUNGARYCOUNTRY_ICELANDCOUNTRY_INDIACOUNTRY_INDONESIACOUNTRY_IRAQCOUNTRY_IRELANDCOUNTRY_ISRAELCOUNTRY_ITALYCOUNTRY_JAPANCOUNTRY_JORDANCOUNTRY_KAZAKHSTANCOUNTRY_KENYACOUNTRY_KOREA_REPUBLICCOUNTRY_KUWAITCOUNTRY_KYRGYZSTANCOUNTRY_LAO_PEOPLES_DEMOCRATIC_REPUBLICCOUNTRY_LATVIACOUNTRY_LEBANONCOUNTRY_LESOTHOCOUNTRY_LIBERIACOUNTRY_LIBYACOUNTRY_LIECHTENSTEINCOUNTRY_LITHUANIACOUNTRY_LUXEMBOURGCOUNTRY_NORTH_MACEDONIACOUNTRY_MADAGASCARCOUNTRY_MALAWICOUNTRY_MALAYSIACOUNTRY_MALDIVESCOUNTRY_MALICOUNTRY_MALTACOUNTRY_MARSHALL_ISLANDSCOUNTRY_MARTINIQUECOUNTRY_MAURITANIACOUNTRY_MAURITIUSCOUNTRY_MEXICOCOUNTRY_MICRONESIACOUNTRY_MOLDOVACOUNTRY_MONACOCOUNTRY_MONGOLLIACOUNTRY_MONTENEGROCOUNTRY_MOROCCOCOUNTRY_MOZAMBIQUECOUNTRY_MYANMARCOUNTRY_NAMIBIACOUNTRY_NAURUCOUNTRY_NEPALCOUNTRY_NETHERLANDSCOUNTRY_NEW_CALEDONIACOUNTRY_NEW_ZEALANDCOUNTRY_NICARAGUACOUNTRY_NIGERCOUNTRY_NIGERIACOUNTRY_NIUECOUNTRY_NORWAYCOUNTRY_OMANCOUNTRY_PAKISTANCOUNTRY_PALAUCOUNTRY_PALESTINECOUNTRY_PANAMACOUNTRY_PAPUA_NEW_GUINEACOUNTRY_PARAGUAYCOUNTRY_PERUCOUNTRY_PHILIPPINESCOUNTRY_POLANDCOUNTRY_PORTUGALCOUNTRY_QATARCOUNTRY_ROMANIACOUNTRY_RUSSIAN_FEDERATIONCOUNTRY_RWANDACOUNTRY_SAINT_HELENACOUNTRY_SAINT_PIERRE_AND_MIQUELONCOUNTRY_SAMOACOUNTRY_SAN_MARINOCOUNTRY_SAUDI_ARABIACOUNTRY_SENAGALCOUNTRY_SERBIACOUNTRY_SIERRA_LEONECOUNTRY_SINGAPORECOUNTRY_SINT_MAARTENCOUNTRY_SLOVAKIACOUNTRY_SLOVENIACOUNTRY_SOLOMON_ISLANDSCOUNTRY_SOMALIACOUNTRY_SOUTH_AFRICACOUNTRY_SOUTH_SUDANCOUNTRY_SPAINCOUNTRY_SRI_LANKACOUNTRY_SUDANCOUNTRY_SURINAMECOUNTRY_SWEDENCOUNTRY_SWITZERLANDCOUNTRY_SYRIAN_ARAB_REPUBLICCOUNTRY_TAIWANCOUNTRY_TAJIKISTANCOUNTRY_TANZANIACOUNTRY_THAILANDCOUNTRY_TOGOCOUNTRY_TOKELAUCOUNTRY_TONGACOUNTRY_TUNISIACOUNTRY_TURKEYCOUNTRY_TURKMENISTANCOUNTRY_TURKS_AND_CAICOS_ISLANDSCOUNTRY_TUVALUCOUNTRY_UGANDACOUNTRY_UKRAINECOUNTRY_UNITED_ARAB_EMIRATESCOUNTRY_UNITED_KINGDOM_OF_GREAT_BRITAIN_AND_NORTHERN_IRELANDCOUNTRY_UNITED_STATES_OF_AMERICACOUNTRY_URUGUAYCOUNTRY_UZBEKISTANCOUNTRY_VANUATUCOUNTRY_VENEZUELACOUNTRY_VIET_NAMCOUNTRY_WALLIS_AND_FUTUNACOUNTRY_YEMENCOUNTRY_ZAMBIACOUNTRY_ZIMBABWECOUNTRY_GLOBAL_SIP
requeue_queue_config
object (RequeueQueueConfiguration) 
requeue_queue_config
optional
The name of the Requeue Transfer Queue Configuration.
requeue_transfer_disallowed
object (RequeueTransferDisallowed) 
requeue_transfer_disallowed
optional
Disallow specific agent skills for requeue transfer routing.
pbx_transfer_disallowed
object (PbxTransferDisallowed) 
pbx_transfer_disallowed
optional
Disallow specific PBX extensions for PBX transfers.
natural_compliance_scrub
object (NaturalLanguageComplianceScrub) 
natural_compliance_scrub
optional
Whether and what NLC compliance rule to apply.
natural_language_compliance_metadata
object (NaturalLanguageComplianceMetadata) 
natural_language_compliance_metadata
optional
Transfer call natural language compliance metadata.
Optional Transfer Compliance Metadata
Required Transfer Compliance Metadata
enable_transfer
boolean 
enable_transfer
optional
Allow the agent to make transfer calls.
display_transfer_number_phone_book
boolean 
display_transfer_number_phone_book
optional
Indicates whether or not to display.
enable_transfer_number_editing
boolean 
enable_transfer_number_editing
optional
Indicates whether to allow the agent to edit the transfer number.
default_transfer_number
string 
default_transfer_number
optional
The default transfer number prepopulated in the text box.
display_transfer_country_selection
boolean 
display_transfer_country_selection
optional
Indicate whether to display the country select menu.
display_caller_id_phone_book
boolean 
display_caller_id_phone_book
optional
Indicate whether to display the caller ID phone book.
enable_caller_id_editing
boolean 
enable_caller_id_editing
optional
Indicates whether to allow the agent to edit the caller ID.
display_caller_id_country_selection
boolean 
display_caller_id_country_selection
optional
Indicates whether to display the caller ID country select menu.
display_agent_transfer_filtering
boolean 
display_agent_transfer_filtering
optional
Indicates whether to display agent transfer filtering to the agent.
default_agent_transfer_filtering
boolean 
default_agent_transfer_filtering
optional
Indicates whether to filter agents by default.
enable_hunt_group_filtering
boolean 
enable_hunt_group_filtering
optional
Indicates whether to limit transferring to agents in the same hunt group.
enable_scrub_override
boolean 
enable_scrub_override
optional
Allow agent to override scrub decisions.
enable_whitelist
boolean 
enable_whitelist
optional
Indicates whether to apply the whitelist to transfer call scrubbing.
start_recording_numbers
array[string]
start_recording_numbers
optional
Transfer numbers which will initiate recording the call.
stop_recording_numbers
array[string]
stop_recording_numbers
optional
Transfer numbers which will stop recording the call.
number_history_settings
object (NumberHistorySettings) 
number_history_settings
optional
Number History hunt group settings.
enable_search
boolean 
enable_search
optional
Allow the agent to access number history search.
enable_report_download
boolean 
enable_report_download
optional
Allow the export of the number history report.
enable_recordings_download
boolean 
enable_recordings_download
optional
Allow the export of the number history related call recordings.
enable_agent_response_editing
boolean 
enable_agent_response_editing
optional
Allow the agent to edit number history related agent call responses.
field_mask
string 
field_mask
optional
Field mask containing the fields to update.
hunt_group_sid
integer <int64> | string 
hunt_group_sid
optional
Hunt group sid.
Example
{
  "general_settings": {
    "initial_agent_status": "INITIAL_AGENT_STATUS_READY",
    "agent_pause_option_set": {
      "enabled": true,
      "set_sid": 0
    },
    "hold_queue_monitoring": {
      "agent_routing": "AGENT_ROUTING_ANY_AGENT",
      "enabled": true,
      "required_hunt_group_routing": 0,
      "preferred_hunt_group_routing": 0
    },
    "display_data_dipped_data": {
      "display_data_dip_data": true,
      "data_dip_display_keys": [
        "string"
      ]
    },
    "integration_data_display": {
      "display_integration_data": true,
      "integration_display_keys": [
        "string"
      ]
    },
    "journey_data_display": {
      "display_journey_data": true,
      "journey_display_keys": [
        "string"
      ]
    },
    "agent_call_history_scope": "AGENT_CALL_HISTORY_SCOPE_NONE",
    "agent_login_gui_statistics_display": {
      "display_agent_login_gui_statistics": true,
      "agent_login_gui_statistics_template": 0
    },
    "phone_zip_metadata_display": {
      "display_phone_zip_metadata": true,
      "phone_zip_metadata_keys": [
        "DISPLAY_OPTION_ADMIN_CODE_1"
      ]
    },
    "disallowed_hunt_groups": {
      "enabled": true,
      "hunt_groups": [
        0
      ]
    },
    "alphanumeric_keypad": {
      "delimiter": "ALPHANUMERIC_KEYPAD_DELIMITER_ASTERISK",
      "enabled": true
    },
    "inbound_compliance_metadata": {
      "enabled": true,
      "optional_data": [
        0
      ],
      "required_data": [
        0
      ]
    },
    "prepare_state_call_delivery": {
      "manual_dial": true,
      "preview_dial": true
    },
    "enable_agent_gateway_title_bar": true,
    "default_agent_dial_in": "string",
    "require_end_call_confirmation": true,
    "enable_authorization_by_ip": true,
    "enable_agent_pause": true,
    "default_agent_pause_option": "string",
    "enable_pause_option_reset": true,
    "triggered_pause_status_pause_code_waiting": "string",
    "triggered_pause_status_pause_code_wrapup": "string",
    "display_recording_indicator": true,
    "enable_call_recording_pause": true,
    "call_recording_pause_confirmation": true,
    "enable_pause_recording_on_hold": true,
    "enable_envision_screen_recording": true,
    "agent_screen_recording": true,
    "enable_agent_simple_hold": true,
    "enable_agent_multi_accept": true,
    "pause_agent_after_multi_accept": true,
    "display_machine_deliver": true,
    "display_linkback_hunt_group": true,
    "display_sip_header_data": true,
    "display_ivr_navigation_keys": true,
    "display_data_collect_data": true,
    "display_skills": true,
    "display_web_links": true,
    "enable_agent_hunt_group_reassignment": true,
    "enable_manual_approval_of_calls": true,
    "require_manual_approval_number": true,
    "enable_manual_approval_of_sms": true,
    "require_manual_approval_number_sms": true,
    "disable_reject_option_for_approvers": true,
    "enable_call_desktop_notifications": true,
    "enable_agent_intercom": true,
    "authorized_ip_addresses": [
      "string"
    ],
    "call_recording_delay": 0
  },
  "communication_settings": {
    "compliance_default_country": "COUNTRY_UNDEFINED",
    "inbound_scrub_list_expiration": {
      "default_expiration": "COMMUNICATION_EXPIRATION_NEVER",
      "limit_expiration": true,
      "limited_expirations": [
        "COMMUNICATION_EXPIRATION_NEVER"
      ]
    },
    "manual_scrub_list_expiration": {
      "default_expiration": "COMMUNICATION_EXPIRATION_NEVER",
      "limit_expiration": true,
      "limited_expirations": [
        "COMMUNICATION_EXPIRATION_NEVER"
      ]
    },
    "outbound_scrub_list_expiration": {
      "default_expiration": "COMMUNICATION_EXPIRATION_NEVER",
      "limit_expiration": true,
      "limited_expirations": [
        "COMMUNICATION_EXPIRATION_NEVER"
      ]
    },
    "preview_scrub_list_expiration": {
      "default_expiration": "COMMUNICATION_EXPIRATION_NEVER",
      "limit_expiration": true,
      "limited_expirations": [
        "COMMUNICATION_EXPIRATION_NEVER"
      ]
    },
    "automate_response_rules": {
      "enabled": true,
      "rule_sid": 0
    },
    "automate_scrub_list_call_data": {
      "enabled": true,
      "scrub_list_data_fields": [
        {
          "scrub_list": "string",
          "call_data_field": 0
        }
      ]
    },
    "enable_scrub_list_adding": true,
    "enable_scrub_list_removal": true,
    "display_options_in_wrapup": true,
    "automate_manually_dialed_scrub_list": true,
    "automate_preview_dialed_scrub_list": true,
    "scrub_lists": [
      "string"
    ],
    "scrub_lists_removal_allowed": [
      "string"
    ]
  },
  "callback_settings": {
    "default_callback_routing": {
      "routing_mode": "DEFAULT_CALLBACK_ROUTING_NONE",
      "agent_sid": 0,
      "agent_skillsets": [
        0
      ],
      "hunt_group_sids": [
        0
      ]
    },
    "callback_routing_disallowed": {
      "use_routing_limiting": true,
      "agent_sids": [
        0
      ],
      "hunt_group_sids": [
        0
      ],
      "agent_skill_sids": [
        0
      ]
    },
    "enable_callback_scheduling": true,
    "enable_callback_calling": true,
    "enable_automatic_retrieval": true,
    "enable_customizable_caller_id": true,
    "default_caller_id": "string",
    "enable_callback_calendar": true
  },
  "preview_dial_settings": {
    "enable_preview_dial_cancel": true,
    "enable_auto_pause_on_cancel": true,
    "require_number_confirmation": true,
    "preview_queue_config": "string",
    "timeout_minutes": 0
  },
  "manual_dial_settings": {
    "default_call_recording": "HUNT_GROUP_USE_ORG_DEFAULT",
    "cell_phone_scrub": "HUNT_GROUP_USE_ORG_DEFAULT",
    "time_zone_restriction": "HUNT_GROUP_USE_ORG_DEFAULT",
    "time_zone_validation_postal_code": "MANUAL_DIAL_TIME_ZONE_VALIDATION_DISABLED",
    "natural_compliance_scrub": {
      "compliance_scrub": "HUNT_GROUP_USE_ORG_DEFAULT",
      "rule_set_id": "string"
    },
    "scrub_override": {
      "enable_dncl_override": true,
      "enable_cell_scrub_override": true,
      "enable_time_zone_scrub_override": true,
      "natural_compliance_override": true
    },
    "default_outbound_country": "COUNTRY_UNDEFINED",
    "default_caller_id_country": "COUNTRY_UNDEFINED",
    "default_caller_id": {
      "usage": "DEFAULT_MANUAL_DIAL_CALLER_ID_NONE",
      "custom_caller_id": "string"
    },
    "natural_language_compliance_metadata": {
      "enabled": true,
      "optional_data": [
        0
      ],
      "required_data": [
        0
      ]
    },
    "data_dip_scope": "MANUAL_DIAL_DATA_DIP_SCOPE_DISABLED",
    "data_dip_result_handling": "MANUAL_DIAL_DATA_DIP_HANDLING_CANCEL",
    "data_dip_integration_handling": "MANUAL_DIAL_DATA_DIP_HANDLING_CANCEL",
    "enable_manual_dial": true,
    "queue_configuration_name": "string",
    "enable_whitelist": true,
    "display_outbound_country_selection": true,
    "display_outbound_number_phone_book": true,
    "display_caller_id_country_selection": true,
    "display_caller_id_phone_book": true,
    "enable_customizable_caller_id": true,
    "enable_caller_id_bucket": true,
    "automate_random_caller_id": true,
    "enable_mask_caller_id": true,
    "enable_sip_address": true,
    "data_dip_integration_mappings": [
      {
        "mapping_type": "MANUAL_DIAL_DATA_DIP_INTEGRATION_UNSPECIFIED",
        "data_dip_return_key": "string",
        "contact_field_description_sid": 0
      }
    ],
    "enable_reject_option_for_approvers": true,
    "random_caller_id_bucket": 0,
    "data_dip_config_sid": 0
  },
  "transfer_call_settings": {
    "hand_off_types": {
      "enable_conference": true,
      "enable_warm": true,
      "enable_cold": true
    },
    "recording_status": "TRANSFER_RECORDING_STATUS_KEEP_STATUS",
    "transfer_types": {
      "enable_agent_transfer": true,
      "enable_open_transfer": true,
      "enable_requeue_transfer": true,
      "enable_pbx_extension_transfer": true,
      "enable_voicemail_transfer": true
    },
    "transfer_number_country": "COUNTRY_UNDEFINED",
    "default_caller_id": {
      "usage": "DEFAULT_CALLER_ID_NONE",
      "custom_caller_id": "string"
    },
    "caller_id_country": "COUNTRY_UNDEFINED",
    "requeue_queue_config": {
      "usage": "REQUEUE_TRANSFER_QUEUE_CONFIG_CURRENT",
      "custom_name": "string"
    },
    "requeue_transfer_disallowed": {
      "enable": true,
      "agent_skill_sids": [
        0
      ],
      "hunt_group_sids": [
        0
      ]
    },
    "pbx_transfer_disallowed": {
      "enable": true,
      "extensions": [
        "string"
      ]
    },
    "natural_compliance_scrub": {
      "compliance_scrub": "HUNT_GROUP_USE_ORG_DEFAULT",
      "rule_set_id": "string"
    },
    "natural_language_compliance_metadata": {
      "enabled": true,
      "optional_data": [
        0
      ],
      "required_data": [
        0
      ]
    },
    "enable_transfer": true,
    "display_transfer_number_phone_book": true,
    "enable_transfer_number_editing": true,
    "default_transfer_number": "string",
    "display_transfer_country_selection": true,
    "display_caller_id_phone_book": true,
    "enable_caller_id_editing": true,
    "display_caller_id_country_selection": true,
    "display_agent_transfer_filtering": true,
    "default_agent_transfer_filtering": true,
    "enable_hunt_group_filtering": true,
    "enable_scrub_override": true,
    "enable_whitelist": true,
    "start_recording_numbers": [
      "string"
    ],
    "stop_recording_numbers": [
      "string"
    ]
  },
  "number_history_settings": {
    "enable_search": true,
    "enable_report_download": true,
    "enable_recordings_download": true,
    "enable_agent_response_editing": true
  },
  "field_mask": "string",
  "hunt_group_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/org/huntgroup/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "general_settings": {
        "initial_agent_status": "INITIAL_AGENT_STATUS_READY",
        "agent_pause_option_set": {
            "enabled": true,
            "set_sid": 0
        },
        "hold_queue_monitoring": {
            "agent_routing": "AGENT_ROUTING_ANY_AGENT",
            "enabled": true,
            "required_hunt_group_routing": 0,
            "preferred_hunt_group_routing": 0
        },
        "display_data_dipped_data": {
            "display_data_dip_data": true,
            "data_dip_display_keys": [
                "string"
            ]
        },
        "integration_data_display": {
            "display_integration_data": true,
            "integration_display_keys": [
                "string"
            ]
        },
        "journey_data_display": {
            "display_journey_data": true,
            "journey_display_keys": [
                "string"
            ]
        },
        "agent_call_history_scope": "AGENT_CALL_HISTORY_SCOPE_NONE",
        "agent_login_gui_statistics_display": {
            "display_agent_login_gui_statistics": true,
            "agent_login_gui_statistics_template": 0
        },
        "phone_zip_metadata_display": {
            "display_phone_zip_metadata": true,
            "phone_zip_metadata_keys": [
                "DISPLAY_OPTION_ADMIN_CODE_1"
            ]
        },
        "disallowed_hunt_groups": {
            "enabled": true,
            "hunt_groups": [
                0
            ]
        },
        "alphanumeric_keypad": {
            "delimiter": "ALPHANUMERIC_KEYPAD_DELIMITER_ASTERISK",
            "enabled": true
        },
        "inbound_compliance_metadata": {
            "enabled": true,
            "optional_data": [
                0
            ],
            "required_data": [
                0
            ]
        },
        "prepare_state_call_delivery": {
            "manual_dial": true,
            "preview_dial": true
        },
        "enable_agent_gateway_title_bar": true,
        "default_agent_dial_in": "string",
        "require_end_call_confirmation": true,
        "enable_authorization_by_ip": true,
        "enable_agent_pause": true,
        "default_agent_pause_option": "string",
        "enable_pause_option_reset": true,
        "triggered_pause_status_pause_code_waiting": "string",
        "triggered_pause_status_pause_code_wrapup": "string",
        "display_recording_indicator": true,
        "enable_call_recording_pause": true,
        "call_recording_pause_confirmation": true,
        "enable_pause_recording_on_hold": true,
        "enable_envision_screen_recording": true,
        "agent_screen_recording": true,
        "enable_agent_simple_hold": true,
        "enable_agent_multi_accept": true,
        "pause_agent_after_multi_accept": true,
        "display_machine_deliver": true,
        "display_linkback_hunt_group": true,
        "display_sip_header_data": true,
        "display_ivr_navigation_keys": true,
        "display_data_collect_data": true,
        "display_skills": true,
        "display_web_links": true,
        "enable_agent_hunt_group_reassignment": true,
        "enable_manual_approval_of_calls": true,
        "require_manual_approval_number": true,
        "enable_manual_approval_of_sms": true,
        "require_manual_approval_number_sms": true,
        "disable_reject_option_for_approvers": true,
        "enable_call_desktop_notifications": true,
        "enable_agent_intercom": true,
        "authorized_ip_addresses": [
            "string"
        ],
        "call_recording_delay": 0
    },
    "communication_settings": {
        "compliance_default_country": "COUNTRY_UNDEFINED",
        "inbound_scrub_list_expiration": {
            "default_expiration": "COMMUNICATION_EXPIRATION_NEVER",
            "limit_expiration": true,
            "limited_expirations": [
                "COMMUNICATION_EXPIRATION_NEVER"
            ]
        },
        "manual_scrub_list_expiration": {
            "default_expiration": "COMMUNICATION_EXPIRATION_NEVER",
            "limit_expiration": true,
            "limited_expirations": [
                "COMMUNICATION_EXPIRATION_NEVER"
            ]
        },
        "outbound_scrub_list_expiration": {
            "default_expiration": "COMMUNICATION_EXPIRATION_NEVER",
            "limit_expiration": true,
            "limited_expirations": [
                "COMMUNICATION_EXPIRATION_NEVER"
            ]
        },
        "preview_scrub_list_expiration": {
            "default_expiration": "COMMUNICATION_EXPIRATION_NEVER",
            "limit_expiration": true,
            "limited_expirations": [
                "COMMUNICATION_EXPIRATION_NEVER"
            ]
        },
        "automate_response_rules": {
            "enabled": true,
            "rule_sid": 0
        },
        "automate_scrub_list_call_data": {
            "enabled": true,
            "scrub_list_data_fields": [
                {
                    "scrub_list": "string",
                    "call_data_field": 0
                }
            ]
        },
        "enable_scrub_list_adding": true,
        "enable_scrub_list_removal": true,
        "display_options_in_wrapup": true,
        "automate_manually_dialed_scrub_list": true,
        "automate_preview_dialed_scrub_list": true,
        "scrub_lists": [
            "string"
        ],
        "scrub_lists_removal_allowed": [
            "string"
        ]
    },
    "callback_settings": {
        "default_callback_routing": {
            "routing_mode": "DEFAULT_CALLBACK_ROUTING_NONE",
            "agent_sid": 0,
            "agent_skillsets": [
                0
            ],
            "hunt_group_sids": [
                0
            ]
        },
        "callback_routing_disallowed": {
            "use_routing_limiting": true,
            "agent_sids": [
                0
            ],
            "hunt_group_sids": [
                0
            ],
            "agent_skill_sids": [
                0
            ]
        },
        "enable_callback_scheduling": true,
        "enable_callback_calling": true,
        "enable_automatic_retrieval": true,
        "enable_customizable_caller_id": true,
        "default_caller_id": "string",
        "enable_callback_calendar": true
    },
    "preview_dial_settings": {
        "enable_preview_dial_cancel": true,
        "enable_auto_pause_on_cancel": true,
        "require_number_confirmation": true,
        "preview_queue_config": "string",
        "timeout_minutes": 0
    },
    "manual_dial_settings": {
        "default_call_recording": "HUNT_GROUP_USE_ORG_DEFAULT",
        "cell_phone_scrub": "HUNT_GROUP_USE_ORG_DEFAULT",
        "time_zone_restriction": "HUNT_GROUP_USE_ORG_DEFAULT",
        "time_zone_validation_postal_code": "MANUAL_DIAL_TIME_ZONE_VALIDATION_DISABLED",
        "natural_compliance_scrub": {
            "compliance_scrub": "HUNT_GROUP_USE_ORG_DEFAULT",
            "rule_set_id": "string"
        },
        "scrub_override": {
            "enable_dncl_override": true,
            "enable_cell_scrub_override": true,
            "enable_time_zone_scrub_override": true,
            "natural_compliance_override": true
        },
        "default_outbound_country": "COUNTRY_UNDEFINED",
        "default_caller_id_country": "COUNTRY_UNDEFINED",
        "default_caller_id": {
            "usage": "DEFAULT_MANUAL_DIAL_CALLER_ID_NONE",
            "custom_caller_id": "string"
        },
        "natural_language_compliance_metadata": {
            "enabled": true,
            "optional_data": [
                0
            ],
            "required_data": [
                0
            ]
        },
        "data_dip_scope": "MANUAL_DIAL_DATA_DIP_SCOPE_DISABLED",
        "data_dip_result_handling": "MANUAL_DIAL_DATA_DIP_HANDLING_CANCEL",
        "data_dip_integration_handling": "MANUAL_DIAL_DATA_DIP_HANDLING_CANCEL",
        "enable_manual_dial": true,
        "queue_configuration_name": "string",
        "enable_whitelist": true,
        "display_outbound_country_selection": true,
        "display_outbound_number_phone_book": true,
        "display_caller_id_country_selection": true,
        "display_caller_id_phone_book": true,
        "enable_customizable_caller_id": true,
        "enable_caller_id_bucket": true,
        "automate_random_caller_id": true,
        "enable_mask_caller_id": true,
        "enable_sip_address": true,
        "data_dip_integration_mappings": [
            {
                "mapping_type": "MANUAL_DIAL_DATA_DIP_INTEGRATION_UNSPECIFIED",
                "data_dip_return_key": "string",
                "contact_field_description_sid": 0
            }
        ],
        "enable_reject_option_for_approvers": true,
        "random_caller_id_bucket": 0,
        "data_dip_config_sid": 0
    },
    "transfer_call_settings": {
        "hand_off_types": {
            "enable_conference": true,
            "enable_warm": true,
            "enable_cold": true
        },
        "recording_status": "TRANSFER_RECORDING_STATUS_KEEP_STATUS",
        "transfer_types": {
            "enable_agent_transfer": true,
            "enable_open_transfer": true,
            "enable_requeue_transfer": true,
            "enable_pbx_extension_transfer": true,
            "enable_voicemail_transfer": true
        },
        "transfer_number_country": "COUNTRY_UNDEFINED",
        "default_caller_id": {
            "usage": "DEFAULT_CALLER_ID_NONE",
            "custom_caller_id": "string"
        },
        "caller_id_country": "COUNTRY_UNDEFINED",
        "requeue_queue_config": {
            "usage": "REQUEUE_TRANSFER_QUEUE_CONFIG_CURRENT",
            "custom_name": "string"
        },
        "requeue_transfer_disallowed": {
            "enable": true,
            "agent_skill_sids": [
                0
            ],
            "hunt_group_sids": [
                0
            ]
        },
        "pbx_transfer_disallowed": {
            "enable": true,
            "extensions": [
                "string"
            ]
        },
        "natural_compliance_scrub": {
            "compliance_scrub": "HUNT_GROUP_USE_ORG_DEFAULT",
            "rule_set_id": "string"
        },
        "natural_language_compliance_metadata": {
            "enabled": true,
            "optional_data": [
                0
            ],
            "required_data": [
                0
            ]
        },
        "enable_transfer": true,
        "display_transfer_number_phone_book": true,
        "enable_transfer_number_editing": true,
        "default_transfer_number": "string",
        "display_transfer_country_selection": true,
        "display_caller_id_phone_book": true,
        "enable_caller_id_editing": true,
        "display_caller_id_country_selection": true,
        "display_agent_transfer_filtering": true,
        "default_agent_transfer_filtering": true,
        "enable_hunt_group_filtering": true,
        "enable_scrub_override": true,
        "enable_whitelist": true,
        "start_recording_numbers": [
            "string"
        ],
        "stop_recording_numbers": [
            "string"
        ]
    },
    "number_history_settings": {
        "enable_search": true,
        "enable_report_download": true,
        "enable_recordings_download": true,
        "enable_agent_response_editing": true
    },
    "field_mask": "string",
    "hunt_group_sid": 0
}'

Responses

🟢200OK
application/json
Success
Body
object {0}
Example
{}
🔴500Server Error
Previous
GetHuntGroupSettings
Next
CreateHuntGroup
Built with