Back to Details

pachca-profile

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

pachca-profile

pachca-profile

Base URL: 
https://api.pachca.com/api/shared/v1
Авторизация: 
Authorization: Bearer <ACCESS_TOKEN>
Токен: бот (Автоматизации → Интеграции → API) или пользователь (Автоматизации → API).
基础URL: 
https://api.pachca.com/api/shared/v1
授权方式: 
Authorization: Bearer <ACCESS_TOKEN>
令牌: 机器人令牌（自动化 → 集成 → API）或用户令牌（自动化 → API）。

Когда использовать

适用场景

  • получить профиль
  • мой профиль
  • установить статус
  • обновить статус
  • сбросить статус
  • кастомные поля
  • дополнительные поля
  • 获取个人资料
  • 我的个人资料
  • 设置状态
  • 更新状态
  • 重置状态
  • 自定义字段
  • 附加字段

Когда НЕ использовать

不适用场景

  • найти сотрудника, создать пользователя, список сотрудников → pachca-users
  • создать канал, создать беседу, создать чат → pachca-chats
  • отправить сообщение, ответить в тред, прикрепить файл → pachca-messages
  • настроить бота, вебхук, webhook → pachca-bots
  • показать форму, интерактивная форма, модальное окно → pachca-forms
  • создать задачу, список задач, напоминание → pachca-tasks
  • аудит, журнал событий, безопасность → pachca-security
  • 查找员工、创建用户、员工列表 → pachca-users
  • 创建频道、创建群聊、创建对话 → pachca-chats
  • 发送消息、回复线程、附加文件 → pachca-messages
  • 配置机器人、Webhook → pachca-bots
  • 显示表单、交互式表单、模态窗口 → pachca-forms
  • 创建任务、任务列表、提醒 → pachca-tasks
  • 审计、事件日志、安全 → pachca-security

Пошаговые сценарии

分步操作流程

Установить статус

设置状态

  1. PUT /profile/status с 
    emoji
    и 
    title
bash
curl -X PUT "https://api.pachca.com/api/shared/v1/profile/status" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":{"emoji":"🏖️","title":"В отпуске до 10 марта"}}'
  1. 调用 PUT /profile/status，传入
    emoji
    和
    title
    参数
bash
curl -X PUT "https://api.pachca.com/api/shared/v1/profile/status" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":{"emoji":"🏖️","title":"В отпуске до 10 марта"}}'

Сбросить статус

重置状态

  1. DELETE /profile/status
bash
curl -X DELETE "https://api.pachca.com/api/shared/v1/profile/status" \
  -H "Authorization: Bearer $TOKEN"
  1. 调用 DELETE /profile/status
bash
curl -X DELETE "https://api.pachca.com/api/shared/v1/profile/status" \
  -H "Authorization: Bearer $TOKEN"

Получить кастомные поля профиля

获取个人资料自定义字段

  1. GET /custom_properties?entity_type=User — список дополнительных полей для сотрудников (
    id
    , 
    name
    , 
    data_type
    )
  2. GET /profile — в ответе поле 
    custom_properties
    содержит значения для текущего пользователя
Параметр 
entity_type=User
фильтрует поля по типу сущности. Кастомные поля настраиваются администратором пространства. Значения хранятся в массиве 
custom_properties
объекта 
user
.
  1. 调用 GET /custom_properties?entity_type=User — 获取员工的附加字段列表（包含
    id
    、
    name
    、
    data_type
    ）
  2. 调用 GET /profile — 响应中的
    custom_properties
    字段包含当前用户的对应值
参数
entity_type=User
用于按实体类型过滤字段。自定义字段由工作区管理员配置。值存储在
user
对象的
custom_properties
数组中。

Обработка ошибок

错误处理

КодПричинаЧто делать
422Неверные параметрыПроверь обязательные поля, типы данных, допустимые значения enum
429Rate limitПодожди и повтори. Лимит: ~50 req/sec, сообщения ~4 req/sec
403Нет доступаНедостаточно скоупов (
insufficient_scope
), бот не в чате, или endpoint только для админов/владельцев
404Не найденоНеверный id. Проверь что сущность существует
401Не авторизованПроверь токен в заголовке Authorization
代码原因解决方法
422参数错误检查必填字段、数据类型、枚举的有效值
429请求频率限制等待后重试。限制：约50次请求/秒，消息类约4次请求/秒
403无权限权限范围不足（
insufficient_scope
）、机器人未加入对话，或该端点仅对管理员/所有者开放
404未找到ID错误。检查实体是否存在
401未授权检查Authorization头中的令牌

Доступные операции

可用操作

Список дополнительных полей

附加字段列表

GET /custom_properties
скоуп: 
custom_properties:read
GET /custom_properties
权限范围：
custom_properties:read

Информация о токене

令牌信息

GET /oauth/token/info
GET /oauth/token/info

Информация о профиле

个人资料信息

GET /profile
скоуп: 
profile:read
GET /profile
权限范围：
profile:read

Текущий статус

当前状态

GET /profile/status
скоуп: 
profile_status:read
GET /profile/status
权限范围：
profile_status:read

Новый статус

设置新状态

PUT /profile/status
скоуп: 
profile_status:write
json
{
  "status": {
    "emoji": "",
    "title": ""
  }
}
PUT /profile/status
权限范围：
profile_status:write
json
{
  "status": {
    "emoji": "",
    "title": ""
  }
}

Удаление статуса

删除状态

DELETE /profile/status
скоуп: 
profile_status:write
DELETE /profile/status
权限范围：
profile_status:write

Ограничения и gotchas

限制与注意事项

  • Пагинация: cursor-based (limit + cursor), НЕ page-based
  • 分页：基于游标（limit + cursor），不支持基于页码（page-based）的分页

Подробнее

更多详情

см. references/endpoints.md
请查看 references/endpoints.md