Developer Documentation
Open Interactive Swagger BotDeck REST API Reference
Programmatically manage bots, VIP subscribers, broadcasts, and inbox threads with scoped tenant API keys.
API Key Authentication
Generate bdk_live_... keys inside Dashboard → Settings → Developer API. Pass via x-api-key header.
Strict Tenant Isolation
Every API key is scoped strictly to its workspace organizationId and respects suspension policies.
Base URL
https://botdeck.emperorsmartsolutions.com/api/v1
1. Authenticate Requests
curl -X GET "https://botdeck.emperorsmartsolutions.com/api/v1/bots" \ -H "x-api-key: bdk_live_YOUR_GENERATED_API_KEY" \ -H "Content-Type: application/json"
2. Trigger a Segmented Broadcast
curl -X POST "https://botdeck.emperorsmartsolutions.com/api/v1/campaigns" \
-H "x-api-key: bdk_live_YOUR_GENERATED_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"botId": "<YOUR_BOT_ID>",
"name": "Weekly Market Digest",
"messageText": "Your VIP analysis report is live.",
"audienceType": "VIP_ACTIVE"
}'3. Core Endpoint Map
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/bots | List connected official Telegram bots |
| GET | /api/v1/bots/chats | List detected Channels & Supergroups |
| GET | /api/v1/vip/plans | List Paid VIP subscription plans |
| GET | /api/v1/vip/subscriptions | Query active/expired VIP subscribers |
| GET | /api/v1/inbox/conversations | Fetch shared inbox threads |
| POST | /api/v1/inbox/conversations/:id/messages | Send Bot DM or Business DM reply |
| POST | /api/v1/campaigns | Enqueue immediate or scheduled broadcast |