TCN API
  1. Billing
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
        POST
      • UpdateBillingPlan
        POST
      • GetInvoice
        POST
      • ExportGeneratedInvoice
        POST
    • BillingService
      • CommitBillingPlan
      • CommitDefaultBillingPlan
      • CreateBillingPlan
      • CreateDefaultBillingPlan
      • CreateDefaultRateDefinition
      • CreateInvoice
      • CreateRateDefinition
      • DeleteBillingPlan
      • DeleteDefaultBillingPlan
      • DeleteDefaultRateDefinition
      • DeleteInvoice
      • DeleteRateDefinition
      • DuplicateBillingPlan
      • DuplicateDefaultBillingPlan
      • ExportInvoice
      • GetActiveBillingPlan
      • GetBillingPlan
      • GetBillingPlanHistory
      • GetInvoice
      • GetRateDefinition
      • ListBillingPlans
      • ListInvoices
      • ListRateDefinitions
      • UpdateBillingPlan
      • UpdateDefaultBillingPlan
      • UpdateDefaultRateDefinition
      • UpdateInvoice
      • UpdateRateDefinition
      • CreateDefaultRateDefinition
      • CreateDefaultRateDefinitions
      • CreateRateDefinition
      • CreateRateDefinitions
      • DeleteDefaultRateDefinition
      • DeleteDefaultRateDefinitions
      • DeleteRateDefinition
      • DeleteRateDefinitions
      • ExportInvoice
      • GetRateDefinition
      • GetRateHistory
      • ListActiveRateDefinitions
      • ListRateDefinitions
      • UpdateDefaultRateDefinition
      • UpdateRateDefinition
      • ListProducts
      • ApplyBillingPlanDraft
      • CreateBillingPlan
      • DeleteBillingPlan
      • GetBillingPlan
      • ListBillingPlans
      • UpdateBillingPlan
      • ApplyDefaultBillingPlanDraft
      • CreateDefaultBillingPlan
      • DeleteDefaultBillingPlan
      • GetDefaultBillingPlan
      • ListDefaultBillingPlans
      • UpdateDefaultBillingPlan
      • CreateRateDefinition
      • DeleteRateDefinition
      • GetRateDefinition
      • ListRateDefinitions
      • UpdateRateDefinition
      • CreateDefaultRateDefinition
      • DeleteDefaultRateDefinition
      • GetDefaultRateDefinition
      • ListDefaultRateDefinitions
      • UpdateDefaultRateDefinition
      • ExportInvoice
      • ApplyBillingPlanDraft
      • CloneBillingPlan
      • CreateBillingPlan
      • DeleteBillingPlan
      • GetBillingPlan
      • ListBillingPlans
      • UpdateBillingPlan
      • ApplyDefaultBillingPlanDraft
      • CloneDefaultBillingPlan
      • CreateDefaultBillingPlan
      • DeleteDefaultBillingPlan
      • GetDefaultBillingPlan
      • ListDefaultBillingPlans
      • UpdateDefaultBillingPlan
      • CreateRateDefinition
      • DeleteRateDefinition
      • GetRateDefinition
      • ListRateDefinitions
      • UpdateRateDefinition
      • CreateDefaultRateDefinition
      • DeleteDefaultRateDefinition
      • GetDefaultRateDefinition
      • ListDefaultRateDefinitions
      • UpdateDefaultRateDefinition
      • CreateMatchingRule
      • DeleteMatchingRule
      • GetMatchingRule
      • ListMatchingRules
      • UpdateMatchingRule
      • CreateBillingTag
      • DeleteBillingTag
      • GetBillingTag
      • ListBillingTags
      • UpdateBillingTag
      • ExportInvoice
    • BIReportGeneratorService
      • CreateReportJob
      • ListReportJobs
      • UpdateReportJob
      • DeleteReportJob
      • GetReportJob
      • GenerateReport
      • ListReportLogsStream
    • BusinessHoursService
      • ListBusinessHours
      • GetBusinessHours
      • SetBusinessHours
      • AddIntervalToBusinessHours
      • RemoveIntervalFromBusinessHours
      • UpdateBusinessHoursInfo
      • DeleteBusinessHours
      • EvaluateBusinessHours
    • CallMonitorService
      • GetHoldQueueStats
    • CallQueue
      • DequeuePreviewRecordOrCall
      • EnqueuePreviewRecord
      • DequeueScrubbedCallForPreviewRecord
      • ClearPreviewRecordReturnQueue
      • EnqueuePreviewDialCall
      • ClearManualDialQueue
      • ProcessManualDialCall
      • DequeueCallForManualApproval
      • EnqueueManuallyApprovedCall
      • EnqueueManuallyRejectedCall
      • RequeueManuallyApprovedCall
      • EnqueueManuallyApprovedSms
      • EnqueueManuallyRejectedSms
      • RequeueManuallyApprovedSms
      • DequeueSmsMamForManualApproval
      • DequeuePreviewRecordOrCall
      • EnqueuePreviewRecord
      • DequeueScrubbedCallForPreviewRecord
      • ClearPreviewRecordReturnQueue
      • EnqueuePreviewDialCall
      • ClearManualDialQueue
      • ProcessManualDialCall
      • DequeueCallForManualApproval
      • EnqueueManuallyApprovedCall
      • EnqueueManuallyRejectedCall
      • RequeueManuallyApprovedCall
      • EnqueueManuallyApprovedSms
      • EnqueueManuallyRejectedSms
      • RequeueManuallyApprovedSms
      • DequeueSmsMamForManualApproval
    • CBS
      • CreateServiceId
      • CreateCallbackWithDetails
      • UpdateScheduledCallbackToReady
      • UpdateScheduledCallbackToCanceled
      • GetNextScheduledCallbackWithDetails
      • UpdateScheduledCallbackToClosed
      • UpdateScheduledCallback
      • GetScheduledCallbackWithDetails
      • ListScheduledCallbacksWithDetails
      • ListScheduledCallbacksWithDetailsBySkills
    • Cfg
      • GetWebAgentConfig
      • GetWebAgentConfig
    • ClassifierFileTemplates
      • ParseFile
      • ListEvents
      • PeekList
      • UpdateFileTemplate
      • DeleteFileTemplate
      • ListFileTemplates
      • GetFileTemplate
    • Compliance
      • RuleAutoComplete
      • CheckRuleSet
      • AssignRuleSet
      • ListRuleSets
      • GetRuleSet
      • GetRuleSetByName
      • CreateRuleSet
      • RenameRuleSet
      • EnableRuleSet
      • DisableRuleSet
      • CreateScrubList
      • UpdateScrubList
      • AddScrubListEntries
      • UpdateScrubEntry
      • DeleteScrubListEntries
      • DeleteAllListEntries
      • GetScrubList
      • DeleteScrubList
      • GetDefaultRules
      • GetScrubLists
      • SearchScrubList
      • GetScrubListUploadUrl
      • ProcessScrubListUpload
      • ScrubListDownload
      • ProcessScrubListDeleteUpload
      • ScrubListDelete
      • ExportScrubList
      • PurgeScrubList
      • CreateScenario
      • UpdateScenario
      • DeleteScenario
      • RunAssignedScenarios
      • ListAllScenarios
      • ListUnassignedScenarios
      • ListAssignedRuleSets
      • ListAssignedScenarios
      • AssignScenario
      • UnassignScenario
      • EnableScenario
      • DisableScenario
      • GetFieldNames
      • GetResultDescriptions
      • CreateConsentProfile
      • CreateConsent
      • GetConsentProfile
      • GetConsent
      • GetConsentByProfileAndContent
      • GetConsentByContent
      • SearchConsentByContent
      • UpdateConsent
      • ExpireConsent
      • RevokeConsent
      • DeleteConsent
      • ProcessConsentListDeleteUpload
      • ConsentListDownload
      • EnableConsentProfile
      • DisableConsentProfile
      • ListConsentProfiles
      • GetConsentUploadUrl
      • ProcessConsentUpload
      • ExportConsentList
      • ListConsentTopics
      • GetConsentTopic
      • CreateConsentTopic
      • DeleteConsentTopic
      • UpdateConsentTopic
      • ProcessOutboundCall
      • QueryHolidays
      • GetScenario
    • ContactManager
      • GetContactList
      • ListContactEntryList
      • GetEncContactEntry
      • GetKYCEncContactEntry
      • GetKYCKeys
      • AddContactEntry
      • EditContactEntry
      • ListContactsByEntity
      • GetContactFieldType
      • ListContactActivityLog
    • Dashboards
      • CreateDashboard
      • GetDashboard
      • GetDefaultDashboard
      • ListDashboards
      • ListProductTypes
      • DeleteDashboard
      • SetDefaultDashboard
      • UpdateDashboard
      • UpdateDashboardTitleAndDescription
      • UpdateDashboardView
      • UpdateDashboardLayout
      • PublishDashboard
      • CreateApplicationDashboard
      • ListApplicationsDashboards
      • DeleteApplicationDashboard
    • DeliveryApi
      • CreateTransferConfig
      • ListTransferConfigs
      • ListTransferConfigsByCredentialID
      • UpdateTransferConfig
      • DeleteTransferConfig
      • GetTransferConfig
      • GetTransferConfigByName
      • ListHistory
      • ListHistoryByTransferConfig
      • ListCredentials
      • GetCredential
      • CreateCredential
      • DeleteCredential
      • UpdateCredential
      • CreateDeliveryDefinition
      • DeleteDeliveryDefinition
      • GetDeliveryDefinition
      • GetDeliveryDefinitionByName
      • ListDeliveryDefinitions
      • ListDeliveryDefinitionsByCredentialID
      • UpdateDeliveryDefinition
      • CreateEncryption
      • DeleteEncryption
      • GetEncryption
      • ListEncryptions
      • UpdateEncryption
      • ListSMSNumbers
      • TriggerDemoOutboundDelivery
    • ExileCertificateManagerService
      • CreateExileCertificate
      • RevokeExileCertificate
      • AssignExileConfiguration
      • UnassignExileConfiguration
      • ListExileCertificates
      • CreateExileConfiguration
      • UpdateExileConfiguration
      • DeleteExileConfiguration
      • ListExileConfigurations
    • ExplorerService
      • ListDatasourceSchemas
      • Query
      • GetSupportQuery
      • GetQueryExplain
      • GetWeeksOfData
    • FTS
      • GetUploadFileUrl
    • FtsApi
      • GetUploadFileUrl
    • GenericFinviService
      • PopAccount
    • GhostNotifierApi
      • ListNotifications
    • HuntGroupsService
      • ListHuntGroupExileLinks
      • CopyHuntGroupExileLink
      • UpdateHuntGroupExileLinks
      • ListHuntGroupAgentTriggers
      • CopyHuntGroupAgentTrigger
      • UpdateHuntGroupAgentTriggers
      • CopyHuntGroupToOrganization
      • AdminCopyHuntGroupToOrganization
      • AdminListHuntGroups
      • ListAgentScripts
      • CreateAgentClientInfoDisplayTemplate
      • UpdateAgentClientInfoDisplayTemplate
      • GetAgentClientInfoDisplayTemplate
      • ListAgentClientInfoDisplayTemplates
      • DeleteAgentClientInfoDisplayTemplate
      • AssignAgentClientInfoDisplayTemplateToHuntGroups
      • UnassignAgentClientInfoDisplayTemplateFromHuntGroups
    • IdpService
      • CreateClient
      • UpdateClient
      • DeleteClient
      • ListClients
    • Insights
      • CreateInsight
      • ListInsights
      • ListInsightsStream
      • ListOrgInsights
      • UpdateInsight
      • DeleteInsight
      • GetInsight
      • CreateCommonsInsight
      • UpdateCommonsInsight
      • DeleteCommonsInsight
      • GetVfsSchema
      • ListVfses
      • ListVfsSchemas
      • PublishInsight
      • CreateOutputConfiguration
      • ListOutputConfigurations
      • UpdateOutputConfiguration
      • DeleteOutputConfiguration
      • GetOutputConfiguration
      • SetDefaultOutputConfiguration
      • GetDefaultOutputConfiguration
    • InstantDataService
      • StreamAgentEvents
      • StreamCallerEvents
    • Integrations
      • Process
      • GetIntegrationTransaction
      • GetIntegrationTransactionReport
      • GetIntegrationTransactionReportData
      • SearchPastTransactions
      • GetAggregatedMetadata
      • GetPortalLinksByDateRange
      • CreateIntegrationConfig
      • GetIntegrationConfig
      • UpdateIntegrationConfig
      • DeleteIntegrationConfig
      • ListIntegrations
      • ListIntegrationsForOrg
      • ListIntegrationConfigNames
      • ListJourneyConfigs
      • ListNonJourneyConfigs
      • CreatePortalConfig
      • ListPortalConfigs
      • UpdatePortalConfig
      • GetPortalConfig
      • DeletePortalConfig
      • UpdatePortalLogo
      • GetPortalLogo
      • CreatePaymentPortalLinks
      • Summary
      • ListIntegrationTemplatesByConfig
      • CallEpicPatient
      • HangUpEpicPatientCall
      • GenerateEpicKeyPairs
      • PopulateIntegrationLink
      • ProcessWorkflow
      • InsertPrivateField
      • CalculateFees
      • GetIntegrationSettings
      • UpsertIntegrationSettings
      • DeliverReceipt
    • IntegrationsPublic
      • GetLinkData
      • SubmitVerification
      • SessionKeepAlive
      • GetInvoice
      • SubmitPayment
      • GetReceipt
      • ProcessWorkflow
      • GetLinkDetails
      • CalculateFees
      • DeliverReceipt
    • LabelsService
      • CreateLabel
      • GetLabel
      • UpdateLabel
      • ListLabels
      • DeleteLabel
      • AttachLabel
      • DetachLabel
      • GetLabeledEntityMap
      • AssignLabels
      • RevokeLabels
    • Learn
      • Exist
      • Content
      • ExportMany
      • SearchContent
      • ListSearchResults
      • Standalone
      • ContentEditorData
      • Update
      • StoreStaticImage
      • UploadDynamicScreenshot
      • DeleteStandalone
      • Snippet
      • DeleteLearnPages
      • CreateEditVersion
      • PublishVersion
      • ContentByVersion
      • UpdateByVersion
      • ListSearchResultsByVersion
      • ReviewFileVersions
      • ReviewVersion
      • ExportManyStream
      • ListVersions
      • ReviewVersionStream
      • DeleteVersion
      • UploadStaticImage
      • GetUpdateUrl
      • AdvancedSearch
    • Projects
      • CreateProject
      • ListProjects
      • GetProject
      • DeleteProject
      • UpdateProject
    • LMS
      • GetPublicKey
      • CreateFileTemplate
      • ListFileTemplates
      • UpdateFileTemplate
      • DeleteFileTemplate
      • GetFileTemplate
      • CreateField
      • ListFields
      • GetField
      • UpdateField
      • DeleteField
      • ListAvailableFieldsByElementId
      • ListFieldsForElement
      • ListAutocompleteFields
      • ListCampaignLinks
      • PeekList
      • GetHistory
      • CreateElement
      • ListElements
      • GetElement
      • UpdateElement
      • DeleteElement
      • CopyPipelineUpstream
      • CopyPipelineDownstream
      • ProcessElement
      • GetAvailableFields
      • ListNewEvents
      • ViewQueue
      • Autocomplete
      • GetComplianceScrubLists
      • FindFieldUsages
      • FindInvalidElements
      • CreateCollection
      • GetCollection
      • UpdateCollection
      • RetypeCollection
      • DeleteCollection
      • ListCollections
      • ResetCollection
      • AddCollectionEntry
      • DeleteCollectionEntry
      • UpdateCollectionEntry
      • StreamCollection
      • SearchCollectionsPaginated
      • GetCollectionEntries
      • CreateCjsSearchDefinition
      • GetCjsSearchDefinition
      • UpdateCjsSearchDefinition
      • DeleteCjsSearchDefinition
      • ListCjsSearchDefinitions
      • ExecuteCjsSearchDefinition
      • GetCjsSecureSearchCriteria
      • CreateCjsSecureSearchCriteria
      • UpdateCjsSecureSearchCriteria
      • SampleEndpoint
      • GetAvailableEHRFields
      • GetQueuedEventsStatusByElementId
      • ListPools
      • CreatePipelineCanvas
      • ListPipelineCanvases
      • UpdatePipelineCanvas
      • DeletePipelineCanvas
      • GetPipelineCanvas
      • GetPipelineCanvasEvents
      • DeleteFileTemplate
      • GetFileTemplate
      • ListFileTemplates
      • ParseFileTemplate
      • UpdateFileTemplate
      • ProcessList
      • StreamList
    • NewsroomAPI
      • CreateNewsArticle
      • ListNewsArticles
      • GetNewsArticleById
      • UpdateNewsArticle
      • CreatePublishedArticle
      • ListPublishedArticles
      • GetPublishedArticleById
      • UserActivity
      • GetNewsForUser
      • StoreNewsArticleImage
      • ListImagesForNewsArticle
      • UploadNewsArticleImage
      • CreateClientArticle
      • UpdateClientArticle
      • ListClientArticles
      • CreatePublishedClientArticle
      • GetPublishedClientArticleById
      • StoreClientArticleImage
      • ListImagesForClientArticle
      • UploadClientArticleImage
      • ListPublishedClientArticles
      • GetClientArticleById
    • Notifier
      • GetNotify
    • OauthService
      • GetConnectedInboxOAuthURL
    • ObservedHolidaysService
      • ListObservedHolidays
      • GetObservedHolidays
      • SetObservedHolidays
      • AddToObservedHolidays
      • RemoveObservedHolidays
      • UpdateObservedHolidaysInfo
      • DeleteObservedHolidays
      • EvaluateObservedHolidays
    • OmniApi
      • ArchiveCampaign
      • CreateCampaign
      • GetCampaignById
      • PauseCampaign
      • ResumeCampaign
      • UpdateCampaign
      • UpdateCampaignPacingSpeed
      • SendOmniMessage
      • ManagerSendOmniMessage
      • CreateDisposition
      • DeleteDisposition
      • ListDispositions
      • UpdateDisposition
      • ListCustomUnsubscribeLinks
      • CreateCustomUnsubscribeLink
      • UpdateCustomUnsubscribeLink
      • DeleteCustomUnsubscribeLink
      • ListCampaigns
      • ManagerListMessages
      • ListMessages
      • ManagerListConversations
      • ListContactLists
      • GetAvailableHeaders
      • GetOmniExchangeElements
      • GetFieldsForElement
      • ApproveTask
      • GetNextQueuedTask
      • GetTask
      • ListTasks
      • RejectTask
      • RequeueTask
      • CreateConnectedInbox
      • DeleteConnectedInboxBySid
      • GetConnectedInboxBySid
      • PerformSendgridAccountChecks
      • ListConnectedInboxes
      • TestConnectedInbox
      • UpdateConnectedInbox
      • CreateVerifiedEmail
      • DeleteVerifiedEmail
      • GetVerifiedEmailBySid
      • ListVerifiedEmails
      • ResendVerifiedEmail
      • UpdateVerifiedEmail
      • GetPendingGoogleXOAuth2Data
      • SendEmailNotification
      • SendFeedbackEmail
      • GetOmniAttachment
      • CreateTasks
      • CreateSignature
      • DeleteSignature
      • ListSignatures
      • UpdateSignature
      • SuggestResponse
      • CreateProject
      • ListProjects
      • EditProjectById
      • CloseProjectById
      • GetProjectById
      • CreateCannedMessage
      • ListCannedMessages
      • UpdateCannedMessage
      • GetCannedMessageById
      • DeleteCannedMessageById
      • CreateCannedMessageGroup
      • ListCannedMessageGroups
      • UpdateCannedMessageGroup
      • DeleteCannedMessageGroup
      • ListCannedMessagesByGroupId
      • GetCannedMessageGroupById
      • ListUserSkills
      • ListWhatsAppNumbers
      • CreateWhatsAppNumber
      • UpdateWhatsAppNumber
      • CreateManualTask
    • Org
      • RegisterOrganization
      • ConvertOrgToManual
      • UpdateOrganization
      • ArchiveOrganization
      • UnArchiveOrganization
      • ListArchivedOrganizations
      • GetOrganizationProfile
      • GetOrganizationProfileById
      • ListOrganizationDescriptions
      • ListRegionalOrganizations
      • UpdateP3OwningOrg
      • GetP3OwningOrg
      • ListOrganizationUserDescriptions
      • AdminListUserDescriptions
      • ListUserDescriptions
      • GetUserDirectory
      • GetRegions
      • GetMyUserDetails
      • GetUserDetails
      • AdminGetUserDetails
      • GetAgentUsers
      • GetAgentSettings
      • GetAgentProfileGroup
      • UpdateAgentProfileGroup
      • CreateAgentProfileGroup
      • ListAgentProfileGroups
      • DeleteAgentProfileGroup
      • AssignAgentProfileGroups
      • UpdateUser
      • UpdateMyUser
      • UpdateUserCallerId
      • CreateUser
      • CreateUserByOrgId
      • CreateDelegatedUser
      • UpdateUserPassword
      • UpdateMyUserPassword
      • UpdateUserPasswordByOrgId
      • ResetUserRequirePasswordReset
      • GetUserPasswordResetLink
      • GetMyUserPasswordResetLink
      • GetUserPasswordResetLinkByOrgId
      • GetUserEmailVerified
      • GetUserEmailVerifiedByOrgId
      • SendUserVerificationEmailByOrgId
      • SendUserVerificationEmail
      • ManualUserEmailVerificationByOrgId
      • ManualUserEmailVerification
      • GetTempUserToken
      • GetTempUserTokenByUserId
      • GetCountriesList
      • GetAdminClientPreferences
      • UpdateAdminClientPreferences
      • GetPermissions
      • RevokeAccountOwnerPermissionFromUser
      • UpdateUserDisabled
      • UpdateUserDisabledByOrgId
      • UpdateBulkUsersDisabled
      • GetOrgBillingSettingsByOrgId
      • GetOrgBillingSettings
      • SetOrgBillingSettings
      • AddOrgBillingOverride
      • RemoveOrgBillingOverride
      • GetSystemDefaultBillingRates
      • ListPermissionGroupsByOrgId
      • ListPermissionGroups
      • CreatePermissionGroup
      • UpdatePermissionGroup
      • DeletePermissionGroup
      • AssignUserToAccountOwnerPermissionGroup
      • AssignUserPermissionGroup
      • AssignUsersPermissionGroup
      • UpdateUserNeoPermissionGroups
      • RevokeUserPermissionGroup
      • RevokeUsersPermissionGroup
      • InitDefaultPermissionGroups
      • AddPermissionToAccountOwnerPermissionGroup
      • RevokePermissionToAccountOwnerPermissionGroup
      • AddPermissionToOrgDefaultGroup
      • RemovePermissionFromOrgDefaultGroup
      • GetOrgDefaultSuperUserGroup
      • ListP3PermissionGroupsByOrgId
      • ListP3PermissionGroups
      • AddUserRegion
      • RemoveUserRegion
      • CreateP3PermissionGroup
      • UpdateP3PermissionGroupByOrgId
      • UpdateP3PermissionGroup
      • DeleteP3PermissionGroup
      • AssignUsersP3PermissionGroup
      • AddLoginToUser
      • RevokeUsersP3PermissionGroup
      • GetContactPreferences
      • UpdateContactPreferences
      • GetCompliancePreferences
      • UpdateCompliancePreferences
      • GetAgentPreferences
      • UpdateAgentPreferences
      • GetOrganizationPreferences
      • UpdateOrganizationPreferences
      • GetSchedulePreferences
      • UpdateSchedulePreferences
      • GetBusinessPreferences
      • UpdateBusinessPreferences
      • GetEndOfDayPreferences
      • UpdateEndOfDayPreferences
      • GetReportFilterPreferences
      • UpdateReportFilterPreferences
      • GetPhonePreferences
      • UpdatePhonePreferences
      • GetDashboardGeneralPreferences
      • UpdateDashboardGeneralPreferences
      • GetWebhookPreferences
      • UpdateWebhookPreferences
      • GetBroadcastPreferences
      • UpdateBroadcastPreferences
      • GetAuthenticationPreferences
      • UpdateAuthenticationPreferences
      • GetRecordingPreferences
      • UpdateRecordingPreferences
      • GetDashboardQueuePreferences
      • UpdateDashboardQueuePreferences
      • GetAgentQuickViewPreferences
      • GetVoiceAnalyticsPreferences
      • UpdateVoiceAnalyticsPreferences
      • UpdateVoiceAnalyticsPreferencesEnabled
      • GetScorecardsPreferences
      • UpdateScorecardsPreferences
      • GetEmailSmsPreferences
      • UpdateEmailSmsPreferences
      • EditAgentQuickViewPreferences
      • EditBackofficeThemePreference
      • GetBackofficeThemePreference
      • AcceptLinkbackRecordingTerms
      • LinkbackUpdateBroadcastTemplates
      • RecordEmailUnsubscribeAcknowledgement
      • ClearEmailUnsubscribeAcknowledgement
      • CreateWebLinkTemplate
      • ListWebLinkTemplates
      • GetWebLinkTemplate
      • UpdateWebLinkTemplate
      • DeleteWebLinkTemplate
      • CreateAgentTriggerTemplate
      • ListAgentTriggerTemplates
      • GetAgentTriggerTemplate
      • UpdateAgentTriggerTemplate
      • DeleteAgentTriggerTemplate
      • CreateClientInfoDisplayTemplate
      • ListClientInfoDisplayTemplates
      • UpdateClientInfoDisplayTemplate
      • DeleteClientInfoDisplayTemplate
      • GetClientInfoDisplayTemplate
      • ListAgentPauseCodes
      • CreateAgentPauseCode
      • UpdateAgentPauseCode
      • DeleteAgentPauseCode
      • ListCustomReportFilters
      • CreateCustomReportFilter
      • UpdateCustomReportFilter
      • DeleteCustomReportFilter
      • ListAgentResponseGroups
      • ListLastTemplateElements
      • ListQueueConfigsByOrgId
      • DeleteQueueConfig
      • GetQueueConfig
      • CreateQueueConfig
      • UpdateQueueConfig
      • CopyQueueConfig
      • GetAllQueueConfigSounds
      • GetQueueConfigSound
      • SetQueueConfigSound
      • SetAllQueueConfigSoundsFromSource
      • GetUserBlocked
      • UnblockUser
      • ListP3UnMigratedUsers
      • MigrateP3User
      • UpdateP3UserName
      • ListOwnedUsers
      • ListOwnedOrgsByOrgId
      • ListOwnedOrgs
      • RemoveLoginStrikes
      • RemoveUserLoginStrikes
      • ListLoginHistory
      • UpdateP3UserSids
      • CreateAuthConnection
      • GetAuthConnectionSettings
      • UpdateAuthConnectionSettings
      • DeleteAuthConnection
      • GetUserSubscription
      • GetMyUserSubscription
      • AddUserSubscription
      • AddMyUserSubscription
      • RemoveUserSubscription
      • RemoveMyUserSubscription
      • UpdateUserSubscription
      • UpdateMyUserSubscription
      • ListUserSubscriptions
      • ListMyUserSubscriptions
      • ListOrgSubscriptions
      • GetSystemEnvironmentDetails
      • ListAgentStatisticsTemplates
      • CreateAgentStatisticsTemplate
      • UpdateAgentStatisticsTemplate
      • DeleteAgentStatisticsTemplate
      • CreateOrganization
      • GetOrganization
      • GetOrganizationById
      • UpdateOrganization
      • ArchiveOrganization
      • UnArchiveOrganization
      • ListAllOrganizationsGlobally
      • ListOrganizationsByRegion
      • ListArchivedOrganizations
      • ConvertOrgToManual
      • ListOwnedOrgs
      • GetOrganizationPreferences
      • UpdateOrganizationPreferences
      • GetAgentPreferences
      • UpdateAgentPreferences
      • GetContactPreferences
      • UpdateContactPreferences
      • GetAuthenticationPreferences
      • UpdateAuthenticationPreferences
      • GetWebhookPreferences
      • UpdateWebhookPreferences
      • GetDashboardGeneralPreferences
      • UpdateDashboardGeneralPreferences
      • GetDashboardQueuePreferences
      • UpdateDashboardQueuePreferences
      • GetPhonePreferences
      • UpdatePhonePreferences
      • GetCompliancePreferences
      • UpdateCompliancePreferences
      • GetBroadcastPreferences
      • UpdateBroadcastPreferences
      • GetSchedulePreferences
      • UpdateSchedulePreferences
      • GetEmailSmsPreferences
      • UpdateEmailSmsPreferences
      • GetBusinessPreferences
      • UpdateBusinessPreferences
      • UpdateAdminBusinessPreferences
      • GetScorecardsPreferences
      • UpdateScorecardsPreferences
      • GetVoiceAnalyticsPreferences
      • ListVoiceAnalyticsPreferences
      • UpdateVoiceAnalyticsPreferences
      • GetEndOfDayPreferences
      • UpdateEndOfDayPreferences
      • GetReportFilterPreferences
      • UpdateReportFilterPreferences
      • GetRecordingPreferences
      • UpdateRecordingPreferences
      • GetAdminClientPreferences
      • UpdateAdminClientPreferences
      • AcceptLinkbackRecordingTerms
      • LinkbackUpdateBroadcastTemplates
      • RecordEmailUnsubscribeAcknowledgement
      • ClearEmailUnsubscribeAcknowledgement
      • ListBusinessHours
      • GetBusinessHours
      • SetBusinessHours
      • AddIntervalToBusinessHours
      • RemoveIntervalFromBusinessHours
      • UpdateBusinessHoursInfo
      • DeleteBusinessHours
      • EvaluateBusinessHours
      • CreateUser
      • CreateDelegatedUser
      • GetMyUser
      • GetUser
      • GetUserByOrgId
      • ListAgents
      • ListPublicUsers
      • ListUsers
      • ListUsersByOrgId
      • ListUsersByRegion
      • UpdateMyUser
      • UpdateUser
      • UpdateUserLabels
      • UpdateUserCallerId
      • UpdateUserDisabled
      • UpdateUserDisabledByOrgId
      • GetMyUserPasswordResetLink
      • GetUserPasswordResetLink
      • GetUserPasswordResetLinkByOrgId
      • CreatePasswordResetLink
      • CreatePasswordResetLinkByOrgId
      • GetUserLoginInfo
      • GetUserEmailVerified
      • GetUserEmailVerifiedByOrgId
      • ResetMyPassword
      • ResetUserPassword
      • ResetUserPasswordByOrgId
      • SendUserEmailVerification
      • SendUserEmailVerificationByOrgId
      • SendPasswordReset
      • SendPasswordResetByOrgId
      • GetUserSessionData
      • GetAgentProfileGroup
      • ListAgentProfileGroups
      • UpdateAgentProfileGroup
      • CreateAgentProfileGroup
      • DeleteAgentProfileGroup
      • AssignAgentProfileGroups
      • AddUserSubscription
      • AddUserSubscriptionByUserId
      • GetUserSubscription
      • GetUserSubscriptionByUserId
      • UpdateUserSubscription
      • UpdateUserSubscriptionByUserId
      • RemoveUserSubscription
      • RemoveUserSubscriptionByUserId
      • ListUserSubscriptions
      • ListUserSubscriptionsByUserId
      • ListOrgSubscriptions
      • CreateAuthToken
      • CreateAuthTokenByUserId
      • ListAuthTokens
      • ListAuthTokensByUserId
      • SetAuthTokenExpiration
      • SetAuthTokenExpirationByUserId
      • DeleteAuthToken
      • DeleteAuthTokenByUserId
      • GetHuntGroupSettings
      • UpdateHuntGroupSettings
      • CreateHuntGroup
      • UpdateHuntGroupGeneralDetails
      • DeleteHuntGroup
      • GetHuntGroupDetails
      • ListCallerIdBuckets
      • GetDataDipTemplate
      • ListDataDipTemplates
      • CreateDataDipTemplate
      • UpdateDataDipTemplate
      • DeleteDataDipTemplate
      • CopyDataDipTemplate
      • CopyDataDipTemplateToOrganization
      • ListBroadcastTemplateGeneralDetails
      • ListAgentResponseAutoRules
      • CreateAgentResponseAutoRules
      • UpdateAgentResponseAutoRules
      • DeleteAgentResponseAutoRules
      • ListHuntGroupWebLinks
      • CopyHuntGroupWebLink
      • UpdateHuntGroupWebLinks
      • ListHuntGroupIntegrationLinks
      • CopyHuntGroupIntegrationLink
      • UpdateHuntGroupIntegrationLinks
      • GetHuntGroupClientInfoDisplayTemplate
      • CreateHuntGroupClientInfoDisplayTemplate
      • UpdateHuntGroupClientInfoDisplayTemplate
      • DeleteHuntGroupClientInfoDisplayTemplate
      • CopyHuntGroupClientInfoDisplayTemplate
      • CreateCampaignClientInfoDisplayTemplate
      • ListHuntGroupsWithClientInfoTemplateData
      • ListAgentTriggers
      • CopyAgentTrigger
      • UpdateAgentTriggers
      • ListHuntGroupScripts
      • ListOrgHuntGroupScripts
      • GetHuntGroupScript
      • CreateHuntGroupScript
      • UpdateHuntGroupScript
      • DeleteHuntGroupScript
      • AssignScriptToHuntGroups
      • UnassignScriptFromHuntGroups
      • CreateTrust
      • AcceptTrust
      • RejectTrust
      • GetTrust
      • ListIncomingTrusts
      • ListGivenTrusts
      • ListAssignableTrusts
      • DeleteTrust
      • AssignTrust
      • UnassignTrust
      • CreateLabel
      • DeleteLabel
      • ListLabels
      • GetLabel
      • UpdateLabel
      • AssignLabel
      • UnassignLabel
      • GetAssignmentCounts
      • GetAssignableLabels
      • GetPermissions
      • GetUserPermissions
      • CreatePermissionGroup
      • UpdatePermissionGroup
      • DeletePermissionGroup
      • ListPermissionGroups
      • ListPermissionGroupsByOrgId
      • AssignUsersPermissionGroup
      • RevokeUsersPermissionGroup
      • AssignLabels
      • RevokeLabels
      • AssignAccountOwnerPermissionToUser
      • RevokeAccountOwnerPermissionFromUser
      • InitDefaultPermissionGroups
      • GetAccountOwnerGroup
      • GetLicenses
      • GetOrgLicenses
      • UpdateLicenses
      • RemovePermissionFromAllPermissionGroups
      • ListP3PermissionGroups
      • ListP3PermissionGroupsByOrgId
      • CreateP3PermissionGroup
      • UpdateP3PermissionGroup
      • UpdateP3PermissionGroupByOrgId
      • DeleteP3PermissionGroup
      • AssignUsersP3PermissionGroup
      • RevokeUsersP3PermissionGroup
      • RefreshMfaLockout
      • RefreshMfaLockoutByOrgId
      • SetMfaType
      • SetMyMfaType
      • EnableUserMfa
      • EnableMyUserMfa
      • GetUserMfaInfo
      • GetMyUserMfaInfo
      • GetMyAllowedMfaMethods
      • GenerateTOTPSecret
      • VerifyTOTPCode
      • CreateBusinessHours
      • UpdateBusinessHours
      • CreateCertificateInfo
      • DeleteCertificateInfo
      • RevokeCertificateInfo
      • ListCertificateInfo
      • AddGroupedUserIPRestrictions
      • RemoveGroupedUserIPRestrictions
      • ListUsersAllowedIps
      • ListResponseEvaluators
      • GetResponseEvaluator
      • CreateResponseEvaluator
      • UpdateResponseEvaluator
      • DeleteResponseEvaluator
    • OrgLegacy
      • RegisterOrganization
    • P3Api
      • GetAgentHuntGroup
      • GetAgentSession
      • GetAgentSkills
      • CreateAgentSkill
      • UpdateAgentSkill
      • DeleteAgentSkill
      • ListAgentSkills
      • ListSkillsForCurrentAgent
      • ListSkills
      • UpdateAgentSkills
      • GetCurrentAgent
      • GetClientInfoData
      • GetClientInfoDisplayTemplate
      • ListAgentStatisticsData
      • ListPBXExtensions
      • ListAgentExtensions
      • ListHuntGroupExtensions
      • CreateExtension
      • DeleteExtension
      • UpdateExtension
      • UpdatePBXExtension
      • CreateDNCLNumbers
      • GetScriptOrResponses
      • GetHuntGroupAgentSettings
      • ListHuntGroupWebLinks
      • GetHuntGroupPauseCodes
      • ListAgentCallHistory
      • ListClientPhoneBookEntries
      • ListHuntGroupPhoneBookEntries
      • CreatePhoneBookEntry
      • UpdatePhoneBookEntry
      • DeletePhoneBookEntry
      • ListPhoneBooks
      • ListAgentTriggers
      • GetCampaignCompletionStatus
      • GetLostPeerInfo
      • GetDispositionKeys
      • GetReadyAgents
      • ListAgentQueueAndOnHoldCallData
      • SaveAgentCallResponses
      • ListAgentTransferOptions
      • UpdateAgentCallResponseValue
      • GetIntercomPeerInfo
      • ListOrgResponseEvaluators
      • GetQueueConfigurationOptionsArray
      • GetConditionalDNCLRules
      • ManualDialStart
      • ListExtendedCallHistory
      • ListWhiteListPhoneBooks
      • DownloadCallRecording
      • DownloadCallRecordings
      • PlacePreviewDialCall
      • CancelPreviewDialCall
      • UpdateTaskStatus
      • ListCallbackRoutingAgents
      • ListCallbackRoutingSkills
      • HandleRecordingDelay
      • UpdateAgentAssignedHuntGroup
      • GetCallData
      • ListHuntGroups
      • ListReassignmentHuntGroups
      • GetOrgAgentSettings
      • ListCallerIdsFromBucket
      • SaveLastCallResponse
      • ListAgentCallLogsByCallSidAndType
      • ListAgentCallResponseValues
      • GetContactSchemaByContactGroup
      • ListContactGroupDetailsByClientSid
      • GetContactGroupDetails
      • GetContactGroupSize
      • CreateContactFieldDescription
      • UpdateContactFieldDescription
      • DeleteContactFieldDescription
      • ListContactFieldDescriptions
      • ListContactFieldDescriptionsByCGSid
      • ListContactImportTemplates
      • UpdatePreviewRecordToFinished
      • UpdateAgentHuntGroup
      • MultiAgentHuntGroupAssignment
      • GetAgentProfile
      • RecalculateBilling
      • ListOutboundBroadcastTemplateData
      • MultiAgentSkillAssignment
      • MultiAgentSkillUnassignment
      • ListMAMAgentHuntGroupsByClientSid
      • ListTtsVoices
      • CreateTtsVoice
      • DeleteTtsVoice
      • ListCustomDataKeys
      • CreateCustomDataKey
      • DeleteCustomDataKey
      • UpdateCustomDataKey
      • GetActivityLogHistory
      • ListTableTemplateProperties
      • ListAgentSkillsFilters
      • ListScheduleRules
      • ListCustomReportFilters
      • ListSmsNumbers
      • GetMailMerge
      • ListDistinctPauseCodes
      • GetAgentHuntGroup
      • GetAgentSession
      • GetAgentSkills
      • CreateAgentSkill
      • UpdateAgentSkill
      • DeleteAgentSkill
      • ListSkillsForCurrentAgent
      • ListSkills
      • UpdateAgentSkills
      • GetCurrentAgent
      • GetClientInfoData
      • GetClientInfoDisplayTemplate
      • ListAgentStatisticsData
      • ListPBXExtensions
      • ListAgentExtensions
      • ListHuntGroupExtensions
      • CreateExtension
      • DeleteExtension
      • UpdateExtension
      • UpdatePBXExtension
      • CreateDNCLNumbers
      • GetScriptOrResponses
      • GetHuntGroupAgentSettings
      • ListHuntGroupWebLinks
      • GetHuntGroupPauseCodes
      • ListAgentCallHistory
      • ListClientPhoneBookEntries
      • ListHuntGroupPhoneBookEntries
      • CreatePhoneBookEntry
      • UpdatePhoneBookEntry
      • DeletePhoneBookEntry
      • ListPhoneBooks
      • ListAgentTriggers
      • GetCampaignCompletionStatus
      • GetLostPeerInfo
      • GetDispositionKeys
      • GetReadyAgents
      • ListAgentQueueAndOnHoldCallData
      • SaveAgentCallResponses
      • ListAgentTransferOptions
      • UpdateAgentCallResponseValue
      • GetIntercomPeerInfo
      • ListOrgResponseEvaluators
      • GetQueueConfigurationOptionsArray
      • GetConditionalDNCLRules
      • ManualDialStart
      • GetExtendedCallHistories
      • ListWhiteListPhoneBooks
      • DownloadCallRecording
      • DownloadCallRecordings
      • PlacePreviewDialCall
      • CancelPreviewDialCall
      • UpdateTaskStatus
      • ListCallbackRoutingAgents
      • ListCallbackRoutingSkills
      • HandleRecordingDelay
      • UpdateAgentAssignedHuntGroup
      • GetCallData
      • ListHuntGroups
      • ListReassignmentHuntGroups
      • GetOrgAgentSettings
      • ListCallerIdsFromBucket
      • SaveLastCallResponse
      • ListAgentCallLogsByCallSidAndType
      • ListAgentCallResponseValues
      • GetContactSchemaByContactGroup
      • ListContactGroupDetailsByClientSid
      • GetContactGroupDetails
      • GetContactGroupSize
      • CreateContactFieldDescription
      • DeleteContactFieldDescription
      • ListContactFieldDescriptions
      • ListContactFieldDescriptionsByCGSid
      • ListContactImportTemplates
      • UpdatePreviewRecordToFinished
      • UpdateAgentHuntGroup
      • MultiAgentHuntGroupAssignment
      • GetAgentProfile
      • RecalculateBilling
      • ListOutboundBroadcastTemplateData
      • MultiAgentSkillAssignment
      • MultiAgentSkillUnassignment
      • ListMAMAgentHuntGroupsByClientSid
      • ListTtsVoices
      • CreateTtsVoice
      • DeleteTtsVoice
      • ListCustomDataKeys
      • CreateCustomDataKey
      • DeleteCustomDataKey
      • UpdateCustomDataKey
      • GetActivityLogHistories
      • ListTableTemplateProperties
      • ListAgentSkillsFilters
      • ListScheduleRules
      • ListCustomReportFilters
      • ListSmsNumbers
    • PBXService
      • QueryPbxUsers
      • QueryRingGroups
      • UpdatePbxUser
      • UpdateRingGroup
      • CreateRingGroup
      • DeleteRingGroup
      • AssignRandomExtension
      • ListPBXUsers
      • GetPBXUser
      • ListRingGroups
      • ListRingGroupsBySipId
      • GetRingGroup
      • GetSIPAccount
      • GetSIPAccountByUserId
      • GetSIPCredentials
      • ListSIPAccounts
      • ListSIPAccountsByRingGroupId
      • UpdateSIPAccount
      • UpdateRingGroup
      • CreateRingGroup
      • DeleteRingGroup
      • AssignRandomExtension
    • PortalManagerApi
      • UpsertPortalConfig
      • ListPortalConfigs
      • GetPortalConfig
      • DeletePortalConfig
      • UpdatePortalConfigLogo
      • GetPortalConfigLogo
      • ListPortalLinks
      • GetPortalLink
      • DeletePortalLink
      • CreatePortalLinks
      • UpsertPortal
      • GetPortal
      • DeletePortal
      • ListPortals
      • ListDetailedPortals
      • GetDetailedPortal
      • UpsertPluginInstance
      • GetPluginInstance
      • DeletePluginInstance
      • ClonePluginInstance
      • ListPluginInstance
      • ListFlowFieldNames
      • ListAvailableVerificationFields
      • ListAvailablePaymentFields
      • ListPortalTypes
      • ListPortalWorkflows
      • ListAllActionDefinitions
      • ListPluginsByMethod
    • Scorecards
      • CreateScorecard
      • ListScorecards
      • UpdateScorecard
      • DeleteScorecard
      • GetScorecard
      • CreateQuestion
      • ListQuestions
      • UpdateQuestion
      • DeleteQuestion
      • GetQuestion
      • BulkCreateQuestions
      • CreateCategory
      • ListCategories
      • UpdateCategory
      • DeleteCategory
      • GetCategory
      • CreateScorecardQuestion
      • UpdateScorecardQuestion
      • DeleteScorecardQuestion
      • GetScorecardQuestion
      • CreateSection
      • ListSections
      • UpdateSection
      • GetSection
      • DeleteSection
      • CreateQuestionCategory
      • DeleteQuestionCategory
      • CreateEvaluation
      • DeleteEvaluation
      • ScoreEvaluation
      • UpdateEvaluation
      • GetEvaluation
      • ListEvaluations
      • CreateEvaluationQuestion
      • UpdateEvaluationQuestion
      • DeleteEvaluationQuestion
      • SampleCallsByCategory
      • SampleAgentConversations
      • CreateAutoQuestion
      • UpdateAutoQuestion
      • DeleteAutoQuestion
      • GetAutoQuestion
      • GetAutoEvaluation
      • ListAutoEvaluations
      • StreamAutoEvaluations
      • DeleteAutoEvaluation
      • PreviewEvaluationScore
      • RestoreEvaluation
      • CreateSmartQuestion
      • UpdateSmartQuestion
      • DeleteSmartQuestion
      • ListSmartEvaluations
      • DeleteSmartEvaluation
      • GetSmartEvaluation
    • ScorecardsSupport
      • ListEvaluationsByOrgId
      • ListAutoEvaluationsByOrgId
      • BulkDeleteEvaluations
      • BulkDeleteAutoEvaluations
      • DeleteEvaluationByOrgId
      • DeleteAutoEvaluationByOrgId
      • ListScorecardsByOrgId
      • ListCategoriesByOrgId
    • Sds
      • GetAgentResponseData
      • GetCall
      • UpdateAgentResponseData
      • UpdateVoicemailBox
    • Sentinel
      • SendEvents
      • SendEvents
    • SkillsService
      • CreateSkillGroup
      • ListSkillGroups
      • UpdateSkillGroup
      • GetSkillGroup
      • DeleteSkillGroup
      • RemoveSkillFromAllGroups
      • AssignSkillGroups
      • UpdateUsersOnSkillGroup
      • RevokeSkillGroups
      • GetUserSkillGroups
      • GetUserSkills
      • GetSkillGroupMembers
      • ListSkillGroupsMembers
      • GetAgentSkills
      • ListSkillsForCurrentAgent
      • ListAssignedSkillGroups
      • AssignOwnSkillGroups
      • RevokeOwnSkillGroups
    • SmsApi
      • ListSmsTemplates
      • CreateSmsTemplate
      • UpdateSmsTemplate
      • DeleteSmsTemplate
      • GetSmsTemplateBySid
      • ListSmsIntentTemplates
      • CreateSmsIntentTemplate
      • UpdateSmsIntentTemplate
      • DeleteSmsIntentTemplate
      • GetSmsIntentTemplateBySid
      • ListSmsSourceNumbers
      • CreateSmsSourceNumber
      • UpdateSmsSourceNumber
      • DeleteSmsSourceNumber
      • GetSmsSourceNumberBySid
      • SendSmsNotification
      • ListSmsGroupByFilters
      • ListSmsGroupsByGroupSids
      • ListSmsTasksByGroupSids
      • ListSmsGroupByFiltersForAudit
      • ListSmsGroupsByGroupSidsForAudit
      • ListSmsTasksByGroupSidsForAudit
      • ListSmsTasksWithDetailedStatus
      • UpdateSmsGroupStatus
      • UpdateSmsGroupSendsPerMinute
      • UpdateSmsGroupScheduleTimes
      • ScheduleSms
      • ResendUnconnectedSms
      • SmsActivitySearch
      • CreateInboundSmsTemplate
      • UpdateInboundSmsTemplate
      • DeleteInboundSmsTemplate
      • ListInboundSmsTemplates
      • GetInboundSmsTemplateById
      • CreateInboundSmsGroup
      • UpdateInboundSmsGroup
      • DeleteInboundSmsGroup
      • ListInboundSmsGroups
      • ListActiveInboundSmsGroups
      • ListInboundSmsGroupByFilters
      • GetInboundSmsGroupById
      • ListInboundSmsGroupsByGroupIds
      • StopInboundSmsGroup
      • ScheduleInboundSms
      • CreateSmsConversation
      • UpdateSmsConversation
      • DeleteSmsConversation
      • ListSmsConversations
      • GetSmsConversationById
      • GetSmsMessage
      • CreateSmsConversationAudit
      • ListSmsConversationAudits
      • GetSmsConversationAuditById
      • CreateSmsConversationAssignedAgent
      • ListSmsConversationAssignedAgents
      • GetSmsConversationAssignedAgentById
      • ListInboundSmsTasksByGroupIds
      • StopAllOutboundSmsGroups
      • StopAllInboundSmsGroups
    • Soundboard
      • GetSoundboardFile
      • CreateSoundboard
      • ListSoundboards
      • UpdateSoundboard
      • DeleteSoundboard
    • Srec
      • ListScreenRecordings
      • GetScreenRecordingURL
      • DeleteScreenRecording
    • TasksService
      • CancelTasks
      • BulkCancelTasks
    • Tickets
      • CreateTicket
      • EditTicket
      • ListTickets
      • AssignTicket
      • CloseTicket
      • ViewTicket
      • CreateComment
      • EnableProject
      • ListEnabledProjects
      • CreateSLA
      • ListSLA
      • UpdateSLA
      • ListSLACondition
      • ReplyComment
      • ListTicketAuditLog
      • AssignSelf
      • EditMaskTicket
      • ListAllocatedTickets
      • ListAvailableAgentTickets
      • ListAgentTickets
      • ListSkills
      • ListUsers
      • CloseTicketAction
      • AssignTicketAction
      • CreateTicketAction
      • ChangeTicketStatus
      • CreateTicketTemplate
      • EditTicketTemplate
      • ListTicketTemplate
      • AssignTicketTemplate
      • GetAllActionType
      • GetPhoneNumberType
      • AddEntityRef
      • ListTicketsByEntityRef
      • ListEntityRefsByTicket
      • CreateCustomField
      • EditCustomField
      • ListCustomFields
    • TranslationsService
      • TranslateTemplate
      • ListTranslations
      • ListLanguages
      • ListContexts
      • CreateTranslation
      • UpdateTranslation
      • TriggerLLMTranslation
      • TriggerLLMTranslations
      • SetSystemMessage
      • GetSystemMessage
      • TestSystemMessage
      • EnableContext
      • DisableContext
      • DeleteTranslationsByTemplate
      • BulkDeleteTranslations
    • TrustsService
      • CreateTrust
      • AcceptTrust
      • RejectTrust
      • GetTrust
      • ListIncomingTrusts
      • ListGivenTrusts
      • ListAssignableTrusts
      • DeleteTrust
      • AssignTrust
      • UnassignTrust
    • UsersService
      • CreateUser
      • CreateDelegatedUser
      • GetMyUser
      • GetUser
      • GetUserByOrgId
      • ListAgents
      • ListPublicUsers
      • ListUsers
      • ListUsersByOrgId
      • ListUsersByRegion
      • UpdateMyUser
      • UpdateUser
      • UpdateUserLabels
      • UpdateUserCallerId
      • UpdateUserDisabled
      • UpdateUserDisabledByOrgId
      • GetMyUserPasswordResetLink
      • GetUserPasswordResetLink
      • GetUserPasswordResetLinkByOrgId
      • CreatePasswordResetLink
      • CreatePasswordResetLinkByOrgId
      • GetUserLoginInfo
      • GetUserEmailVerified
      • GetUserEmailVerifiedByOrgId
      • ResetMyPassword
      • ResetUserPassword
      • ResetUserPasswordByOrgId
      • SendUserEmailVerification
      • SendUserEmailVerificationByOrgId
      • SendPasswordReset
      • SendPasswordResetByOrgId
      • GetUserSessionData
      • GetAgentProfileGroup
      • ListAgentProfileGroups
      • UpdateAgentProfileGroup
      • CreateAgentProfileGroup
      • DeleteAgentProfileGroup
      • AssignAgentProfileGroups
      • AddUserSubscription
      • AddUserSubscriptionByUserId
      • GetUserSubscription
      • GetUserSubscriptionByUserId
      • UpdateUserSubscription
      • UpdateUserSubscriptionByUserId
      • RemoveUserSubscription
      • RemoveUserSubscriptionByUserId
      • ListUserSubscriptions
      • ListUserSubscriptionsByUserId
      • ListOrgSubscriptions
      • CreateAuthToken
      • CreateAuthTokenByUserId
      • ListAuthTokens
      • ListAuthTokensByUserId
      • SetAuthTokenExpiration
      • SetAuthTokenExpirationByUserId
      • DeleteAuthToken
      • DeleteAuthTokenByUserId
      • RefreshMfaLockout
      • RefreshMfaLockoutByOrgId
      • SetMfaType
      • SetMyMfaType
      • EnableUserMfa
      • EnableMyUserMfa
      • GetUserMfaInfo
      • GetMyUserMfaInfo
      • AddGroupedUserIPRestrictions
      • RemoveGroupedUserIPRestrictions
      • ListUsersAllowedIps
    • Vanalytics
      • Audit
      • GetRecordingUrl
      • ListBillingSpan
      • Search
      • ListTranscriptGroupNames
      • BulkDeleteTranscripts
      • BulkRestoreTranscripts
      • ListAgentResponseValues
      • GetTranscriptSummary
      • CreateFilter
      • ListFilters
      • UpdateFilter
      • DeleteFilter
      • GetFilter
      • GetFlag
      • CreateFlag
      • ListFlags
      • UpdateFlag
      • DeleteFlag
      • CreateFlagReview
      • BulkCreateFlagReview
      • ListFlagReviews
      • CreateFlagTranscript
      • SearchFlagTranscripts
      • CreateFlagFilter
      • ListFlagFilters
      • DeleteFlagFilter
      • ListFlagSnapshots
      • ListFlagTranscriptFilters
      • CreateCorrection
      • GetCorrection
      • DeleteCorrection
      • ListCorrections
      • UpdateCorrection
      • Audit
      • GetRecordingUrl
      • ListBillingSpan
      • SearchTranscripts
      • BulkDeleteTranscripts
      • BulkRestoreTranscripts
      • ListTranscriptGroupNames
      • ListAgentResponseValues
      • GetTranscriptSummary
      • CreateFilter
      • ListFilters
      • UpdateFilter
      • DeleteFilter
      • GetFilter
      • ListFlagTranscriptFilters
      • ListFlagFilters
      • GetFlag
      • CreateFlag
      • ListFlags
      • UpdateFlag
      • DeleteFlag
      • CreateFlagReview
      • BulkCreateFlagReview
      • ListFlagReviews
      • CreateFlagTranscript
      • ListFlagSnapshots
      • CreateCorrection
      • GetCorrection
      • DeleteCorrection
      • ListCorrections
      • UpdateCorrection
    • VanalyticsSupport
      • DeleteFlagTranscript
      • SearchByOrgId
    • Vmds
      • GetVoicemailMetadata
      • GetVoicemailMessageCount
      • DeleteVoicemail
      • DeleteGreeting
      • UpdateUploadName
      • UpdateVoicemailFlagRead
      • DownloadMessage
      • DownloadMessages
      • DownloadGreetingForExtension
      • DownloadGreeting
      • GetUploadGreetingUrl
      • ProcessGreetingUpload
      • UpdateGreetingForExtension
      • ListAvailableGreetings
    • VmdsService
      • DownloadSpecifiedMessages
    • WFM
      • PerformInitialClientSetup
      • 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. Billing

