apis - seandong/lark-ruby-sdk GitHub Wiki

授权

lib/lark/apis/auth.rb

名称	接口
获取 app_access_token	api.app_access_token
获取 tenant_access_token	api.tenant_access_token
更新 app_ticket	api.app_ticket=
获取 app_ticket	api.app_ticket
重新推送 app_ticket	api.auth.app_ticket_resend

身份验证

lib/lark/apis/authen.rb

名称	接口
请求身份验证	api.authen.index(redirect_uri, state)
获取登录用户身份	api.authen.access_token(code)
刷新 access_token	api.authen.refresh_access_token(refresh_token)
获取用户信息	api.authen.user_info(user_access_token)

通讯录

lib/lark/apis/contact.rb lib/lark/apis/user.rb lib/lark/apis/search.rb

名称	接口
获取通讯录授权范围	api.contact.scope_get
新增部门	api.contact.department_add
批量新增部门	api.contact.department_batch_add
删除部门	api.contact.department_delete
更新部门信息	api.contact.department_update
获取部门详情	api.contact.department_get
获取子部门列表	api.contact.department_children
获取子部门 ID 列表	api.contact.department_children_ids
批量获取部门详情	api.contact.department_batch_get
获取部门用户列表	api.contact.department_user_list
获取部门用户详情	api.contact.department_user_detail_list
新增用户	api.contact.user_add
批量新增用户	api.contact.user_batch_add
删除用户	api.contact.user_delete
更新用户信息	api.contact.user_update
批量获取用户信息	api.contact.user_batch_get
获取企业自定义用户属性配置	api.contact.tenant_custom_attr_get
查询批量任务执行状态	api.contact.task_get
获取应用管理员管理范围	api.contact.user_admin_scope_get
获取角色列表	api.contact.role_list
获取角色成员列表	api.contact.role_members
使用手机号或邮箱获取用户 ID	api.user.batch_get_id
搜索用户	api.search.user

用户群组

lib/lark/apis/user.rb

名称	接口
获取用户所在的群列表	api.user.group_list
获取群成员列表	api.chat.members
搜索用户所在的群列表	api.chat.search

应用管理

lib/lark/apis/application.rb

名称	接口
校验应用管理员	api.application.is_user_admin
获取应用在企业内的可用范围	api.application.app_visibility
获取用户可用的应用	api.application.user_visible_apps
获取企业安装的应用	api.application.app_list
更新应用可用范围	api.application.app_update_visibility

应用商店

lib/lark/apis/pay.rb

名称	接口
查询用户是否在应用开通范围	api.pay.paid_scope_check_user
查询租户购买的付费方案	api.pay.order_list
查询订单详情	api.pay.order_get

机器人 → 群信息和群管理

lib/lark/apis/chat.rb

名称	接口
创建群	api.chat.create
获取群列表	api.chat.list
获取群信息	api.chat.info
更新群信息	api.chat.update
拉用户进群	api.chat.chatter_add
移除用户出群	api.chat.chatter_delete
解散群	api.chat.disband

机器人信息和管理

lib/lark/apis/bot.rb

名称	接口
获取机器人信息	api.bot.info
拉机器人进群	api.bot.add
将机器人移出群	api.bot.remove

消息

lib/lark/apis/message.rb

名称	接口
批量发送消息	api.message.batch_send
发送消息（文本/图片/富文本/名片/卡片）	api.message.direct_send

图片

lib/lark/apis/image.rb

名称	接口
上传图片	api.image.upload
获取图片	api.image.download