API Reference — ConnectiveOne API Reference

API Reference contains general information about ConnectiveOne API, navigation to Swagger documentation, and examples of main usage scenarios. For detailed information about all endpoints, use Swagger UI in the system.

What is ConnectiveOne API?

ConnectiveOne API is a REST API for integrating with the ConnectiveOne platform. API allows:

  • Getting data about chats, tickets, users
  • Sending messages to clients through bot scenarios
  • Managing data through Custom Data API
  • Getting statistics and analytics
  • Integrating with other systems

Where to Find Swagger Documentation?

Swagger documentation is available directly in the ConnectiveOne interface:

  1. Open the help menu (help icon in the upper right corner of the interface)
  2. Select "API Documentation" or go to the link /api-docs
  3. Swagger UI opens with complete documentation on all API endpoints

💡 Tip: Swagger UI allows not only viewing documentation but also testing API endpoints directly in the interface.

Authentication

ConnectiveOne API supports two types of authentication:

JWT Bearer Token

Used for authentication via JWT token:

Authorization: Bearer YOUR_JWT_TOKEN

x-auth-token

Used for authentication via external token:

x-auth-token: YOUR_TOKEN

📖 More details: For complete information about authentication and obtaining tokens, see Swagger UI in the "Authentication" section or in technical documentation.

Main API Groups

ConnectiveOne API is organized by modules and functionality. Below is a list of main endpoint groups:

Authentication

Endpoints for authentication and user session management.

Main endpoints:

  • User login
  • Token refresh
  • Logout

📖 More details: See Swagger UI in the "Authentication" section.

Users

Endpoints for managing system users.

Main endpoints:

  • Getting user list
  • Getting user by ID
  • Creating and updating users

📖 More details: See Swagger UI in the "Users" section.

Chats

Endpoints for working with chats and dialogues.

Main endpoints:

  • Getting chat list (/kw/api/v1/OpChatRooms/list)
  • Getting chat by ID
  • Filtering, sorting, and pagination

Functionality:

  • Filtering by creation date, status, operator
  • Sorting by various fields
  • Result pagination
  • Including related data (include)

📖 More details: See Swagger UI in the "Chats" section.

Tickets

Endpoints for working with tickets.

Main endpoints:

  • Getting ticket list (/kw/api/v1/Ticket/list)
  • Getting ticket by ID
  • Creating and updating tickets

Functionality:

  • Filtering by creation date, status, priority
  • Sorting by various fields
  • Result pagination
  • Including related data (include)

📖 More details: See Swagger UI in the "Tickets" section.

Broadcast

Endpoints for working with mass broadcasts.

Main endpoints:

  • Creating broadcasts
  • Managing broadcast templates
  • Viewing broadcast results

📖 More details: See Swagger UI in the "Broadcast" section.

Custom Data

Endpoints for working with custom data and models.

Main endpoints:

  • Getting data from custom models
  • Creating and updating records
  • Searching and filtering data

📖 More details: See Swagger UI in the "Custom Data" section.

Call Node

Endpoints for calling bot scenarios and sending messages.

Main endpoints:

  • Calling scenario via call_node (/kw/api/call_node/)
  • Sending messages to clients

📖 More details: See Swagger UI in the "Call Node" section.

Statistics

Endpoints for getting statistics and analytics.

Main endpoints:

  • Getting operator statistics
  • Getting dialogue statistics
  • Getting SLA metrics

📖 More details: See Swagger UI in the "Statistics" section.

Quality Assurance

Endpoints for working with the quality control system.

Main endpoints:

  • Getting quality assessments
  • Managing assessment criteria

📖 More details: See Swagger UI in the "Quality Assurance" section.

Examples of Main Scenarios

Sending Message via call_node

Sending a message to a client by calling a bot scenario:

Endpoint:

POST /kw/api/call_node/{bot_id}/{node_id}/{channel}/{chat_id}

Or via JSON body:

POST /kw/api/call_node/

Example request:

{
  "bot_id": 1,
  "connector_alias": "entry_point_alias",
  "channel": "telegram",
  "chat_id": "567890",
  "data": {
    "message": "Your order is ready!"
  }
}

📖 More details: See Swagger UI in the "Call Node" section.

Getting Chat List

Getting a chat list with filtering and pagination:

Endpoint:

GET /kw/api/v1/OpChatRooms/list

Example request with parameters:

GET /kw/api/v1/OpChatRooms/list?filter[createdAt][gt]=2024-12-01T00:00:00.000Z&filter[createdAt][lt]=2024-12-29T00:00:00.000Z&limit=10&offset=0&order[createdAt]=desc

Parameters:

  • filter[createdAt][gt] — filter by creation date FROM
  • filter[createdAt][lt] — filter by creation date TO
  • limit — number of records (default 10)
  • offset — number of records to skip
  • order[createdAt] — sorting (desc or asc)

📖 More details: See Swagger UI in the "Chats" section.

Getting Ticket List

Getting a ticket list with filtering and pagination:

Endpoint:

GET /kw/api/v1/Ticket/list

Example request with parameters:

GET /kw/api/v1/Ticket/list?filter[createdAt][gt]=2024-12-01T00:00:00.000Z&filter[createdAt][lt]=2024-12-29T00:00:00.000Z&limit=10&offset=0&order[createdAt]=desc

Parameters:

  • filter[createdAt][gt] — filter by creation date FROM
  • filter[createdAt][lt] — filter by creation date TO
  • limit — number of records (default 10)
  • offset — number of records to skip
  • order[createdAt] — sorting (desc or asc)

📖 More details: See Swagger UI in the "Tickets" section.

How to Use Swagger UI

Swagger UI in ConnectiveOne allows:

  1. Viewing documentation — detailed description of all endpoints, parameters, and responses
  2. Testing API — executing requests directly in the interface
  3. Viewing schemas — data structures for requests and responses
  4. Copying examples — ready request examples for use in code

How to Open Swagger UI

  1. Open the help menu (help icon in the upper right corner)
  2. Select "API Documentation" or go to the link /api-docs
  3. Swagger UI opens with complete documentation

How to Test API in Swagger UI

  1. Find the needed endpoint in Swagger UI
  2. Click "Try it out"
  3. Fill in request parameters
  4. Click "Execute"
  5. View the response and request code

💡 Tip: Swagger UI automatically adds the authentication token from your session, so you don't need to manually add authentication headers.

Where to Find Complete Documentation?

For detailed information about all API endpoints:

  1. Swagger UI in system — help menu → API Documentation (/api-docs)
  2. Swagger JSON — https://engine-{instancename}.kwizbot.io/swagger.json