Get

[POST] .../v1/channel/get

Returns CRM channels with pagination. Use this method to list CRM communication channels for channel setup screens, lead routing review and support workload configuration. The response returns paged Channel records with next_offset and total, including queue mode, routing strategy, SLA settings, channel messages, activity flag, operators and working intervals. The request body is required and supports filters, limit, offset and ids/search/active fields; filters are evaluated against channel id, channel name search and active flag. The caller must have CRM channel select permission; missing body, denied access, invalid filters, database errors and persistent lookup errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Requested item count. Non-positive values use the default page size.
offset Int32 Optional Result set offset. If the value is less than 0, 0 is used.
search String Optional Search by channel name.

Filterable Fields

Field Type Description
active bool Filter by active flag.
id int Filter by channel IDs.
name string

Request Example

{
  "filters": [
    {
      "Field": "name",
      "Operator": "Like",
      "Value": "Telegram"
    },
    {
      "Field": "active",
      "Operator": "Equal",
      "Value": "true"
    }
  ],
  "limit": 20,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of Channel Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 3,
      "name": "Telegram support",
      "queue_mode": "Pool",
      "routing_strategy": "RoundRobin",
      "first_response_sec": 300,
      "next_response_sec": 900,
      "resolve_sec": 86400,
      "pause_on_waiting_client": true,
      "start_message": "Hello, we will reply soon.",
      "end_message": "Thank you for contacting us.",
      "off_hours_message": "We are offline now and will reply during working hours.",
      "rating_enabled": true,
      "rating_message": "Please rate this conversation.",
      "rating_positive_message": "Thank you for the feedback.",
      "rating_negative_message": "We will review this conversation.",
      "active": true,
      "created_user_id": 12,
      "last_update": 1712345600,
      "operators": [
        {
          "channel_id": 3,
          "user_id": 12,
          "sort_order": 1,
          "max_active_leads": 20,
          "is_active": true,
          "joined_date": 1712345600,
          "last_update": 1712345600
        }
      ],
      "intervals": [
        {
          "channel_id": 3,
          "day_of_week": 1,
          "start_minute": 540,
          "end_minute": 1080,
          "cross_day": false,
          "last_update": 1712345600
        }
      ]
    }
  ],
  "next_offset": 0,
  "total": 1
}