Skip to main content

Introduction

Welcome to the Communiktor API documentation.

Base URL: https://api.communiktor.com/

Authentication​

  • Every request must include an X-API-KEY header.
  • Retrieve or create your API key from your Communiktor dashboard under “API keys”.

Example header:

X-API-KEY: YOUR_API_KEY

Common request settings​

  • Content-Type: application/json
  • Method: All endpoints are HTTP POST.

Response format​

All API responses always use the same envelope:

  • success: boolean — true on success, false on failure
  • message: string — human-readable message

Example:

{
  "message": "Operation completed",
  "success": true
}

Phone numbers and receivers​

  • Use E.164 digits without the leading plus sign. Example: 14155552671 (not +14155552671).
  • The messages receiver field accepts the same format (digits only) or a WhatsApp ID when applicable.

Errors​

  • Standard HTTP status codes are used.
  • On failures, the body keeps the same envelope with success=false and a descriptive message.

Notes and best practices​

  • Always include the X-API-KEY header; requests without it are rejected.
  • Use stable, publicly accessible URLs for media (image, video, audio, document) with the correct Content-Type.
  • Omit optional fields when not used.
  • Implement graceful handling of non-2xx responses and consider retries with exponential backoff where appropriate.