OmniStream CRM API
Omnichannel CRM platform REST API. Centralizes WhatsApp, Instagram DM, and Email into a unified inbox with real-time messaging, agent management, analytics, and contact tracking.
Authentication
Semua endpoint memerlukan autentikasi menggunakan API Key melalui header X-API-Key.
Code
Buat API key melalui menu Developer > API Keys di aplikasi, atau via endpoint
POST /api/api-keys (memerlukan login sebagai supervisor/admin).
RBAC dan Izin
Platform menggunakan RBAC berbasis izin. Tiga role sistem bawaan tersedia (admin,
supervisor, agent) dengan hak akses tetap. Admin dapat membuat role kustom dengan
kombinasi izin yang fleksibel. Izin diperiksa per-endpoint menggunakan kode seperti
agents.manage, campaigns.manage, dan developer.access.
Error Responses
All errors return a consistent JSON format:
Code
Tags
Auth
Authentication (login, logout, session)
Conversations
Conversation management
Messages
Message retrieval and sending
Contacts
Contact management
Agents
Agent CRUD and status management
Notes
Internal conversation notes
Quick Replies
Canned response templates
Analytics
Dashboard analytics (supervisor/admin only)
Media
Media upload and proxy
Divisions
Division management (supervisor/admin only)
Transfers
Conversation transfer history
Scheduled Messages
Schedule messages for future delivery
CSAT
Customer satisfaction surveys
SLA
SLA policy management and breach tracking (supervisor/admin only)
Outgoing Webhooks
Outgoing webhook management (supervisor/admin only)
Campaigns
Broadcast campaign management
Integrations
Channel integration settings
Activity Logs
Agent activity audit trail (supervisor/admin only)
WA Templates
WhatsApp message template management
Webhooks
Inbound webhook receivers (webhook-ingestor service)
Roles
Manajemen role dan izin (khusus admin)
API Keys
Manajemen API key untuk akses programatik
Health
Service health checks
Automation
Automation rules engine with scheduling, snoozing, and alerting
Chat Expiration
Per-channel messaging window configuration
AI Agents
AI agent configuration, assignments, handoff rules, knowledge, products, orchestration, evaluations, and testing
Working Hours
Business working hours configuration (global and per-division overrides)
Super Admin
Platform super-admin tenant management, health, impersonation, and user management
Billing Admin
Billing plan, coupon, add-on, and analytics management (super-admin only)
Billing
Tenant subscription, usage, invoices, and payment method management
Schemas
ErrorResponseLoginRequestLoginResponseAgentPublicAgentRoleConversationStatusConversationWithContactAssignAgentRequestUpdateStatusRequestMessageTypeMessageDirectionMessageStatusMessageMessageListResponseSendMessageRequestContactUpdateContactCreateAgentUpdateAgentUpdateAgentStatusRequestConversationNoteNoteResponseCreateNoteUpdateNoteQuickReplyCreateQuickReplyUpdateQuickReplyOverviewResponseDayCountTrendsResponseAgentMetricAgentMetricsResponseChannelMetricChannelMetricsResponseHealthResponseMediaUploadResponseDivisionDivisionWithCountCreateDivisionUpdateDivisionTransferConversationRequestConversationTransferBulkConversationRequestUpdateTagsRequestScheduleMessageRequestScheduledMessageCsatSurveySubmitCsatRequestCsatAnalyticsResponseSlaPolicyCreateSlaPolicyUpdateSlaPolicySlaBreachLogConversationSlaStatusIntegrationUpsertIntegrationIntegrationAccountCreateIntegrationAccountUpdateIntegrationAccountWaTemplateCreateWaTemplateOutgoingWebhookCreateOutgoingWebhookUpdateOutgoingWebhookWebhookDeliveryRoleRoleWithPermissionsPermissionCreateRoleUpdateRoleApiKeyApiKeyCreateResponseCreateApiKeyRequestCampaignCampaignWithTemplateCreateCampaignUpdateCampaignCampaignRecipientAddRecipientsPayloadPaginatedResponseAutomationRuleCreateAutomationRuleUpdateAutomationRuleAutomationControlAutomationRuleRunAutomationEventQueueItemChatExpirationRuleUpsertChatExpirationRuleRegisterRequestWorkingHoursDayScheduleUpsertWorkingHoursAppSettingUpdateTimezoneAiAgentCreateAiAgentUpdateAiAgentAiAgentAssignmentCreateAiAgentAssignmentUpdateAiAgentAssignmentAiHandoffRuleCreateAiHandoffRuleUpdateAiHandoffRuleAiKnowledgeSourceCreateAiKnowledgeSourceAiKnowledgeQnaCreateAiKnowledgeQnaAiProductCreateAiProductUpdateAiProductAiOrchestrationRuleCreateAiOrchestrationRuleUpdateAiOrchestrationRuleAiEvaluationCreateAiEvaluationUpdateAiEvaluationAiUsageDailySummaryTestChatRequestTestChatMessageDeleteResponseOrganizationCreateOrganizationUpdateOrganizationTenantUsageTenantWithUsageSystemHealthBillingPlanCreateBillingPlanUpdateBillingPlanBillingCouponCreateBillingCouponBillingAddonCreateBillingAddonUpdateBillingAddonSubscriptionCurrentPlanBillingInvoiceBillingUsagePaymentMethodAddPaymentMethodSubscriptionAddonSubscriptionAddonDetailMrrSummaryRevenueByPlanMonthlyRevenueChurnMetricsBillingAnalyticsDashboard