Channel API

Channel API — это API для управления каналами и публикации бота в каналы.

Авторизация

Выпустите единый токен в разделе Доступ к API. Указывайте его в запросах как bearer-токен.

Методы

Вы можете посмотреть все методы в спецификациях:

• Bot channel API:

  • Управление входящими и телефонными каналами: получение, создание, изменение и удаление.
  • Публикация бота в любой канал.

• Operator channel API — управление операторскими каналами: получение, создание, изменение и удаление.

Публикация и проверка статуса

Публикация бота в канал может занять длительное время. С помощью Channel API вы можете начать публикацию и проверять ее статус:

1. Начните публикацию в канал с помощью метода POST /api/v1/async/bot-channels/deploy. Метод вернет в ответе requestId — идентификатор вашего запроса на публикацию.

2. Проверяйте статус публикации с помощью GET /api/v1/async/events. В запросе укажите requestId.

3. Если публикация завершена успешно, в ответе будет указано isOk: true.

   {
     "response": [
       {
         "isOk": true,
         "requestId": "request-id-example",
         …
       }
     ]
   }