TelegramBot Pro

API Documentation

Integrate TelegramBot Pro's powerful features directly into your applications with our REST API.

Getting Started
Endpoints

Authentication

All API requests require authentication using your API key. You can obtain your API key from the dashboard.

API Key Authentication
Include your API key in the request headers
// Example request with API key
fetch('https://api.telegrambot.pro/v1/messages', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': 'your_api_key_here'
  },
  body: JSON.stringify({
    recipient: '@username',
    message: 'Hello from the API!'
  })
})

Rate Limits

To ensure fair usage and system stability, our API implements rate limiting based on your subscription plan.

PlanRate LimitDaily Quota
Free10 requests/minute100 requests/day
Plus60 requests/minute5,000 requests/day
Pro300 requests/minute50,000 requests/day

Error Handling

Our API uses conventional HTTP response codes to indicate the success or failure of an API request.

Error Response Format
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "You have exceeded your rate limit. Please try again later.",
    "status": 429,
    "details": {
      "reset_at": "2023-07-01T12:00:00Z",
      "limit": 60,
      "remaining": 0
    }
  }
}

API Endpoints

Messages API

POST /api/messages/send
Send a message to a recipient
// Request
POST /api/messages/send
Headers:
  X-API-Code: your_api_key_here
Body:
{
  "campaignId": "summer_promo",
  "payload": {
    "to": "@username",
    "message": "Hello from the API!"
  }
}

// Response
{
  "success": true,
  "id": "msg_12345",
  "campaignId": "summer_promo",
  "period": "daily",
  "remaining": 95,
  "payloadEcho": {
    "to": "@username",
    "message": "Hello from the API!"
  }
}