TCN API
  1. OmniApi
TCN API
  • API Edition 1
    • Acd
      • AgentGetStatusStream
      • AgentGetStatus
      • AgentGetConnectedParty
      • ManagerAgentGetConnectedParty
      • AgentIntercom
      • AgentIntercomAccept
      • AgentIntercomReject
      • AgentIntercomCancel
      • DialManualPrepare
      • DialManualCancel
      • DialPreviewPrepare
      • AgentPause
      • AgentSetReady
      • AgentGUIBusy
      • ReportAgentSessionEvent
      • CallerRequeue
      • AgentDisconnect
      • TransferWarmToOutboundCancel
      • TransferWarmToAgentCancel
      • TransferWarmToOutboundApprove
      • TransferWarmToAgentApprove
      • CallerSendToVoicemail
      • AgentInviteTransferCallerToConference
      • AgentMonitorCalls
      • TransferColdToOutbound
      • TransferColdToAgent
      • TransferWarmToOutboundStart
      • CreateWarmOutboundTransferMember
      • RemoveTransferMember
      • TransferWarmToAgentStart
      • AgentGetCallFromHold
      • AgentGetSpecificCallFromHold
      • ACDGetAllAgentsStatuses
      • AgentPutCallOnHold
      • AgentReceiveMessage
      • AgentPBXApproveCall
      • AgentPBXRejectCall
      • GetCallerLostPeer
      • CallerGetRawEvent
      • PeerAgentWithCaller
      • HoldTransferMember
      • UnholdTransferMember
      • GetAgentCallCounts
      • WarmCallerTransferStart
      • WarmCallerTransferCancel
      • WarmCallerTransferApprove
      • PlaySoundboardEntity
      • StopSoundboardEntity
      • UpdateAgentSkills
      • PlayDTMF
      • AgentMute
      • AgentUnmute
      • StartSecureForm
      • CollectSecureFormField
      • ResetSecureFormField
      • AcceptSecureFormField
      • ProcessSecureForm
      • FinishSecureFormHandling
      • PopulateWorkflowFields
      • ValidateField
      • ListAgentsVoiceStatuses
    • AgentSmith
      • FollowAgent
    • AgentTrainingService
      • CreateLearningOpportunity
      • ListLearningOpportunities
      • ListAgentLearningOpportunities
      • CompleteAgentLearningOpportunity
      • ListDashboards
      • ListManagerDashboards
      • UpdateLearningOpportunity
      • DeleteLearningOpportunity
      • GetLearningOpportunity
    • AgentTrainingSupportService
      • ListLearningOpportunitiesByOrgId
      • DeleteLearningOpportunityByOrgId
    • Ana
      • GetSpecifiedVisualizations
      • RegisterAccount
      • SetWeeks
      • SetDefaultTimeFilter
      • SetDefaultDashboard
      • GetAccount
      • GetSpecifiedAccount
      • GetAuthorizedAnalyticsLink
      • GenerateMonthlyBilling
      • GetTimeZone
      • SetTimeZone
      • CopyDashViz
      • GetSpecifiedBillingSummary
      • GetBillingSummary
      • EnableCustomReports
      • DisableCustomReports
      • MakeAdoptable
      • MakeUnadoptable
      • AdoptAnaAccount
      • DisownAnaAccount
      • GetAccessibleClients
      • GetFamily
      • GetAllowedDataVisibility
      • GetCurrentDataVisibility
      • GetIndicesVisibility
      • GetAuditableDataVisibility
      • GetOrganizationNames
      • GenerateVizDataById
      • GetClientStatus
      • ReloadClientData
      • ListVisualizationsLegacy
    • Asm
      • StreamAgentState
      • ManagerStreamAgentState
      • PushEvents
      • CreateSession
      • EndSession
      • GetCurrentSession
      • EnableVoice
      • DisableVoice
      • ListConversations
      • AssignNewConversation
      • ListAgents
      • SetConversationCollectedData
      • GetQueuesDetails
    • AsmApi
      • CreateSession
      • GetStatus
      • EndSession
      • GetCurrentSession
      • SwitchSubsession
      • ListConversations
      • AssignNewConversation
      • ListAgents
      • SetConversationCollectedData
      • GetQueuesDetails
    • AsmService
      • CreateSession
      • EndSession
      • GetCurrentSession
      • EnableVoice
      • DisableVoice
      • ListAsmUserDetails
      • PushEvents
    • AuthConnectionService
      • CreateAuthConnection
      • ListAuthConnectionIds
      • GetAuthConnectionSettings
      • GetAuthConnection
      • DeleteAuthConnection
      • UpdateAuthConnectionSecret
      • UpdateAuthConnectionGroups
    • Billing
      • GetBillingPlan
      • UpdateBillingPlan
      • GetInvoice
      • ExportGeneratedInvoice
    • BillingService
      • CommitBillingPlan
      • CommitDefaultBillingPlan
      • CreateBillingPlan
      • CreateDefaultBillingPlan
      • CreateDefaultRateDefinition
      • CreateInvoice
      • CreateRateDefinition
      • DeleteBillingPlan
      • DeleteDefaultBillingPlan
      • DeleteDefaultRateDefinition
      • DeleteInvoice
      • DeleteRateDefinition
      • DuplicateBillingPlan
      • DuplicateDefaultBillingPlan
      • ExportInvoice
      • GetActiveBillingPlan
      • GetBillingPlan
      • GetBillingPlanHistory
      • GetInvoice
      • GetRateDefinition
      • ListBillingPlans
      • ListInvoices
      • ListRateDefinitions
      • UpdateBillingPlan
      • UpdateDefaultBillingPlan
      • UpdateDefaultRateDefinition
      • UpdateInvoice
      • UpdateRateDefinition
      • CreateDefaultRateDefinition
      • CreateDefaultRateDefinitions
      • CreateRateDefinition
      • CreateRateDefinitions
      • DeleteDefaultRateDefinition
      • DeleteDefaultRateDefinitions
      • DeleteRateDefinition
      • DeleteRateDefinitions
      • ExportInvoice
      • GetRateDefinition
      • GetRateHistory
      • ListActiveRateDefinitions
      • ListRateDefinitions
      • UpdateDefaultRateDefinition
      • UpdateRateDefinition
      • ListProducts
      • ApplyBillingPlanDraft
      • CreateBillingPlan
      • DeleteBillingPlan
      • GetBillingPlan
      • ListBillingPlans
      • UpdateBillingPlan
      • ApplyDefaultBillingPlanDraft
      • CreateDefaultBillingPlan
      • DeleteDefaultBillingPlan
      • GetDefaultBillingPlan
      • ListDefaultBillingPlans
      • UpdateDefaultBillingPlan
      • CreateRateDefinition
      • DeleteRateDefinition
      • GetRateDefinition
      • ListRateDefinitions
      • UpdateRateDefinition
      • CreateDefaultRateDefinition
      • DeleteDefaultRateDefinition
      • GetDefaultRateDefinition
      • ListDefaultRateDefinitions
      • UpdateDefaultRateDefinition
      • ExportInvoice
      • ApplyBillingPlanDraft
      • CloneBillingPlan
      • CreateBillingPlan
      • DeleteBillingPlan
      • GetBillingPlan
      • ListBillingPlans
      • UpdateBillingPlan
      • ApplyDefaultBillingPlanDraft
      • CloneDefaultBillingPlan
      • CreateDefaultBillingPlan
      • DeleteDefaultBillingPlan
      • GetDefaultBillingPlan
      • ListDefaultBillingPlans
      • UpdateDefaultBillingPlan
      • CreateRateDefinition
      • DeleteRateDefinition
      • GetRateDefinition
      • ListRateDefinitions
      • UpdateRateDefinition
      • CreateDefaultRateDefinition
      • DeleteDefaultRateDefinition
      • GetDefaultRateDefinition
      • ListDefaultRateDefinitions
      • UpdateDefaultRateDefinition
      • CreateMatchingRule
      • DeleteMatchingRule
      • GetMatchingRule
      • ListMatchingRules
      • UpdateMatchingRule
      • CreateBillingTag
      • DeleteBillingTag
      • GetBillingTag
      • ListBillingTags
      • UpdateBillingTag
      • ExportInvoice
    • BIReportGeneratorService
      • CreateReportJob
      • ListReportJobs
      • UpdateReportJob
      • DeleteReportJob
      • GetReportJob
      • GenerateReport
      • ListReportLogsStream
    • BusinessHoursService
      • ListBusinessHours
      • GetBusinessHours
      • SetBusinessHours
      • AddIntervalToBusinessHours
      • RemoveIntervalFromBusinessHours
      • UpdateBusinessHoursInfo
      • DeleteBusinessHours
      • EvaluateBusinessHours
    • CallMonitorService
      • GetHoldQueueStats
    • CallQueue
      • DequeuePreviewRecordOrCall
      • EnqueuePreviewRecord
      • DequeueScrubbedCallForPreviewRecord
      • ClearPreviewRecordReturnQueue
      • EnqueuePreviewDialCall
      • ClearManualDialQueue
      • ProcessManualDialCall
      • DequeueCallForManualApproval
      • EnqueueManuallyApprovedCall
      • EnqueueManuallyRejectedCall
      • RequeueManuallyApprovedCall
      • EnqueueManuallyApprovedSms
      • EnqueueManuallyRejectedSms
      • RequeueManuallyApprovedSms
      • DequeueSmsMamForManualApproval
      • DequeuePreviewRecordOrCall
      • EnqueuePreviewRecord
      • DequeueScrubbedCallForPreviewRecord
      • ClearPreviewRecordReturnQueue
      • EnqueuePreviewDialCall
      • ClearManualDialQueue
      • ProcessManualDialCall
      • DequeueCallForManualApproval
      • EnqueueManuallyApprovedCall
      • EnqueueManuallyRejectedCall
      • RequeueManuallyApprovedCall
      • EnqueueManuallyApprovedSms
      • EnqueueManuallyRejectedSms
      • RequeueManuallyApprovedSms
      • DequeueSmsMamForManualApproval
    • CBS
      • CreateServiceId
      • CreateCallbackWithDetails
      • UpdateScheduledCallbackToReady
      • UpdateScheduledCallbackToCanceled
      • GetNextScheduledCallbackWithDetails
      • UpdateScheduledCallbackToClosed
      • UpdateScheduledCallback
      • GetScheduledCallbackWithDetails
      • ListScheduledCallbacksWithDetails
      • ListScheduledCallbacksWithDetailsBySkills
    • Cfg
      • GetWebAgentConfig
      • GetWebAgentConfig
    • ClassifierFileTemplates
      • ParseFile
      • ListEvents
      • PeekList
      • UpdateFileTemplate
      • DeleteFileTemplate
      • ListFileTemplates
      • GetFileTemplate
    • Compliance
      • RuleAutoComplete
      • CheckRuleSet
      • AssignRuleSet
      • ListRuleSets
      • GetRuleSet
      • GetRuleSetByName
      • CreateRuleSet
      • RenameRuleSet
      • EnableRuleSet
      • DisableRuleSet
      • CreateScrubList
      • UpdateScrubList
      • AddScrubListEntries
      • UpdateScrubEntry
      • DeleteScrubListEntries
      • DeleteAllListEntries
      • GetScrubList
      • DeleteScrubList
      • GetDefaultRules
      • GetScrubLists
      • SearchScrubList
      • GetScrubListUploadUrl
      • ProcessScrubListUpload
      • ScrubListDownload
      • ProcessScrubListDeleteUpload
      • ScrubListDelete
      • ExportScrubList
      • PurgeScrubList
      • CreateScenario
      • UpdateScenario
      • DeleteScenario
      • RunAssignedScenarios
      • ListAllScenarios
      • ListUnassignedScenarios
      • ListAssignedRuleSets
      • ListAssignedScenarios
      • AssignScenario
      • UnassignScenario
      • EnableScenario
      • DisableScenario
      • GetFieldNames
      • GetResultDescriptions
      • CreateConsentProfile
      • CreateConsent
      • GetConsentProfile
      • GetConsent
      • GetConsentByProfileAndContent
      • GetConsentByContent
      • SearchConsentByContent
      • UpdateConsent
      • ExpireConsent
      • RevokeConsent
      • DeleteConsent
      • ProcessConsentListDeleteUpload
      • ConsentListDownload
      • EnableConsentProfile
      • DisableConsentProfile
      • ListConsentProfiles
      • GetConsentUploadUrl
      • ProcessConsentUpload
      • ExportConsentList
      • ListConsentTopics
      • GetConsentTopic
      • CreateConsentTopic
      • DeleteConsentTopic
      • UpdateConsentTopic
      • ProcessOutboundCall
      • QueryHolidays
      • GetScenario
    • ContactManager
      • GetContactList
      • ListContactEntryList
      • GetEncContactEntry
      • GetKYCEncContactEntry
      • GetKYCKeys
      • AddContactEntry
      • EditContactEntry
      • ListContactsByEntity
      • GetContactFieldType
      • ListContactActivityLog
    • Dashboards
      • CreateDashboard
      • GetDashboard
      • GetDefaultDashboard
      • ListDashboards
      • ListProductTypes
      • DeleteDashboard
      • SetDefaultDashboard
      • UpdateDashboard
      • UpdateDashboardTitleAndDescription
      • UpdateDashboardView
      • UpdateDashboardLayout
      • PublishDashboard
      • CreateApplicationDashboard
      • ListApplicationsDashboards
      • DeleteApplicationDashboard
    • DeliveryApi
      • CreateTransferConfig
      • ListTransferConfigs
      • ListTransferConfigsByCredentialID
      • UpdateTransferConfig
      • DeleteTransferConfig
      • GetTransferConfig
      • GetTransferConfigByName
      • ListHistory
      • ListHistoryByTransferConfig
      • ListCredentials
      • GetCredential
      • CreateCredential
      • DeleteCredential
      • UpdateCredential
      • CreateDeliveryDefinition
      • DeleteDeliveryDefinition
      • GetDeliveryDefinition
      • GetDeliveryDefinitionByName
      • ListDeliveryDefinitions
      • ListDeliveryDefinitionsByCredentialID
      • UpdateDeliveryDefinition
      • CreateEncryption
      • DeleteEncryption
      • GetEncryption
      • ListEncryptions
      • UpdateEncryption
      • ListSMSNumbers
      • TriggerDemoOutboundDelivery
    • ExileCertificateManagerService
      • CreateExileCertificate
      • RevokeExileCertificate
      • AssignExileConfiguration
      • UnassignExileConfiguration
      • ListExileCertificates
      • CreateExileConfiguration
      • UpdateExileConfiguration
      • DeleteExileConfiguration
      • ListExileConfigurations
    • ExplorerService
      • ListDatasourceSchemas
      • Query
      • GetSupportQuery
      • GetQueryExplain
      • GetWeeksOfData
    • FTS
      • GetUploadFileUrl
    • FtsApi
      • GetUploadFileUrl
    • GenericFinviService
      • PopAccount
    • GhostNotifierApi
      • ListNotifications
    • HuntGroupsService
      • ListHuntGroupExileLinks
      • CopyHuntGroupExileLink
      • UpdateHuntGroupExileLinks
      • ListHuntGroupAgentTriggers
      • CopyHuntGroupAgentTrigger
      • UpdateHuntGroupAgentTriggers
      • CopyHuntGroupToOrganization
      • AdminCopyHuntGroupToOrganization
      • AdminListHuntGroups
      • ListAgentScripts
      • CreateAgentClientInfoDisplayTemplate
      • UpdateAgentClientInfoDisplayTemplate
      • GetAgentClientInfoDisplayTemplate
      • ListAgentClientInfoDisplayTemplates
      • DeleteAgentClientInfoDisplayTemplate
      • AssignAgentClientInfoDisplayTemplateToHuntGroups
      • UnassignAgentClientInfoDisplayTemplateFromHuntGroups
    • IdpService
      • CreateClient
      • UpdateClient
      • DeleteClient
      • ListClients
    • Insights
      • CreateInsight
      • ListInsights
      • ListInsightsStream
      • ListOrgInsights
      • UpdateInsight
      • DeleteInsight
      • GetInsight
      • CreateCommonsInsight
      • UpdateCommonsInsight
      • DeleteCommonsInsight
      • GetVfsSchema
      • ListVfses
      • ListVfsSchemas
      • PublishInsight
      • CreateOutputConfiguration
      • ListOutputConfigurations
      • UpdateOutputConfiguration
      • DeleteOutputConfiguration
      • GetOutputConfiguration
      • SetDefaultOutputConfiguration
      • GetDefaultOutputConfiguration
    • InstantDataService
      • StreamAgentEvents
      • StreamCallerEvents
    • Integrations
      • Process
      • GetIntegrationTransaction
      • GetIntegrationTransactionReport
      • GetIntegrationTransactionReportData
      • SearchPastTransactions
      • GetAggregatedMetadata
      • GetPortalLinksByDateRange
      • CreateIntegrationConfig
      • GetIntegrationConfig
      • UpdateIntegrationConfig
      • DeleteIntegrationConfig
      • ListIntegrations
      • ListIntegrationsForOrg
      • ListIntegrationConfigNames
      • ListJourneyConfigs
      • ListNonJourneyConfigs
      • CreatePortalConfig
      • ListPortalConfigs
      • UpdatePortalConfig
      • GetPortalConfig
      • DeletePortalConfig
      • UpdatePortalLogo
      • GetPortalLogo
      • CreatePaymentPortalLinks
      • Summary
      • ListIntegrationTemplatesByConfig
      • CallEpicPatient
      • HangUpEpicPatientCall
      • GenerateEpicKeyPairs
      • PopulateIntegrationLink
      • ProcessWorkflow
      • InsertPrivateField
      • CalculateFees
      • GetIntegrationSettings
      • UpsertIntegrationSettings
      • DeliverReceipt
    • IntegrationsPublic
      • GetLinkData
      • SubmitVerification
      • SessionKeepAlive
      • GetInvoice
      • SubmitPayment
      • GetReceipt
      • ProcessWorkflow
      • GetLinkDetails
      • CalculateFees
      • DeliverReceipt
    • LabelsService
      • CreateLabel
      • GetLabel
      • UpdateLabel
      • ListLabels
      • DeleteLabel
      • AttachLabel
      • DetachLabel
      • GetLabeledEntityMap
      • AssignLabels
      • RevokeLabels
    • Learn
      • Exist
      • Content
      • ExportMany
      • SearchContent
      • ListSearchResults
      • Standalone
      • ContentEditorData
      • Update
      • StoreStaticImage
      • UploadDynamicScreenshot
      • DeleteStandalone
      • Snippet
      • DeleteLearnPages
      • CreateEditVersion
      • PublishVersion
      • ContentByVersion
      • UpdateByVersion
      • ListSearchResultsByVersion
      • ReviewFileVersions
      • ReviewVersion
      • ExportManyStream
      • ListVersions
      • ReviewVersionStream
      • DeleteVersion
      • UploadStaticImage
      • GetUpdateUrl
      • AdvancedSearch
    • Projects
      • CreateProject
      • ListProjects
      • GetProject
      • DeleteProject
      • UpdateProject
    • LMS
      • GetPublicKey
      • CreateFileTemplate
      • ListFileTemplates
      • UpdateFileTemplate
      • DeleteFileTemplate
      • GetFileTemplate
      • CreateField
      • ListFields
      • GetField
      • UpdateField
      • DeleteField
      • ListAvailableFieldsByElementId
      • ListFieldsForElement
      • ListAutocompleteFields
      • ListCampaignLinks
      • PeekList
      • GetHistory
      • CreateElement
      • ListElements
      • GetElement
      • UpdateElement
      • DeleteElement
      • CopyPipelineUpstream
      • CopyPipelineDownstream
      • ProcessElement
      • GetAvailableFields
      • ListNewEvents
      • ViewQueue
      • Autocomplete
      • GetComplianceScrubLists
      • FindFieldUsages
      • FindInvalidElements
      • CreateCollection
      • GetCollection
      • UpdateCollection
      • RetypeCollection
      • DeleteCollection
      • ListCollections
      • ResetCollection
      • AddCollectionEntry
      • DeleteCollectionEntry
      • UpdateCollectionEntry
      • StreamCollection
      • SearchCollectionsPaginated
      • GetCollectionEntries
      • CreateCjsSearchDefinition
      • GetCjsSearchDefinition
      • UpdateCjsSearchDefinition
      • DeleteCjsSearchDefinition
      • ListCjsSearchDefinitions
      • ExecuteCjsSearchDefinition
      • GetCjsSecureSearchCriteria
      • CreateCjsSecureSearchCriteria
      • UpdateCjsSecureSearchCriteria
      • SampleEndpoint
      • GetAvailableEHRFields
      • GetQueuedEventsStatusByElementId
      • ListPools
      • CreatePipelineCanvas
      • ListPipelineCanvases
      • UpdatePipelineCanvas
      • DeletePipelineCanvas
      • GetPipelineCanvas
      • GetPipelineCanvasEvents
      • DeleteFileTemplate
      • GetFileTemplate
      • ListFileTemplates
      • ParseFileTemplate
      • UpdateFileTemplate
      • ProcessList
      • StreamList
    • NewsroomAPI
      • CreateNewsArticle
      • ListNewsArticles
      • GetNewsArticleById
      • UpdateNewsArticle
      • CreatePublishedArticle
      • ListPublishedArticles
      • GetPublishedArticleById
      • UserActivity
      • GetNewsForUser
      • StoreNewsArticleImage
      • ListImagesForNewsArticle
      • UploadNewsArticleImage
      • CreateClientArticle
      • UpdateClientArticle
      • ListClientArticles
      • CreatePublishedClientArticle
      • GetPublishedClientArticleById
      • StoreClientArticleImage
      • ListImagesForClientArticle
      • UploadClientArticleImage
      • ListPublishedClientArticles
      • GetClientArticleById
    • Notifier
      • GetNotify
    • OauthService
      • GetConnectedInboxOAuthURL
    • ObservedHolidaysService
      • ListObservedHolidays
      • GetObservedHolidays
      • SetObservedHolidays
      • AddToObservedHolidays
      • RemoveObservedHolidays
      • UpdateObservedHolidaysInfo
      • DeleteObservedHolidays
      • EvaluateObservedHolidays
    • OmniApi
      • ArchiveCampaign
        POST
      • CreateCampaign
        POST
      • GetCampaignById
        POST
      • PauseCampaign
        POST
      • ResumeCampaign
        POST
      • UpdateCampaign
        POST
      • UpdateCampaignPacingSpeed
        POST
      • SendOmniMessage
        POST
      • ManagerSendOmniMessage
        POST
      • CreateDisposition
        POST
      • DeleteDisposition
        POST
      • ListDispositions
        POST
      • UpdateDisposition
        POST
      • ListCustomUnsubscribeLinks
        POST
      • CreateCustomUnsubscribeLink
        POST
      • UpdateCustomUnsubscribeLink
        POST
      • DeleteCustomUnsubscribeLink
        POST
      • ListCampaigns
        POST
      • ManagerListMessages
        POST
      • ListMessages
        POST
      • ManagerListConversations
        POST
      • ListContactLists
        POST
      • GetAvailableHeaders
        POST
      • GetOmniExchangeElements
        POST
      • GetFieldsForElement
        POST
      • ApproveTask
        POST
      • GetNextQueuedTask
        POST
      • GetTask
        POST
      • ListTasks
        POST
      • RejectTask
        POST
      • RequeueTask
        POST
      • CreateConnectedInbox
        POST
      • DeleteConnectedInboxBySid
        POST
      • GetConnectedInboxBySid
        POST
      • PerformSendgridAccountChecks
        POST
      • ListConnectedInboxes
        POST
      • TestConnectedInbox
        POST
      • UpdateConnectedInbox
        POST
      • CreateVerifiedEmail
        POST
      • DeleteVerifiedEmail
        POST
      • GetVerifiedEmailBySid
        POST
      • ListVerifiedEmails
        POST
      • ResendVerifiedEmail
        POST
      • UpdateVerifiedEmail
        POST
      • GetPendingGoogleXOAuth2Data
        POST
      • SendEmailNotification
        POST
      • SendFeedbackEmail
        POST
      • GetOmniAttachment
        POST
      • CreateTasks
        POST
      • CreateSignature
        POST
      • DeleteSignature
        POST
      • ListSignatures
        POST
      • UpdateSignature
        POST
      • SuggestResponse
        POST
      • CreateProject
        POST
      • ListProjects
        POST
      • EditProjectById
        POST
      • CloseProjectById
        POST
      • GetProjectById
        POST
      • CreateCannedMessage
        POST
      • ListCannedMessages
        POST
      • UpdateCannedMessage
        POST
      • GetCannedMessageById
        POST
      • DeleteCannedMessageById
        POST
      • CreateCannedMessageGroup
        POST
      • ListCannedMessageGroups
        POST
      • UpdateCannedMessageGroup
        POST
      • DeleteCannedMessageGroup
        POST
      • ListCannedMessagesByGroupId
        POST
      • GetCannedMessageGroupById
        POST
      • ListUserSkills
        POST
      • ListWhatsAppNumbers
        POST
      • CreateWhatsAppNumber
        POST
      • UpdateWhatsAppNumber
        POST
      • CreateManualTask
        POST
    • 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. OmniApi

