feishu-api 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13d0624f83504106d2aea9ab11e7f46ace5279b941b7c96d3b7079d46aa5192e
-  data.tar.gz: 4cebc28b90e6dc24064b173e84f7b2ed4828c16ad88d662f3a80b3e54ccbd982
+  metadata.gz: 3f8a52a4760d626bfb49812f6abc798505af00b137102ab705b638001b2f0816
+  data.tar.gz: c00d49d6647fb9243370793576f3125a34c9ab1535d50587b81f7e5303a0455d
 SHA512:
-  metadata.gz: f3712e077e07abd86249f8e61743e849ffd07d0c8bf00e38c0f54d3603218888fc8e1ef5ff0a4d29b3f4836a27e19363d3e810f5dc80e4b15a5276e49ef4fe9b
-  data.tar.gz: 24bfd38c27a267a439b912ebb313567695403396da4a71f07475509ee8faa220b3117fd1fc2b169942ca2bed558818f57a88e86f8b5abaa9e31290cc3ab78ac6
+  metadata.gz: a22fed44aee1d6965bf5aaceba272aeaf4528ac65386e2735f90e862cd680620cafa4364bc15b95104467c457c5ba9a203ee4a0aca0d2cbf78ccba0e5ff83cd8
+  data.tar.gz: 3baaceeab565d0a44aa4451baa930a6ad3067b7bca83dcadc2c85dad31fb09c3ea0063ef616b0ca1725c127e9efbfff9d5af6bebaf0b1c55007745fa24af88d9

data/README.md

@@ -1,6 +1,9 @@
 # FeishuApi
 
-FeishuApi is a integration of commonly used feishu open platform's APIs, easy to call.
+FeishuApi is an integration of commonly used feishu open platform's APIs, easy to call.
+
+
+English | [简体中文](./README-zh.md)
 
 ## Installation
 
@@ -12,6 +15,33 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install feishu-api
 