UpdateBillingPlan

POST
https://api.cbf.tcn.com/api/v1alpha1/billing/updatebillingplan
Billing

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
billing_details
array[object (Detail) {8}] 
billing_details
deprecated
event_type
enum<string> 
event_type
deprecated
This enum will hold all application classes and sub-classes
Classes are encoded as hundreds (100, 200...) and sub-classes are the class ID + 0..99.
EventType is the source for typing subscriptions, notifications, and any future
event use cases such auditing, billing, logging, etc. (anything triggered by audit).
Follow the pattern of (product + event description), separated by underscores.
e.g. PRODUCT_EVENT_DESCRIPTION
EventTypes that trigger notifications should read nicely as a system message header.
e.g Product Event Description
Allowed values:
DUMMY_APPLICATIONDUMMY_APPLICATION_STORAGEDUMMY_APPLICATION_COMPUTEVOICE_ANALYTICSVOICE_ANALYTICS_FLAG_OCCURRENCEVOICE_ANALYTICS_FLAG_NEEDS_REVIEWVOICE_ANALYTICS_BILLING_REPORTVOICE_ANALYTICS_FLAG_SUMMARYVOICE_ANALYTICS_PHRASE_CORRECTIONVOICE_ANALYTICS_CREATE_TRANSCRIPTVOICE_ANALYTICS_CREATE_SENTIMENTVOICE_ANALYTICS_CREATE_SUMMARYOMNICHANNELOMNICHANNEL_PROJECTOMNICHANNEL_CAMPAIGNOMNICHANNEL_DAILY_PROJECT_REPORTOMNICHANNEL_DAILY_CONVERSATION_REPORTOMNICHANNEL_AGENT_ASSIGN_CONVERSATIONOMNICHANNEL_AGENT_UNASSIGN_CONVERSATIONOMNICHANNEL_AGENT_REASSIGN_CONVERSATIONOMNICHANNEL_T10OMNICHANNEL_CUSTOMER_TEXT_MESSAGEOMNICHANNEL_AGENT_TEXT_MESSAGEOMNICHANNEL_FINISH_WRAP_UPOMNICHANNEL_BEGIN_WRAP_UPOMNICHANNEL_T11OMNICHANNEL_CREATE_CONVERSATIONOMNICHANNEL_AGENT_SUSPENDOMNICHANNEL_CLOSE_CONVERSATIONOMNICHANNEL_MANAGER_TEXT_MESSAGEOMNICHANNEL_UPDATE_CAMPAIGNOMNICHANNEL_SET_CONVERSATION_COLLECTED_DATAOMNICHANNEL_ARCHIVE_CAMPAIGNOMNICHANNEL_PAUSE_CAMPAIGNOMNICHANNEL_RESUME_CAMPAIGNOMNICHANNEL_START_CAMPAIGNOMNICHANNEL_SCHEDULE_MODULEOMNICHANNEL_START_MODULEOMNICHANNEL_PAUSE_MODULEOMNICHANNEL_RESUME_MODULEOMNICHANNEL_ERROR_MODULEOMNICHANNEL_SUCCESS_MODULEOMNICHANNEL_FAIL_MODULEOMNICHANNEL_COMPLETE_MODULEOMNICHANNEL_ARCHIVE_MODULEOMNICHANNEL_UPDATE_MODULEOMNICHANNEL_MODULE_SMS_MESSAGE_SENTOMNICHANNEL_COMPLETE_CAMPAIGNOMNICHANNEL_MODULE_INITIAL_REPLYOMNICHANNEL_TASK_MESSAGE_SENTOMNICHANNEL_CONNECTED_INBOX_POLLOMNICHANNEL_CONNECTED_INBOX_CREATEDOMNICHANNEL_AGENT_MESSAGE_UNITSOMNICHANNEL_MANAGER_MESSAGE_UNITSOMNICHANNEL_CUSTOMER_MESSAGE_UNITSOMNICHANNEL_SYSTEM_MESSAGE_UNITSOMNICHANNEL_PAYMENT_LINK_SENTOMNICHANNEL_MANUAL_APPROVE_TASK_ACCEPTEDOMNICHANNEL_MANUAL_APPROVE_TASK_REJECTEDOMNICHANNEL_MANUAL_APPROVE_TASK_TIMEOUTOMNICHANNEL_MANUAL_APPROVE_TASK_REQUEUEOMNICHANNEL_TRANSCRIPT_SAVEDOMNICHANNEL_MESSAGE_SENTOMNICHANNEL_PROVIDER_RESPONSEOMNICHANNEL_PROVIDER_MESSAGE_FAILEDASM_AGENT_LOGINASM_OPEN_VOICEASM_OPEN_OMNI_AGENTASM_ACTIVATE_CONVERSATIONASM_DEACTIVATE_CONVERSATIONASM_AGENT_STATE_CHANGEDASM_AGENT_LOGOUTASM_PAUSE_EVENTASM_RESUME_EVENTASM_CONVERSATION_PULLED_EVENTSCORECARDS_CREATE_QUESTION_EVENTSCORECARDS_UPDATE_QUESTION_EVENTSCORECARDS_DELETE_QUESTION_EVENTSCORECARDS_CREATE_SCORECARD_EVENTSCORECARDS_UPDATE_SCORECARD_EVENTSCORECARDS_DELETE_SCORECARD_EVENTSCORECARDS_CLONE_SCORECARD_EVENTSCORECARDS_CREATE_EVALUATION_EVENTSCORECARDS_DELETE_EVALUATION_EVENTSCORECARDS_CREATE_SECTION_EVENTSCORECARDS_UPDATE_SECTION_EVENTSCORECARDS_DELETE_SECTION_EVENTSCORECARDS_CREATE_CATEGORY_EVENTSCORECARDS_UPDATE_CATEGORY_EVENTSCORECARDS_DELETE_CATEGORY_EVENTSCORECARDS_CREATE_EVALUATION_QUESTION_EVENTSCORECARDS_UPDATE_EVALUATION_QUESTION_EVENTSCORECARDS_DELETE_EVALUATION_QUESTION_EVENTSCORECARDS_CREATE_SCORECARD_QUESTION_EVENTSCORECARDS_UPDATE_SCORECARD_QUESTION_EVENTSCORECARDS_DELETE_SCORECARD_QUESTION_EVENTSCORECARDS_CREATE_AUTO_EVALUATION_EVENTSCORECARDS_UPDATE_EVALUATION_EVENTSCORECARDS_CREATE_SMART_EVALUATION_EVENTTICKET_CREATE_EVENTTICKET_EDIT_EVENTTICKET_CLOSE_EVENTTICKET_ACTION_CREATE_EVENTTICKET_ACTION_EDIT_EVENTTICKET_ACTION_STATE_CHANGE_EVENTTICKET_PARTICIPANT_EVENTTICKET_CREATE_COMMENT_EVENTTICKET_REPLY_COMMENT_EVENTTICKET_TEMPLATE_CREATE_EVENTTICKET_TEMPLATE_EDIT_EVENTTICKET_TEMPLATE_CLOSE_EVENTTICKET_TEMPLATE_ASSIGN_EVENTTICKET_TEMPLATE_STATE_CHANGE_EVENTTICKET_PROJECT_STATE_CHANGE_EVENTTICKET_CONTACT_ADD_EVENTTICKET_CUSTOM_FIELD_CREATE_EVENTTICKET_CUSTOM_FIELD_EDIT_EVENTCOMPLIANCE_RND_QUERY_EVENTCOMPLIANCE_RND_QUERY_CACHED_EVENTAGENT_TRAINING_CREATE_LEARNING_OPPORTUNITY_EVENTLMS_PIPELINE_FAILURE_EVENTLMS_PIPELINE_NO_OUTPUT_EVENTLMS_PIPELINE_SUCCESSFUL_EVENTEVENT_TYPE_BILLING_COMMIT_BILLING_PLANEVENT_TYPE_BILLING_CREATE_BILLING_PLANEVENT_TYPE_BILLING_CREATE_INVOICEEVENT_TYPE_BILLING_CREATE_RATE_DEFINITIONEVENT_TYPE_BILLING_DELETE_BILLING_PLANEVENT_TYPE_BILLING_DELETE_INVOICEEVENT_TYPE_BILLING_DELETE_RATE_DEFINITIONEVENT_TYPE_BILLING_EXPORT_INVOICEEVENT_TYPE_BILLING_UPDATE_BILLING_PLANEVENT_TYPE_BILLING_UPDATE_INVOICEEVENT_TYPE_BILLING_UPDATE_RATE_DEFINITIONEVENT_TYPE_BILLING_RATED_ITEMS_GENERATEDEVENT_TYPE_BILLING_ACCUMULATE_ITEMSEVENT_TYPE_DELIVERY_FAILUREEVENT_TYPE_DELIVERY_SUCCESSEVENT_TYPE_CONTACT_MANAGER_ADD_EVENTEVENT_TYPE_CONTACT_MANAGER_ENTRY_VIEW_EVENTEVENT_TYPE_CONTACT_MANAGER_KYC_ENC_VIEW_EVENTEVENT_TYPE_CONTACT_MANAGER_TTL_EVENTEVENT_TYPE_CONTACT_MANAGER_EDIT_EVENTEVENT_TYPE_CONTACT_MANAGER_UPLOAD_EVENTEVENT_TYPE_CONTACT_MANAGER_VERIFICATION_EVENTEVENT_TYPE_CONTACT_MANAGER_DELETE_EVENTEVENT_TYPE_CONTACT_MANAGER_EXPUNGE_EVENTEVENT_TYPE_CONTACT_MANAGER_ENTITY_ASSOCIATED_EVENTEVENT_TYPE_ORGANIZATION_ACCESS_TOKENS_EXPIRING_EVENTEVENT_TYPE_WFM_PUBLISH_SCHEDULE_EVENTEVENT_TYPE_P3_AMQP_CALL_RESULT_EVENTEVENT_TYPE_P3_AMQP_AGENT_RESPONSE_EVENT
config_type
enum<string> 
config_type
deprecated
Allowed values:
DETAIL_CONFIG_TYPE_UNSPECIFIEDDETAIL_CONFIG_TYPE_NOOPDETAIL_CONFIG_TYPE_AGENT_SEATSDETAIL_CONFIG_TYPE_AGENT_TEXT_MESSAGE_CHATDETAIL_CONFIG_TYPE_AGENT_TEXT_MESSAGE_EMAIL_MESSAGEDETAIL_CONFIG_TYPE_AGENT_TEXT_MESSAGE_EMAIL_SIZEDETAIL_CONFIG_TYPE_AGENT_TEXT_MESSAGE_SMSDETAIL_CONFIG_TYPE_TASK_MESSAGE_SENT_EMAIL_MESSAGEDETAIL_CONFIG_TYPE_TASK_MESSAGE_SENT_EMAIL_SIZEDETAIL_CONFIG_TYPE_TASK_MESSAGE_SENT_SMSDETAIL_CONFIG_TYPE_CONNECTED_INBOX_POLLDETAIL_CONFIG_TYPE_MANAGER_TEXT_MESSAGE_CHATDETAIL_CONFIG_TYPE_MANAGER_TEXT_MESSAGE_EMAIL_MESSAGEDETAIL_CONFIG_TYPE_MANAGER_TEXT_MESSAGE_EMAIL_SIZEDETAIL_CONFIG_TYPE_MANAGER_TEXT_MESSAGE_SMSDETAIL_CONFIG_TYPE_CUSTOMER_TEXT_MESSAGE_CHATDETAIL_CONFIG_TYPE_CUSTOMER_TEXT_MESSAGE_EMAIL_MESSAGEDETAIL_CONFIG_TYPE_CUSTOMER_TEXT_MESSAGE_EMAIL_SIZEDETAIL_CONFIG_TYPE_CUSTOMER_TEXT_MESSAGE_SMSDETAIL_CONFIG_TYPE_AGENT_TEXT_MESSAGE_CHAT_SIZEDETAIL_CONFIG_TYPE_MANAGER_TEXT_MESSAGE_CHAT_SIZEDETAIL_CONFIG_TYPE_CUSTOMER_TEXT_MESSAGE_CHAT_SIZEDETAIL_CONFIG_TYPE_CONNECTED_INBOX_CREATEDDETAIL_CONFIG_TYPE_AGENT_TEXT_MESSAGE_SMS_SIZEDETAIL_CONFIG_TYPE_MANAGER_TEXT_MESSAGE_SMS_SIZEDETAIL_CONFIG_TYPE_CUSTOMER_TEXT_MESSAGE_SMS_SIZEDETAIL_CONFIG_TYPE_TASK_MESSAGE_SENT_SMS_SIZEDETAIL_CONFIG_TYPE_AGENT_CHAT_MESSAGE_UNITSDETAIL_CONFIG_TYPE_AGENT_EMAIL_MESSAGE_UNITSDETAIL_CONFIG_TYPE_AGENT_SMS_MESSAGE_UNITSDETAIL_CONFIG_TYPE_MANAGER_CHAT_MESSAGE_UNITSDETAIL_CONFIG_TYPE_MANAGER_EMAIL_MESSAGE_UNITSDETAIL_CONFIG_TYPE_MANAGER_SMS_MESSAGE_UNITSDETAIL_CONFIG_TYPE_CUSTOMER_CHAT_MESSAGE_UNITSDETAIL_CONFIG_TYPE_CUSTOMER_EMAIL_MESSAGE_UNITSDETAIL_CONFIG_TYPE_CUSTOMER_SMS_MESSAGE_UNITSDETAIL_CONFIG_TYPE_SYSTEM_CHAT_MESSAGE_UNITSDETAIL_CONFIG_TYPE_SYSTEM_EMAIL_MESSAGE_UNITSDETAIL_CONFIG_TYPE_SYSTEM_SMS_MESSAGE_UNITSBillingDetailConfigType_COMPLIANCE_RND_QUERYBillingDetailConfigType_COMPLIANCE_RND_QUERY_CACHED
config
config
deprecated
date_created
string <date-time>
date_created
deprecated

