oqimDocs
API referenceConsole

Start here

  • Introduction
  • Getting started

Guides

  • Telegram accounts
  • Recipients
  • Campaigns
  • Scheduling
  • Webhooks
  • AI writing assistant

AI Seller

  • AI Seller
  • Channels
  • Live inbox
  • Past conversations and privacy
  • Business insights

API

  • Authentication
  • API reference
  • SDK
  • Errors
  • Rate limits

Trust and operations

  • Security
  • Compliance
  • Administration
Docs / Introduction

Start here

  • Introduction
  • Getting started

Guides

  • Telegram accounts
  • Recipients
  • Campaigns
  • Scheduling
  • Webhooks
  • AI writing assistant

AI Seller

  • AI Seller
  • Channels
  • Live inbox
  • Past conversations and privacy
  • Business insights

API

  • Authentication
  • API reference
  • SDK
  • Errors
  • Rate limits

Trust and operations

  • Security
  • Compliance
  • Administration

Oqim documentation

Oqim sends scheduled Telegram messages from accounts your organization owns to people who agreed to hear from you. You connect the accounts, import recipients with the basis you have for contacting each one, and launch campaigns that every account sends at its own pace.

These pages cover the console, the REST API and webhooks, and running Oqim on your own infrastructure. If you're new, start with Getting started.

Start here#

  • Getting startedThe nine steps from connecting an account to monitoring a live campaign, plus a local setup.
  • AuthenticationConsole sessions, API keys, one-hour access tokens, roles and permissions.
  • API referenceEvery endpoint with its permission, request body and response, also as an OpenAPI 3.1 spec.
  • SDK@oqim/sdk, the TypeScript client: errors, pagination, retries, live events and webhook verification.

Guides#

  • Telegram accountsSigning in, account states, pacing, flood waits and what happens when Telegram restricts an account.
  • RecipientsConsent states, CSV imports with a dry run, syncing from your own database, opt-outs and the suppression list.
  • CampaignsLifecycle, pre-launch validation, message formatting, variables and delivery guarantees.
  • SchedulingTime zones, daily windows that can cross midnight, repeating campaigns, and how dispatch paces each account.
  • WebhooksEvent types, payloads, signature verification in Node.js, Go and Python, and retries.

AI Seller#

  • AI SellerThe Seller that answers customers on Telegram, Instagram and Facebook: how a turn is decided, autonomy levels, drafts, handoffs and what it never does.
  • ChannelsConnecting Instagram accounts and Facebook Pages, Meta's 24-hour window for AI replies, and what cannot be done.
  • Live inboxEvery chat in one list, full history, photos, voice and files — and why reading here never marks a message read.
  • Past conversations and privacyImporting history, why imported messages never get a reply, personal chats, and what leaves the platform.
  • Business insightsCase analysis over every conversation, boards per channel, what estimated means, and why the business isn't growing.

Reference#

  • ErrorsThe error envelope and every error code the API returns.
  • Rate limitsAPI request limits and headers, plan limits, and how both differ from Telegram pacing.

Trust and operations#

  • SecurityEnvelope encryption, key separation, MFA, request protection and the append-only audit log.
  • ComplianceTelegram's API terms, consent, opt-out, data minimization and the acceptable-use policy.
  • AdministrationThe platform admin console, automatic brakes, oqimctl, configuration, backups, health checks, metrics and logs.

The API in one request#

Everything the console does goes through the same API, at /api/v1 on your Oqim host. Create an API key under API & webhooks in the console, then:

Shell
curl "https://app.example.com/api/v1/campaigns?status=RUNNING" \
  -H "Authorization: Bearer $OQIM_API_KEY"

Examples in these docs use app.example.com; replace it with your deployment's host.

Next Getting started