# Qlara Platform API

> Unified REST API for multi-channel messaging: SMS, RCS, and WhatsApp.

## Overview

The Qlara Platform is a messaging platform API that lets you send messages across SMS, RCS, and WhatsApp channels through a single integration. It provides contacts management, campaign orchestration, delivery tracking, webhook notifications, and media management.

## Base URL

https://lora-api.agiletelecom.com

## Authentication

All requests require one of:
- API Key: `X-Api-Key: <your-key>` header
- Basic Auth: `Authorization: Basic <base64(user:pass)>` header

## APIs

There are 6 separate API specs:

### Qlara Platform API (main)
- Path prefix: `/api/partner-gateway/v1/`
- Manages: contacts, lists, campaigns, webhooks, exports, inbox, media, subscription, social profiles
- Docs: /api/partner-gateway-api

### SMS Universal API
- Path: `POST /api/message-server/sms/send`
- Modern format, one message per request, supports placeholders
- Docs: /api-sms-universal/agiletelecom-sms-universal-api

### SMS Legacy API
- Path: `POST /api/message-server/sms/send`
- Backward-compatible format, multi-recipient per request
- Docs: /api-sms-legacy/agiletelecom-sms-legacy-api

### RCS Send API
- Path: `POST /api/message-server/rcs/send`
- Rich messages: text, cards, carousels with buttons and media
- Docs: /api-rcs-send/agiletelecom-rcs-api

### RCS Templates API
- CRUD for RCS templates (TEXT, CARD, CAROUSEL)
- Path prefix: `/api/message-server/rcs/templates`
- Docs: /api-rcs-templates/agiletelecom-rcs-template-api

### WhatsApp API
- Path: `POST /api/message-server/whatsapp/send`
- Templates (Meta-approved) and free-form messages within 24h window
- Content types: text, image, video, audio, document, location, sticker, reaction
- Docs: /api-whatsapp/agiletelecom-whatsapp-api

## Key Features

- **Fallback chain**: WhatsApp → RCS → SMS (automatic if configured)
- **Campaigns**: Bulk messaging to contact lists with scheduling and cost estimation
- **Webhooks**: Real-time delivery receipts, read notifications, inbound messages
- **Templates**: Pre-approved message templates for RCS and WhatsApp
- **Exports**: Async data exports (contacts, delivery reports) with download links
- **Inbox**: Two-way conversations with reply, archive, and read tracking
- **Social Profiles**: Connected Facebook, Instagram, LinkedIn, Google, TikTok accounts

## Documentation Structure

- /intro — Getting Started (base URL, auth, core concepts)
- /quick-start — Send your first message in 3 minutes
- /api-overview — Rate limits, pagination, error handling
- /guides/authentication — API Key, Basic Auth, IP Whitelist
- /guides/messaging-channels — SMS vs RCS vs WhatsApp comparison
- /guides/sms-universal — SMS Universal guide
- /guides/rcs — RCS guide
- /guides/whatsapp — WhatsApp guide
- /guides/campaigns — Campaign management
- /guides/contacts-and-lists — Contact organization
- /guides/webhooks — Delivery notifications
- /guides/exports — Data export
- /faq — Frequently asked questions
- /changelog — Release notes
- /sdk-libraries — SDK & Libraries
- /postman-collections — Postman collection downloads