API каналов

Эндпоинт возвращает список каналов организации по API токену. Используйте его, чтобы получить channelId для API товаров и базы знаний.

Базовый URL: https://api.apx.chat/api/v1/external/channels

Токен должен содержать scope channel_ai_agent.

Получение списка каналов#

GET /api/v1/external/channels

js

APX: X-Api-Token

Скопировать код

const url = "https://api.apx.chat/api/v1/external/channels";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-Api-Token": "tok_xxxxx",
  },
});

const data = await response.json();
console.log(data);

Формат ответа#

• id - идентификатор канала (используется как channelId в других запросах)
• type - тип канала
• name - имя канала

{
  "status": "OK",
  "data": [
    {
      "id": "b8c1f35a-1a0b-4a2f-9a10-7f0c2b4a1f01",
      "type": "website",
      "name": "Сайт"
    }
  ]
}

Ошибки используют строгий публичный envelope { "status": number, "message": string, "timestamp": string, "path": string, "code"?: string, "details"?: object }.