A Timestamp represents a point in time independent of any time zone or local
calendar, encoded as a count of seconds and fractions of seconds at
nanosecond resolution. The count is relative to an epoch at UTC midnight on
January 1, 1970, in the proleptic Gregorian calendar which extends the
Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear
.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339
date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the
RFC 3339 format. That is, the
format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
where {year} is always expressed using four digits while {month}, {day},
{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
is required. A proto3 JSON serializer should always use UTC (as indicated by
"Z") when printing the Timestamp type and a proto3 JSON parser should be
able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the
standard
toISOString()
method. In Python, a standard datetime.datetime object can be converted
to this format using
strftime with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:
1s1.000340012s
date_modified
string <date-time>
date_modified
deprecated

A Timestamp represents a point in time independent of any time zone or local
calendar, encoded as a count of seconds and fractions of seconds at
nanosecond resolution. The count is relative to an epoch at UTC midnight on
January 1, 1970, in the proleptic Gregorian calendar which extends the
Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear
.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339
date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the
RFC 3339 format. That is, the
format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
where {year} is always expressed using four digits while {month}, {day},
{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
is required. A proto3 JSON serializer should always use UTC (as indicated by
"Z") when printing the Timestamp type and a proto3 JSON parser should be
able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the
standard
toISOString()
method. In Python, a standard datetime.datetime object can be converted
to this format using
strftime with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:
1s1.000340012s
deleted_on
string <date-time>
deleted_on
deprecated

A Timestamp represents a point in time independent of any time zone or local
calendar, encoded as a count of seconds and fractions of seconds at
nanosecond resolution. The count is relative to an epoch at UTC midnight on
January 1, 1970, in the proleptic Gregorian calendar which extends the
Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear
.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339
date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the
RFC 3339 format. That is, the
format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
where {year} is always expressed using four digits while {month}, {day},
{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
is required. A proto3 JSON serializer should always use UTC (as indicated by
"Z") when printing the Timestamp type and a proto3 JSON parser should be
able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the
standard
toISOString()
method. In Python, a standard datetime.datetime object can be converted
to this format using
strftime with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:
1s1.000340012s
billing_detail_sid
integer <int64> | string 
billing_detail_sid
deprecated
billing_plan_id
integer <int64> | string 
billing_plan_id
deprecated
org_id
string 
org_id
deprecated
Example
{
  "billing_details": [
    {
      "event_type": "DUMMY_APPLICATION",
      "config_type": "DETAIL_CONFIG_TYPE_UNSPECIFIED",
      "config": {
        "agent_chat_message_units_config": {
          "rate": 0
        }
      },
      "date_created": "1s",
      "date_modified": "1s",
      "deleted_on": "1s",
      "billing_detail_sid": 0,
      "billing_plan_id": 0
    }
  ],
  "org_id": "string"
}

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/billing/updatebillingplan' \
--header 'Content-Type: application/json' \
--data-raw '{
    "billing_details": [
        {
            "event_type": "DUMMY_APPLICATION",
            "config_type": "DETAIL_CONFIG_TYPE_UNSPECIFIED",
            "config": {
                "agent_chat_message_units_config": {
                    "rate": 0
                }
            },
            "date_created": "1s",
            "date_modified": "1s",
            "deleted_on": "1s",
            "billing_detail_sid": 0,
            "billing_plan_id": 0
        }
    ],
    "org_id": "string"
}'

Responses

🟢200OK
application/json
Success
Body
billing_plan
object (Plan) 
billing_plan
deprecated
create_time
string <date-time>
create_time
deprecated

A Timestamp represents a point in time independent of any time zone or local
calendar, encoded as a count of seconds and fractions of seconds at
nanosecond resolution. The count is relative to an epoch at UTC midnight on
January 1, 1970, in the proleptic Gregorian calendar which extends the
Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear
.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339
date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the
RFC 3339 format. That is, the
format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
where {year} is always expressed using four digits while {month}, {day},
{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
is required. A proto3 JSON serializer should always use UTC (as indicated by
"Z") when printing the Timestamp type and a proto3 JSON parser should be
able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the
standard
toISOString()
method. In Python, a standard datetime.datetime object can be converted
to this format using
strftime with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:
1s1.000340012s
update_time
string <date-time>
update_time
deprecated

A Timestamp represents a point in time independent of any time zone or local
calendar, encoded as a count of seconds and fractions of seconds at
nanosecond resolution. The count is relative to an epoch at UTC midnight on
January 1, 1970, in the proleptic Gregorian calendar which extends the
Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear
.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339
date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the
RFC 3339 format. That is, the
format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
where {year} is always expressed using four digits while {month}, {day},
{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
is required. A proto3 JSON serializer should always use UTC (as indicated by
"Z") when printing the Timestamp type and a proto3 JSON parser should be
able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the
standard
toISOString()
method. In Python, a standard datetime.datetime object can be converted
to this format using
strftime with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:
1s1.000340012s
start_time
string <date-time>
start_time
deprecated

A Timestamp represents a point in time independent of any time zone or local
calendar, encoded as a count of seconds and fractions of seconds at
nanosecond resolution. The count is relative to an epoch at UTC midnight on
January 1, 1970, in the proleptic Gregorian calendar which extends the
Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear
.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339
date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the
RFC 3339 format. That is, the
format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
where {year} is always expressed using four digits while {month}, {day},
{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
is required. A proto3 JSON serializer should always use UTC (as indicated by
"Z") when printing the Timestamp type and a proto3 JSON parser should be
able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the
standard
toISOString()
method. In Python, a standard datetime.datetime object can be converted
to this format using
strftime with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:
1s1.000340012s
end_time
string <date-time>
end_time
deprecated

A Timestamp represents a point in time independent of any time zone or local
calendar, encoded as a count of seconds and fractions of seconds at
nanosecond resolution. The count is relative to an epoch at UTC midnight on
January 1, 1970, in the proleptic Gregorian calendar which extends the
Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear
.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339
date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the
RFC 3339 format. That is, the
format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
where {year} is always expressed using four digits while {month}, {day},
{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
is required. A proto3 JSON serializer should always use UTC (as indicated by
"Z") when printing the Timestamp type and a proto3 JSON parser should be
able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the
standard
toISOString()
method. In Python, a standard datetime.datetime object can be converted
to this format using
strftime with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:
1s1.000340012s
details
array[object (Detail) {8}] 
details
deprecated
org_id
string 
org_id
deprecated
billing_plan_id
integer <int64> | string 
billing_plan_id
deprecated
Example
{
  "billing_plan": {
    "create_time": "1s",
    "update_time": "1s",
    "start_time": "1s",
    "end_time": "1s",
    "details": [
      {
        "event_type": "DUMMY_APPLICATION",
        "config_type": "DETAIL_CONFIG_TYPE_UNSPECIFIED",
        "config": {
          "agent_chat_message_units_config": {
            "rate": 0
          }
        },
        "date_created": "1s",
        "date_modified": "1s",
        "deleted_on": "1s",
        "billing_detail_sid": 0,
        "billing_plan_id": 0
      }
    ],
    "org_id": "string",
    "billing_plan_id": 0
  }
}
🔴500Server Error
Previous
GetBillingPlan
Next
GetInvoice
Built with