+## Roadmap
+- ✅ Messenger
+- ✅ Group
+- Docs
+- Calendar
+- Video Conferencing
+- Rooms
+- Attendance
+- Approval
+- Account
+- Console
+- Task
+- Email
+- App Information
+- Company Information
+- Search
+- AI
+- Admin
+- HR
+- OKR
+- Real-name authentication
+- Smart access control
+- Enterprise Encyclopedia
+- Contacts
+
+## Documentation
+See detailed documentation at [feishu-api-doc](https://xiemala.com/s/DstEGj/feishu-api)
 ## Usage
 
 Add feishu-api.rb in config/initializers

data/lib/feishu-api/api.rb

@@ -8,6 +8,11 @@ module FeishuApi
     API_APP_ACCESS_TOKEN = '/auth/v3/app_access_token/internal'
     API_SEND_MESSAGES = '/im/v1/messages'
     API_CUSTOM_BOT_SEND = '/bot/v2/hook'
+    API_UPLOAD_IMAGE = '/im/v1/images'
+    API_UPLOAD_FILES = '/im/v1/files'
+    API_CHATS = '/im/v1/chats'
+    API_RESERVES = '/vc/v1/reserves'
+    API_MEETINGS = '/vc/v1/meetings'
 
     def api(interface)
       "#{API_HOST}#{interface}"
@@ -17,15 +22,78 @@ module FeishuApi
       HTTParty.post(api(url),
                     body: data.to_json,
                     headers: { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }.merge(headers),
-                    timeout: timeout,
+                    timeout: ,
                     verify: false)
     end
 
-    def post_with_token(url, data, _timeout = 30)
-      headers = { Authorization: "Bearer #{tenant_access_token}" }
-      post(url,
-           data,
-           headers)
+    def post_with_token(url, data, headers = {}, timeout = 30)
+      HTTParty.post(api(url),
+                    body: data,
+                    headers: { Authorization: "Bearer #{tenant_access_token}" }.merge(headers),
+                    timeout: )
+    end
+
+    def post_with_user_token(url, user_access_token, data, headers = {}, timeout = 30)
+      HTTParty.post(api(url),
+                    body: data,
+                    headers: { Authorization: "Bearer #{user_access_token}" }.merge(headers),
+                    timeout: )
+    end
+
+    def get_with_token(url, data = {}, headers = {}, timeout = 30)
+      HTTParty.get(api(url),
+                   body: data,
+                   headers: { Authorization: "Bearer #{tenant_access_token}" }.merge(headers),
+                   timeout: )
+    end
+
+    def get_with_user_token(url, user_access_token, data = {}, headers = {}, timeout = 30)
+      HTTParty.get(api(url),
+                   body: data,
+                   headers: { Authorization: "Bearer #{user_access_token}" }.merge(headers),
+                   timeout: )
+    end
+
+    def put_with_token(url, data = {}, headers = {}, timeout = 30)
+      HTTParty.put(api(url),
+                   body: data,
+                   headers: { Authorization: "Bearer #{tenant_access_token}" }.merge(headers),
+                   timeout: )
+    end
+
+    def put_with_user_token(url, user_access_token, data = {}, headers = {}, timeout = 30)
+      HTTParty.put(api(url),
+                   body: data,
+                   headers: { Authorization: "Bearer #{user_access_token}" }.merge(headers),
+                   timeout: )
+    end
+
+    def delete_with_token(url, data = {}, headers = {}, timeout = 30)
+      HTTParty.delete(api(url),
+                      body: data,
+                      headers: { Authorization: "Bearer #{tenant_access_token}" }.merge(headers),
+                      timeout: )
+    end
+
+    def delete_with_user_token(url, user_access_token, data = {}, headers = {}, timeout = 30)
+      HTTParty.delete(api(url),
+                      body: data,
+                      headers: { Authorization: "Bearer #{user_access_token}" }.merge(headers),
+                      timeout: )
+    end
+
+    def patch_with_token(url, data = {}, headers = {}, timeout = 30)
+      HTTParty.patch(api(url),
+                     body: data,
+                     headers: { Authorization: "Bearer #{tenant_access_token}" }.merge(headers),
+                     timeout: )
+    end
+
+    def patch_with_user_token(url, user_access_token, data = {}, headers = {}, timeout = 30)
+      HTTParty.patch(api(url),
+                     body: data,
+                     headers: { Authorization: "Bearer #{user_access_token}" }.merge(headers),
+                     timeout: )
     end
 
     def tenant_access_token
@@ -60,7 +128,8 @@ module FeishuApi
     # 发送消息
     def send_message(receive_type, receive_id, msg_type, content)
       res = post_with_token("#{API_SEND_MESSAGES}?receive_id_type=#{receive_type}",
-                            { receive_id: receive_id, msg_type: msg_type, content: content })
+                            { receive_id: , msg_type: , content: })
+      # p res
       return nil if res.code != 200
 
       JSON.parse(res.body)
@@ -73,22 +142,329 @@ module FeishuApi
 
     # 发文本消息到指定群聊
     def send_text_by_group(receive_id, text)
