API Reference

Base URL & Authentication

Pick the environment that matches your keys:

• Production: https://api.jinaconnect.com
• Sandbox: https://api.jinaconnect-dev.jinacode.systems

Every request requires a Bearer token. For service-to-service traffic, use an API key issued from your tenant settings. For interactive sessions, exchange credentials for a JWT pair via /token/ and rotate it with /refresh/.

# POST /token/ — exchange email + password for a JWT pair
curl -X POST "https://api.jinaconnect.com/token/" \
  -H "Content-Type: application/json" \
  -d '{ "email": "you@brand.com", "password": "••••••••" }'

# → 200 OK
{ "access": "eyJhbGciOi...",
  "refresh": "eyJhbGciOi..." }

# Use the access token on every call:
-H "Authorization: Bearer eyJhbGciOi..."
→ refresh access tokens via POST /refresh/

API keys are scoped per tenant and per role. Live keys are prefixed jc_live_...; sandbox keys jc_test_.... Pass them in the same Authorization: Bearer header.

Tenants — multi-tenant workspaces

Every customer workspace is a tenant. Agencies run 5–50 tenants on a single deployment, each with its own branding, wallet and WhatsApp Business Account.

Contacts

A unified contact directory across channels. Each contact carries a phone number, channel IDs, segments and custom attributes.

# POST /contacts/ — create a contact
curl -X POST "https://api.jinaconnect.com/contacts/" \
  -H "Authorization: Bearer jc_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Asha Rao",
    "phone": "+919876543210",
    "segments": ["vip", "diwali-2026"],
    "attributes": { "city": "Pune", "plan": "pro" }
  }'
→ 201 Created · returns the new contact id

Broadcast — WhatsApp

Schedule, send and track WhatsApp template broadcasts, then drill into per-message delivery and click data.

# POST /broadcast/ — create & queue a template broadcast
curl -X POST "https://api.jinaconnect.com/broadcast/" \
  -H "Authorization: Bearer jc_live_..." \
  -d '{
    "template": "diwali_offer",
    "segment": "diwali-2026",
    "schedule_at": "2026-10-20T09:00:00Z"
  }'
→ 201 Created · broadcast queued, track via /broadcast/dashboard/

WhatsApp

Send template and session messages on the Official WhatsApp Business API, manage templates through Meta approval, and receive Meta-compliant inbound webhooks.

# POST /wa/v1/messages/ — send a template message
curl -X POST "https://api.jinaconnect.com/wa/v1/messages/" \
  -H "Authorization: Bearer jc_live_..." \
  -d '{
    "to": "+919876543210",
    "type": "template",
    "template": {
      "name": "diwali_offer",
      "language": "en",
      "components": [{ "type": "body",
        "parameters": [{ "type": "text", "text": "Asha" }] }]
    }
  }'
→ 202 Accepted · returns message_id & status: queued

Voice — 5 HTTP providers + 12 SIP trunks

Place outbound calls, build IVR templates that compile to TwiML / NCCO / Plivo XML, pull CDRs and recordings, and log consent for compliance.

# POST /voice/api/calls/ — place an outbound call
curl -X POST "https://api.jinaconnect.com/voice/api/calls/" \
  -H "Authorization: Bearer jc_live_..." \
  -d '{
    "to": "+919876543210",
    "provider_config": "twilio-in",
    "template_id": "ivr_payment_reminder"
  }'
→ 201 Created · poll /voice/api/calls/{id}/ for the CDR

SMS

Send transactional and promotional SMS through Twilio, MSG91 or Fast2SMS with DLT-registered templates, plus inbound and DLR webhooks.

Telegram

Register Telegram bot apps, send and broadcast messages, and receive inbound updates from the Telegram Bot API.

RCS

Send rich cards and suggested-replies over Google RBM or Meta RCS, individually or as a broadcast.

Team Inbox

A unified, omni-channel inbox. Read messages across every channel, pull inbox metrics, and export conversations as PDF.

Errors & Rate Limits

Standard HTTP status codes apply. The body for any non-2xx response is always { "detail": "...", "code": "..." }.

Rate limits (hosted)

Per-tenant defaults — raised on Enterprise plans:

• Broadcast send: 500 msgs/sec per tenant (subject to the Meta MPS quota)
• Voice outbound: 50 calls/sec per provider
• Read endpoints: 100 req/sec per API key
• Webhooks delivered to your endpoint: up to 200 req/sec with retries

Need a hand wiring this up? WhatsApp us, email hello@jinacode.systems, or book a 30-min call.