OmniStream Docs
Panduan Pengguna
Developer
API Reference
Information
Auth
Login with email and password
post
Get current agent profile
get
Logout (clears cookie)
post
Issue a fresh JWT for the current session
get
Register a new tenant organization
post
Conversations
List conversations
get
Get a single conversation
get
Assign or unassign an agent
patch
Update conversation status
patch
Mark conversation as read
post
Expire stale conversations
post
Update conversation tags
patch
Takeover a conversation
post
Bulk conversation actions
post
Messages
List messages in a conversation
get
Send an outbound message
post
Search messages across conversations
get
Contacts
List contacts
get
Get a contact by ID
get
Update a contact
patch
List conversations for a contact
get
Agents
List all agents
get
Create a new agent
post
Get an agent by ID
get
Delete an agent
delete
Update an agent
patch
Toggle agent online/offline status
patch
Notes
List notes for a conversation
get
Create a note
post
Delete a note
delete
Update a note
patch
Quick Replies
List all quick replies
get
Create a quick reply
post
Delete a quick reply
delete
Update a quick reply
patch
Export quick replies as CSV
get
Import quick replies from CSV
post
Record usage of a quick reply
post
Add quick reply to favorites
post
Remove quick reply from favorites
delete
Analytics
Dashboard overview KPIs
get
Conversation and message trends
get
Per-agent workload metrics
get
Per-channel metrics
get
CSAT analytics
get
WhatsApp message analytics
get
WhatsApp conversation analytics
get
WhatsApp template analytics
get
Media
Upload a media file
post
Download or proxy a media file
get
Upload a file to S3/MinIO
post
Divisions
List divisions
get
Create a division
post
Get a division with agents
get
Delete a division
delete
Update a division
patch
List agents in a division
get
Assign agents to a division
post
Remove agents from a division
delete
Transfers
Transfer a conversation
post
List transfer history for a conversation
get
Scheduled Messages
Schedule a message for future delivery
post
List scheduled messages for a conversation
get
Cancel a scheduled message
delete
CSAT
Get CSAT survey for a conversation
get
Create a CSAT survey for a conversation
post
Submit a CSAT rating
patch
CSAT analytics
get
SLA
List SLA policies
get
Create an SLA policy
post
Delete an SLA policy
delete
Update an SLA policy
patch
List SLA breaches for a policy
get
Get SLA status for a conversation
get
Outgoing Webhooks
List outgoing webhooks
get
Create an outgoing webhook
post
List available webhook event types
get
Delete an outgoing webhook
delete
Update an outgoing webhook
patch
List deliveries for a webhook
get
Send a test event to the webhook
post
Campaigns
List campaigns
get
Create a new campaign (draft)
post
Get a campaign
get
Delete a draft campaign
delete
Update a draft campaign
patch
List campaign recipients
get
Add recipients to a campaign
post
Clear all recipients from a campaign
delete
Send or schedule a campaign
post
Cancel a campaign
post
Integrations
List all channel integrations
get
Get a single integration by channel
get
Create or update an integration (upsert)
put
Delete an integration
delete
List integration accounts
get
Create an integration account
post
Get an integration account by ID
get
Delete an integration account
delete
Update an integration account
patch
Set an integration account as the default for its channel
post
Fetch WhatsApp account health from Meta Graph API
get
Get WhatsApp Embedded Signup config
get
Complete WhatsApp Embedded Signup
post
Get Instagram OAuth app config
get
Connect Instagram account via OAuth
post
Get Messenger OAuth app config
get
Connect Messenger via Facebook Login OAuth
post
Subscribe selected Facebook Pages to Messenger webhooks
post
Disconnect a Messenger page
post
Get Messenger persistent menu
get
Set or delete Messenger persistent menu
post
Activity Logs
List activity logs
get
WA Templates
List WhatsApp message templates
get
Create a WhatsApp message template
post
Sync templates from Meta
post
Get a WhatsApp template by ID
get
Delete a WhatsApp template (local only)
delete
Update template header media URL
patch
Webhooks
Meta webhook verification
get
Receive Meta webhook (WhatsApp + Instagram)
post
Receive inbound email webhook
post
Meta webhook verification for Messenger
get
Receive Messenger inbound webhook events
post
Meta webhook verification for Instagram
get
Receive Instagram inbound webhook events
post
Roles
List all roles with permissions
get
Create a custom role
post
Get a single role with permissions
get
Delete a custom role
delete
Update a role
patch
List all available permissions
get
API Keys
List caller's API keys
get
Create a new API key
post
Revoke an API key
delete
Health
API Gateway health check
get
Automation
List automation rules
get
Create an automation rule
post
List snoozed automation rules
get
Snooze multiple automation rules
post
Automation stats overview
get
Automation stats time series
get
Automation alert stats
get
Dry-run an automation rule against a test payload
post
Get an automation rule by ID
get
Delete an automation rule
delete
Update an automation rule
patch
Toggle automation rule active state
post
Snooze an automation rule until a given time
post
Unsnooze an automation rule
post
Get stats for a specific automation rule
get
Get time series stats for a specific automation rule
get
Get the effective state of an automation rule
get
Update alert settings for an automation rule
patch
Update schedule settings for an automation rule
patch
Update rollout percentage for an automation rule
patch
Preview upcoming schedule windows for an automation rule
get
Get global automation control state
get
Update global automation control state
patch
List automation rule runs
get
Export automation runs as CSV
get
List automation runs for a specific rule
get
List automation runs for a specific event
get
Get a single automation run by ID
get
Get replay context for an automation run
get
List automation event queue items
get
Automation event queue stats
get
Export automation events as CSV
get
Retry all failed automation events
post
Clean up old failed automation events
post
List automation events for a conversation
get
List automation events for a rule
get
List automation events by payload fingerprint
get
Get a single automation event by ID
get
Retry a single automation event
post
Reprocess an automation event with the current rule set
post
Get automation worker metrics
get
Chat Expiration
List chat expiration rules
get
Upsert a chat expiration rule for a channel
put
AI Agents
List all AI agents
get
Create a new AI agent
post
Get an AI agent by ID
get
Update an AI agent
put
Delete an AI agent
delete
Toggle AI agent active state
put
List AI agent assignments
get
Create an AI agent assignment
post
Update an AI agent assignment
put
Delete an AI agent assignment
delete
List handoff rules for an AI agent
get
Create a handoff rule
post
Update a handoff rule
put
Delete a handoff rule
delete
Get daily usage stats for an AI agent
get
List knowledge sources for an AI agent
get
Add a knowledge source
post
Delete a knowledge source
delete
Reprocess a knowledge source
post
List QnA pairs for a knowledge source
get
Add a QnA pair
post
Delete a QnA pair
delete
List products for an AI agent
get
Create a product
post
Bulk import products
post
Update a product
put
Delete a product
delete
List orchestration rules
get
Create an orchestration rule
post
Update an orchestration rule
put
Delete an orchestration rule
delete
List evaluations for an AI agent
get
Create an AI response evaluation
post
Update an AI evaluation
put
Delete an AI evaluation
delete
Get aggregated AI usage summary
get
Send a test message to an AI agent
post
Working Hours
List global working hours
get
Upsert global working hours
put
List division working hours
get
Upsert division working hours override
put
Delete division working hours override
delete
Get tenant timezone
get
Update tenant timezone
put
Check working hours status (public)
get
Super Admin
Super-admin login
post
List all tenant organizations
get
Provision a new tenant
post
Get a tenant organization
get
Suspend a tenant organization
delete
Update a tenant organization
patch
Impersonate a tenant admin
post
List all tenants with usage statistics
get
System health check
get
List super-admin accounts
get
Create a super-admin account
post
Delete a super-admin account
delete
Reset a super-admin's password
post
List tenant users
get
Reset a tenant user's password
post
Suspend a tenant user
post
Activate a tenant user
post
Impersonate a tenant user
post
Billing Admin
List all billing plans
get
Create a billing plan
post
Get a billing plan by ID
get
Delete a billing plan
delete
Update a billing plan
patch
List all coupons
get
Create a coupon
post
Delete a coupon
delete
Update a coupon
patch
List all add-ons
get
Create an add-on
post
Delete an add-on
delete
Update an add-on
patch
Combined analytics dashboard
get
Monthly recurring revenue summary
get
Revenue breakdown by plan
get
Monthly revenue over time (last 12 months)
get
Churn metrics for current month
get
Refund an invoice
post
Billing
Get current subscription and plan
get
List available billing plans
get
Subscribe to a plan
post
Upgrade or downgrade subscription plan
post
Cancel subscription
post
Get current month's usage
get
List invoices
get
Download invoice PDF
get
List payment methods
get
Add a payment method
post
Delete a payment method
delete
Validate a coupon code
post
List available add-ons
get
List attached add-ons
get
Attach an add-on to subscription
post
Detach an add-on from subscription
delete
Schemas
Menu
OmniStream CRM API
OmniStream CRM API
Health
Endpoint
https://api-chat.bara.my.id
http://localhost:3000
Service health checks
API Gateway health check
GET
https://api-chat.bara.my.id
/health
API Gateway health check ›
Responses
200
503
All services healthy
status
string
·
enum
·
required
Enum values:
healthy
degraded
services
object
·
required
API Keys
Automation