-      send_message_by_group(receive_id, 'text', JSON.generate({ text: text }))
+      send_message_by_group(receive_id, 'text', JSON.generate({ text: }))
+    end
+
+    # 上传图片
+    def upload_image(path)
+      post_with_token(API_UPLOAD_IMAGE.to_s, { image_type: 'message', image: File.new(path) },
+                      { 'Content-Type' => 'multipart/formdata', 'Accept' => 'application/json' })
+    end
+
+    # 下载图片
+    def download_image(image_key)
+      get_with_token("#{API_UPLOAD_IMAGE}/#{image_key}")
+    end
+
+    # 上传文件
+    def upload_file(path, file_type)
+      post_with_token(API_UPLOAD_FILES.to_s,
+                      { file_type: file_type, file_name: File.basename(path), file: File.new(path) },
+                      { 'Content-Type' => 'multipart/formdata' })
+    end
+
+    # 下载文件
+    def download_file(file_key)
+      HTTParty.get("#{API_HOST}#{API_UPLOAD_FILES}/#{file_key}",
+                   headers: { Authorization: "Bearer #{tenant_access_token}" })
+    end
+
+    # 发文件消息到指定群聊
+    def send_file_by_group(receive_id, file_key)
+      send_message_by_group(receive_id, 'file', JSON.generate({ file_key: }))
+    end
+
+    # 撤回消息
+    def withdraw_message(message_id)
+      delete_with_token("#{API_SEND_MESSAGES}/#{message_id}")
+    end
+
+    # 查询消息已读信息
+    def check_reader(message_id)
+      get_with_token("#{API_SEND_MESSAGES}/#{message_id}/read_users?user_id_type=open_id")
+    end
+
+    # 发图片消息到指定群聊
+    def send_image_by_group(receive_id, image_key)
+      send_message_by_group(receive_id, 'image', JSON.generate({ image_key: }))
+    end
+
+    #  回复消息
+    def reply_message(message_id)
+      post_with_token("#{API_SEND_MESSAGES}/#{message_id}/reply",
+                      { content: '{"text":" test content"}', msg_type: 'text' })
+    end
+
+    # 获取会话（历史）消息
+    def get_chat_messages(container_id)
+      get_with_token("#{API_SEND_MESSAGES}?container_id_type=chat&container_id=#{container_id}")
+    end
+
+    # 获取指定消息的内容
+    def get_message_content(message_id)
+      get_with_token("#{API_SEND_MESSAGES}/#{message_id}")
+    end
+
+    # 发送应用内加急消息 （需要相关权限）
+    def send_urgent_app_message(message_id, user_id)
+      patch_with_token("#{API_SEND_MESSAGES}/#{message_id}/urgent_app?user_id_type=user_id",
+                       { user_id_list: [user_id] })
+    end
+
+    # 添加消息表情回复
+    def add_message_reactions(message_id, emoji_type)
+      post_with_token("#{API_SEND_MESSAGES}/#{message_id}/reactions",
+                      {
+                        reaction_type: {
+                          emoji_type: emoji_type.to_s
+                        }
+                      }.to_json, { 'Content-Type' => 'application/json' })
+    end
+
+    # 获取消息表情回复
+    def get_message_reactions(message_id)
+      get_with_token("#{API_SEND_MESSAGES}/#{message_id}/reactions")
+    end
+
+    # 删除消息表情回复
+    def delete_message_reactions(message_id)
+      delete_with_token("#{API_SEND_MESSAGES}/#{message_id}/reactions")
+    end
+
+    # 获取用户或者机器人所在群列表
+    def bot_chat_list
+      get_with_token(API_CHATS.to_s)
+    end
+
+    # 搜索对用户或机器人可见的群列表
+    def search_chat_list(query)
+      get_with_token("#{API_CHATS}/search?query=#{query}")
+    end
+
+    # 灵缇高级管家 chat_id:oc_31e9100a2673814ecba937f0772b8ebc
+    # 获取群成员发言权限
+    def get_member_permission(chat_id)
+      get_with_token("#{API_CHATS}/#{chat_id}/moderation")
+    end
+
+    # 更新群成员发言权限
+    def update_member_permission(chat_id)
+      put_with_token("#{API_CHATS}/#{chat_id}/moderation")
+    end
+
+    # 更新群置顶
+    def update_group_top_notice(chat_id, message_id)
+      post_with_token("#{API_CHATS}/#{chat_id}/top_notice/put_top_notice",
+                      {
+                        chat_top_notice: [
+                          {
+                            action_type: '1',
+                            message_id: message_id.to_s
+                          }
+                        ]
+                      }.to_json, { 'Content-Type' => 'application/json', 'Accept' => 'application/json' })
+    end
+
+    # 撤销群置顶
+    def delete_group_top_notice(chat_id)
+      delete_with_token("#{API_CHATS}/#{chat_id}/top_notice/delete_top_notice")
+    end
+
+    # 创建群
+    def create_group(name)
+      post_with_token(API_CHATS.to_s,
+                      { name: name.to_s })
+    end
+
+    # 获取群信息
+    def get_group_info(chat_id)
+      get_with_token("#{API_CHATS}/#{chat_id}")
+    end
+
+    # 更新群信息
+    def update_group_info(chat_id, description)
+      put_with_token("#{API_CHATS}/#{chat_id}", { description: description.to_s })
+    end
+
+    # 解散群
+    def dissolve_group(chat_id)
+      delete_with_token("#{API_CHATS}/#{chat_id}")
+    end
+
+    # 将用户或机器人拉入群聊
+    def add_group_member(chat_id, id_list)
+      post_with_token("#{API_CHATS}/#{chat_id}/members",
+                      { id_list: }.to_json, { 'Content-Type' => 'application/json', 'Accept' => 'application/json' })
+    end
+
+    # 将用户或机器人移出群聊
+    def delete_group_member(chat_id, id_list)
+      delete_with_token("#{API_CHATS}/#{chat_id}/members",
+                        { id_list: }.to_json, { 'Content-Type' => 'application/json', 'Accept' => 'application/json' })
+    end
+
+    # 用户或机器人主动加入群聊
+    # 需要打开群设置：公开
+    def join_group(chat_id)
+      patch_with_token("#{API_CHATS}/#{chat_id}/members/me_join")
+    end
+
+    # 判断用户或机器人是否在群里
+    def member_is_in_chat(chat_id)
+      get_with_token("#{API_CHATS}/#{chat_id}/members/is_in_chat")
+    end
+
+    # 指定群管理员
+    def add_group_managers(chat_id, manager_ids)
+      post_with_token("#{API_CHATS}/#{chat_id}/managers/add_managers",
+                      { manager_ids: }.to_json, { 'Content-Type' => 'application/json' })
+    end
+
+    # 删除群管理员
+    def delete_group_managers(chat_id, manager_ids)
+      post_with_token("#{API_CHATS}/#{chat_id}/managers/delete_managers",
+                      { manager_ids: }.to_json, { 'Content-Type' => 'application/json' })
     end
 
