API ВЕГА

По имени или email находит сотрудника и возвращает его open_id; по open_id позволяет получить профиль. Также ищет доступных текущему пользователю ботов и agent по ключевым словам.

Возможности

  • Ищет сотрудников по имени или email от имени user.
  • Получает данные пользователя по open_id; поддерживает open_id, union_id и user_id для +get-user.
  • Возвращает сведения о профиле, включая имя, отдел, email и контактные данные.
  • Запрашивает личный статус и подпись коллег через user_profiles batch_query.
  • Ищет видимых текущему пользователю ботов и agent по ключевым словам. Поиск ботов выполняется от имени user, по ID он не работает.
  • Не предназначен для обхода дерева отделов, поиска сотрудников по отделу или построения оргструктуры.

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

  • Нужно найти сотрудника, чтобы затем написать ему или пригласить на встречу.
  • Есть open_id, и требуется узнать данные профиля.
  • Нужно проверить личный статус или подпись одного либо нескольких коллег.
  • Имя может принадлежать боту или agent: ищите бота по ключевому слову либо проверьте оба типа.

Примеры

Найти сотрудника и отправить ему сообщение:

lark-cli contact +search-user --query "张三" --has-chatted --as user
lark-cli im +messages-send --user-id ou_xxx --text "Hi!"

Запросить личный статус и подпись коллег:

lark-cli schema contact.user_profiles.batch_query
lark-cli contact user_profiles batch_query \
  --params '{"user_id_type":"open_id"}' \
  --data '{"user_ids":["ou_xxx","ou_yyy"],"query_option":{"include_personal_status":true,"include_description":true}}' \
  --as user

Найти ботов по ключевым словам:

lark-cli contact +search-bot --queries '会议助手,日报助手,审批助手' --as user

Установка

npx skills add https://github.com/larksuite/cli --skill lark-contact