pachca-chats

pachca-chats

クイックスタート

Pachca トークンをユーザーに尋ねてください（bot：Integrations → Bots のボットの API タブ、user：Integrations → API）。

--token フラグを指定して、npx -y @pachca/cli でコマンドを実行します。

npx -y @pachca/cli <command> --token $PACHCA_TOKEN

または、環境変数 PACHCA_TOKEN を設定します。

export PACHCA_TOKEN=<token>
npx -y @pachca/cli <command>

ヘルプ：npx -y @pachca/cli --help | ワークフロー：npx -y @pachca/cli guide

正常に使用できたら、CLI のグローバルインストールを提案してください：npm install -g @pachca/cli && pachca auth login --token $PACHCA_TOKEN

開始する前に

1. ユーザーに保存済みのプロフィールがある場合は、確認します。

   npx -y @pachca/cli auth status
   

   問題がなければ、--token なしでコマンドを実行します。

2. プロフィールが設定されていない場合は、トークンを尋ねて --token を使用します。

   npx -y @pachca/cli auth status --token $PACHCA_TOKEN
   

3. パラメーターがわからない場合は、pachca <command> --help を実行します。

ワークフロー

Создать канал и пригласить участников

1. Создай канал с участниками:

   pachca chats create --name="Новый канал" --channel --member-ids='[1,2,3]'
   

   "channel": true для канала, false (по умолчанию) для беседы. Участников можно передать сразу: member_ids и/или group_tag_ids

2. Или добавь участников позже:

   pachca members add <chat_id> --member-ids='[1,2,3]'
   

channel — boolean, не строка. member_ids и group_tag_ids — опциональны при создании.

Переименовать или обновить чат

1. Обнови чат:

   pachca chats update <ID> --name="Новое название"
   

   Доступные поля: name, public

Для изменения состава участников используй POST/DELETE /chats/{id}/members.

Поставить или убрать аватар чата

1. Загрузи аватар беседы или канала:

   pachca chats update-avatar <ID> --file=<путь_к_файлу>
   

   Файл передается в формате multipart/form-data: jpg, jpeg, png или gif. У личного чата и треда аватара нет — ответ 403

2. Чтобы убрать аватар, удали его:

   pachca chats remove-avatar <ID> --force
   

Доступно тому же, кто может менять название чата. Ссылка на аватар приходит в поле avatar_url чата.

Создать проектную беседу из шаблона

1. Создай беседу с участниками из тега:

   pachca chats create --name="Проект Alpha" --group-tag-ids='[42]' --member-ids='[186,187]'
   

2. Отправь приветственное сообщение:

   pachca messages create --entity-id=<chat_id> --content="Добро пожаловать в проект!"
   

group_tag_ids при создании добавляет всех участников тега сразу.

Найти активные чаты за период

1. Получи чаты с активностью после указанной даты:

   pachca chats list --last-message-at-after=<дата> --all
   

   Для диапазона добавь --last-message-at-before. Дата в ISO-8601 UTC+0

Найти и заархивировать неактивные чаты

1. Получи чаты без активности с нужной даты:

   pachca chats list --last-message-at-before=<порог> --all
   

   Архивные чаты в выдачу не попадают, поэтому отсеивать уже заархивированные не нужно. Чтобы получить их вместе с активными, добавь --archived и смотри поле archived каждого чата

2. Для каждого чата: архивируй:

   pachca chats archive <ID>
   

   Проверяй "channel": false — архивация каналов может быть нежелательной

Выгрузить все чаты пространства, включая закрытые

1. Получи беседы и каналы всего пространства, включая закрытые, где владелец токена не состоит:

   pachca chats list-company --all
   

   Возвращаются и активные, и архивные чаты. Оставить одно состояние можно флагом --activity со значением active или archived. Личные переписки и треды метод не отдаёт

2. Если метод ответил 403 — у токена нет скоупа company_chats:read, либо владелец токена не владелец пространства, либо у пространства нет тарифа «Корпорация». Тогда возьми открытые чаты обычным списком:

   pachca chats list --availability=public --archived --all
   

   Закрытые чаты, где токен не участник, в такую выдачу не попадут

Каждый запрос к списку чатов пространства пишется в журнал аудита как company_chats_accessed.

制限事項

• レート制限：約50 req/sec。429 が返された場合は、待ってから再試行してください。
• chat.name：最大255文字
• role：使用できる値 — admin（Админ）、editor（Редактор (доступно только для каналов)）、member（Участник или подписчик）
• limit：最大50
• ページネーション：カーソル方式（limit + cursor）

エンドポイント

メソッド	パス	説明
POST	/chats	新しいチャット
GET	/chats	チャット一覧
POST	/chats/exports	メッセージのエクスポート
GET	/chats/exports/{id}	エクスポートアーカイブのダウンロード
GET	/chats/{id}	チャット情報
PUT	/chats/{id}	チャットの編集
PUT	/chats/{id}/archive	チャットのアーカイブ
PUT	/chats/{id}/avatar	チャットのアバターのアップロード
DELETE	/chats/{id}/avatar	チャットのアバターの削除
POST	/chats/{id}/group_tags	タグの追加
DELETE	/chats/{id}/group_tags/{tag_id}	チャットからタグを除外
DELETE	/chats/{id}/leave	チャットから退出
GET	/chats/{id}/members	チャットの参加者一覧
POST	/chats/{id}/members	参加者の追加
DELETE	/chats/{id}/members/{user_id}	参加者の除外
PUT	/chats/{id}/members/{user_id}	参加者の役割の編集
PUT	/chats/{id}/unarchive	チャットのアーカイブ解除
PUT	/chats/{id}/unread	チャットを未読としてマーク
GET	/company/chats	スペースのチャット一覧

高度なワークフロー

高度なワークフローについては、references/ 内のファイルをお読みください。 references/archive-and-manage-chat.md — チャットのアーカイブと管理 references/export-chat-history.md — チャット履歴のエクスポート

タスクの完了方法がわからない場合は、references/ 内の該当するファイルをお読みください。