+    # 获取群成员列表
+    def get_group_members(chat_id)
+      get_with_token("#{API_CHATS}/#{chat_id}/members")
+    end
+
+    # 获取群公告信息
+    def get_group_announcement(chat_id)
+      get_with_token("#{API_CHATS}/#{chat_id}/announcement")
+    end
+
+    # 更新群公告信息
+    # rubocop:disable all
+    def update_group_announcement(chat_id)
+      patch_with_token("#{API_CHATS}/#{chat_id}/announcement",
+        {
+          "revision": "0",
+          "requests": [
+            "{\"requestType\":\"UpdateTitleRequestType\",\"updateTitleRequest\":{\"payload\":\"{\\\"elements\\\":[{\\\"type\\\":\\\"textRun\\\",\\\"textRun\\\":{\\\"text\\\":\\\"Updated Document Title\\\",\\\"style\\\":{}}}],\\\"style\\\":{}}\"}}"
+          ]
+        }.to_json, { 'Content-Type' => 'application/json'})
+    end
+    # rubocop:enable all
+
     # 通过邮箱识别用户, 发消息到指定用户
     def send_message_by_email(receive_id, msg_type, content)
       send_message('email', receive_id, msg_type, content)
     end
 
     # 自定义机器人接口 发送消息
-    def custom_robot_send(data, hook_id)
-      post("#{API_CUSTOM_BOT_SEND}/#{hook_id}", data)
+    def custom_robot_send(data, hook_id, secret = '')
+      if secret != ''
+        timestamp = Time.now.to_i.to_s
+        string_to_sign = "#{timestamp}\n#{secret}"
+        hmac_code = OpenSSL::HMAC.digest('sha256', string_to_sign, "")
+        sign = Base64.encode64(hmac_code).strip
+        data = {timestamp: , sign: }.merge(data)
+      end
+      res = post("#{API_CUSTOM_BOT_SEND}/#{hook_id}", data)
       return nil if res.code != 200
 
       JSON.parse(res.body)
     end
 