ListMessages

POST
https://api.cbf.tcn.com/api/v0alpha/omniapi/listmessages
OmniApi
Get a stream of conversation message for a given conversation. Used
only for agents/users. It is not for customers.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
ListMessagesReq
optional
One of
timestamp
string <date-time>
google.protobuf.Timestamp
optional

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
channel_type
enum<string> 
ChannelType
optional
Allowed values:
CHANNEL_TYPE_EMAILCHANNEL_TYPE_SMSCHANNEL_TYPE_CHATCHANNEL_TYPE_VOICECHANNEL_TYPE_WHATSAPP
live
boolean 
live
optional
live flag
by_conversation_sid
object 
ByConversationSid
required
Example
{
  "by_conversation_sid": {
    "conversation_sid": 0
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/omniapi/listmessages' \
--header 'Content-Type: application/json' \
--data-raw '{
    "by_conversation_sid": {
        "conversation_sid": 0
    }
}'

Responses

🟢200OK
application/json
Success
Body
user_id
string 
user_id
optional
this is the user id that sent the message - this can be not set which would
be the case if it's not an agent message
channel_type
enum<string> 
channel_type
optional
the message channel type
Allowed values:
CHANNEL_TYPE_EMAILCHANNEL_TYPE_SMSCHANNEL_TYPE_CHATCHANNEL_TYPE_VOICECHANNEL_TYPE_WHATSAPP
reference_id
string 
reference_id
optional
this is how the message is referenced by the outside world
chat = not set
email = email message header
sms = not set
whatsapp = not set
payload
payload
optional
this is the payload of the message
One of
assign_conversation
object 
OmniAssignConversation
required
assign conversation to agent
conversation_sid
object (Int64Id) 
conversation_sid
optional
the id of the conversation. This is not required to be set because the message could
belong to a outbound campaign only
value
integer <int64> | string 
value
optional
status
enum<string> 
status
optional
the current status of the message.
Allowed values:
OMNI_MESSAGE_CREATEDOMNI_INBOUND_MESSAGE_RECEIVEDOMNI_OUTBOUND_MESSAGE_RECEIVEDOMNI_OUTBOUND_MESSAGE_WAITINGOMNI_OUTBOUND_MESSAGE_PROCESSINGOMNI_OUTBOUND_MESSAGE_DNCOMNI_OUTBOUND_MESSAGE_INVALIDOMNI_OUTBOUND_MESSAGE_ATTACHMENT_ERROROMNI_OUTBOUND_MESSAGE_CANCELLEDOMNI_OUTBOUND_MESSAGE_QUEUEDOMNI_OUTBOUND_MESSAGE_DELIVEREDOMNI_OUTBOUND_MESSAGE_DROPPEDOMNI_OUTBOUND_MESSAGE_DEFERREDOMNI_OUTBOUND_MESSAGE_BOUNCEDOMNI_OUTBOUND_MESSAGE_OPENEDOMNI_OUTBOUND_MESSAGE_CLICKEDOMNI_OUTBOUND_MESSAGE_UNSUBSCRIBEDOMNI_OUTBOUND_MESSAGE_MARKED_AS_SPAMOMNI_OUTBOUND_MESSAGE_BLOCKEDOMNI_OUTBOUND_MESSAGE_UNCONFIRMED_DELIVERYOMNI_SYSTEM_MESSAGE
date_created
string <date-time>
date_created
optional
the time the message was created
Examples:
1s1.000340012s
date_modified
string <date-time>
date_modified
optional
the time the message was last modified
Examples:
1s1.000340012s
subject
string 
subject
optional
The subject of the conversation
chat = not set
email = the email subject line
sms = not set
whatsapp = not set
sender_type
enum<string> 
sender_type
optional
if this message is coming from omni boss is a manager message
Allowed values:
OMNI_SENDER_TYPE_AGENTOMNI_SENDER_TYPE_CUSTOMEROMNI_SENDER_TYPE_SYSTEMOMNI_SENDER_TYPE_MANAGEROMNI_SENDER_TYPE_FLOW
status_message
string 
status_message
optional
status message
message_format
enum<string> 
message_format
optional
the message format
Allowed values:
MESSAGE_FORMAT_UNSPECIFIEDMESSAGE_FORMAT_HTMLMESSAGE_FORMAT_HTML_FORM
sent_from
string 
sent_from
optional
this is who the message is from
chat = if agent then user_id, if customer then name
email = email address
sms = phone number
whatsapp = phone number
sent_to
string 
sent_to
optional
this is who the message is to
chat = if customer then name, otherwise leave as an empty string
email = email address
sms = phone number
whatsapp = phone number
ui_reference_id
string 
ui_reference_id
optional
this is an id that the UI generates so it's able to identify it when it sees it again
message_sid
integer <int64> | string 
message_sid
optional
this is the primary key or internal tcn identifier for the message
campaign_sid
integer <int64> | string 
campaign_sid
optional
identifier of the campaign the message belongs to
Example
{
  "user_id": "string",
  "channel_type": "CHANNEL_TYPE_EMAIL",
  "reference_id": "string",
  "payload": {
    "assign_conversation": {
      "user_id": "string",
      "user_name": "string",
      "primary_asm_session_sid": 0
    }
  },
  "conversation_sid": {
    "value": 0
  },
  "status": "OMNI_MESSAGE_CREATED",
  "date_created": "1s",
  "date_modified": "1s",
  "subject": "string",
  "sender_type": "OMNI_SENDER_TYPE_AGENT",
  "status_message": "string",
  "message_format": "MESSAGE_FORMAT_UNSPECIFIED",
  "sent_from": "string",
  "sent_to": "string",
  "ui_reference_id": "string",
  "message_sid": 0,
  "campaign_sid": 0
}
🔴500Server Error
Previous
ManagerListMessages
Next
ManagerListConversations
Built with