+    # 预约会议
+    def reserve_meeting(token, end_time, check_list, topic)
+      post_with_user_token("#{API_RESERVES}/apply", token, {
+        end_time: Time.strptime(end_time, '%Y-%m-%d %H:%M:%S').to_i,
+        meeting_settings: {
+          topic: topic,
+          action_permissions: [
+            {
+              permission: 1,
+              permission_checkers: [
+                {
+                  check_field: 1,
+                  check_mode: 1,
+                  check_list: 
+                }
+              ]
+            }
+          ],
+          meeting_initial_type: 1,
+          call_setting: {
+            callee: {
+              id: check_list[0],
+              user_type: 1,
+              pstn_sip_info: {
+                nickname: 'dodo',
+                main_address: '+86-02187654321'
+              }
+            }
+          },
+          auto_record: true
+        }
+      }.to_json, { 'Content-Type' => 'application/json' })
+    end
+
+    # 更新预约
+    def update_reserve(token, reserve_id, topic, check_list, end_time)
+      put_with_user_token("#{API_RESERVES}/#{reserve_id}", token,
+                          {
+                            end_time: Time.strptime(end_time, '%Y-%m-%d %H:%M:%S').to_i,
+                            meeting_settings: {
+                              topic: topic,
+                              action_permissions: [
+                                {
+                                  permission: 1,
+                                  permission_checkers: [
+                                    {
+                                      check_field: 1,
+                                      check_mode: 1,
+                                      check_list: 
+                                    }
+                                  ]
+                                }
+                              ],
+                              meeting_initial_type: 1,
+                              call_setting: {
+                                callee: {
+                                  id: check_list[0],
+                                  user_type: 1,
+                                  pstn_sip_info: {
+                                    nickname: 'dodo',
+                                    main_address: '+86-02187654321'
+                                  }
+                                }
+                              },
+                              auto_record: true
+                            }
+                          }.to_json, { 'Content-Type' => 'application/json' })
+    end
+
+    # 删除预约
+    def delete_reserve(token, reserve_id)
+      delete_with_user_token("#{API_RESERVES}/#{reserve_id}", token)
+    end
+
+    # 获取预约
+    def get_reserve_info(token, reserve_id)
+      get_with_user_token("#{API_RESERVES}/#{reserve_id}", token)
+    end
+
+    # 获取活跃会议
+    def get_active_meeting(token, reserve_id)
+      get_with_user_token("#{API_RESERVES}/#{reserve_id}/get_active_meeting", token)
+    end
+
+    # 获取会议详情
+    def get_meeting_info(meeting_id)
+      get_with_token("#{API_MEETINGS}/#{meeting_id}")
+    end
+
+    # 获取与会议号相关联的会议列表
+    def get_list_by_no(meeting_number, start_time, end_time)
+      end_time_unix = Time.strptime(end_time, '%Y-%m-%d %H:%M:%S').to_i
+      start_time_unix = Time.strptime(start_time, '%Y-%m-%d %H:%M:%S').to_i
+      get_with_token("#{API_MEETINGS}/list_by_no?end_time=#{end_time_unix}&start_time=#{start_time_unix}&meeting_no=#{meeting_number}")
+    end
+
     # 自定义机器人接口 发送文本消息
     def custom_robot_send_text(text, hook_id)
       custom_robot_send({
@@ -101,7 +477,7 @@ module FeishuApi
                                   [
                                     {
                                       tag: 'text',
-                                      text: text
+                                      text: 
                                     }
                                   ]
                                 ]
@@ -112,7 +488,7 @@ module FeishuApi
     end
 
     # 自定义机器人接口 发送卡片消息
-    def custom_robot_send_card(title = '标题', theme = 'blue', elements = [], hook_id = '')
+    def custom_robot_send_card(title = '标题', theme = 'blue', elements = [], hook_id = '', secret = '')
       custom_robot_send({
                           msg_type: 'interactive',
                           card: {
@@ -126,9 +502,9 @@ module FeishuApi
                               },
                               template: theme
                             },
-                            elements: elements
+                            elements: 
                           }
-                        }, hook_id)
+                        }, hook_id, secret)
     end
   end
 end

data/lib/feishu-api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FeishuApi
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/lib/feishu-api.rb

@@ -5,6 +5,8 @@ require 'feishu-api/config'
 require 'feishu-api/api'
 
 require 'httparty'
+require 'openssl'
+require 'base64'
 
 module FeishuApi
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feishu-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - msk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -43,7 +43,7 @@ homepage: https://github.com/ruilisi/feishu-api
 licenses:
 - MIT
 metadata:
-  rubygems_mfa_required: 'false'
+  rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/ruilisi/feishu-api
   source_code_uri: https://github.com/ruilisi/feishu-api.git
   changelog_uri: https://github.com/ruilisi/feishu-api/blob/master/CHANGELOG.md