程序包 cn.duskykite.open.call

类 SAO

java.lang.Object
cn.duskykite.open.call.SAO
public class SAO extends Object
飞书开放接口远程调用对象

  • 字段详细资料

    • OPENAPI_PRIMARY_URL

      @NonNull public static final @NonNull okhttp3.HttpUrl OPENAPI_PRIMARY_URL
      飞书开放接口主链接

    • APPLICATION_JSON_UTF_8

      @NonNull public static final @NonNull okhttp3.MediaType APPLICATION_JSON_UTF_8
      内容类型：JSON（UTF-8）

    • JSON_CONTENT_TYPE_HEADERS

      @NonNull public static final @NonNull okhttp3.Headers JSON_CONTENT_TYPE_HEADERS
      JSON内容类型头部信息

  • 构造器详细资料

    • SAO

      public SAO()

  • 方法详细资料

    • toAuthorization

      @NonNull public static @NonNull String toAuthorization(@NonNull @NonNull String token)
      生成授权信息
      参数:
      token - 凭据信息
      返回:
      授权信息

    • toContentTypeHeaders

      @NonNull public static @NonNull okhttp3.Headers toContentTypeHeaders(@NonNull @NonNull okhttp3.MediaType mediaType)
      生成内容类型的头部信息
      参数:
      mediaType - 内容类型
      返回:
      内容类型的头部信息

    • toAuthorizationHeaders

      @NonNull public static @NonNull okhttp3.Headers toAuthorizationHeaders(@NonNull @NonNull String authorization)
      生成用于鉴权的头部信息
      参数:
      authorization - 鉴权凭据信息
      返回:
      鉴权的头部信息

    • pagingAll

      public static <P extends PageIterator, C> C pagingAll(@NonNull @NonNull Function<String,? extends P> paging, C identity, @NonNull @NonNull BiFunction<C,? super P,C> accumulator)
      分页式获取所有页的元素，并收集到统一的容器中
      类型参数:
      P - 分页迭代对象的类型
      C - 统一化容器的类型
      参数:
      paging - 根据分页标记执行分页式元素获取的方法
      identity - 统一的容器
      accumulator - 将分页元素统一化收集到容器中的方法
      返回:
      已经收集完所有页的元素的容器

    • postAuthV3AppAccessToken

      @NonNull public @NonNull Response<PostAuthV3AppAccessTokenResult> postAuthV3AppAccessToken(@NonNull @NonNull PostAuthV3AppAccessTokenRequestBody body)
      商店应用获取 app_access_token
      参数:
      body - 请求体
      返回:
      响应结果

    • postAuthV3TenantAccessToken

      @NonNull public @NonNull Response<PostAuthV3TenantAccessTokenResult> postAuthV3TenantAccessToken(@NonNull @NonNull PostAuthV3TenantAccessTokenRequestBody body)
      商店应用获取 tenant_access_token
      参数:
      body - 请求体
      返回:
      响应结果

    • postAuthV3TenantAccessTokenInternal

      @NonNull public @NonNull Response<PostAuthV3TenantAccessTokenInternalResult> postAuthV3TenantAccessTokenInternal(@NonNull @NonNull PostAuthV3TenantAccessTokenInternalRequestBody body)
      自建应用获取 tenant_access_token
      参数:
      body - 请求体
      返回:
      响应结果

    • getContactV3DepartmentsDepartmentId

      @NonNull public @NonNull Response<DataResult<GetContactV3DepartmentsDepartmentIdData>> getContactV3DepartmentsDepartmentId(@NonNull @NonNull String authorization, @NonNull @NonNull String departmentId, String userIdType, String departmentIdType)
      获取单个部门信息
      参数:
      authorization - tenant_access_token 或 user_access_token
      departmentId - 需要获取的部门ID 不同 ID 的说明及获取方式 参见部门ID说明
      userIdType - 用户 ID 类型 open_id/union_id/user_id 默认值：open_id
      departmentIdType - 此次调用中使用的部门ID的类型 不同 ID 的说明 部门ID说明
      返回:
      响应结果

    • getContactV3DepartmentsDepartmentIdChildren

      @NonNull public @NonNull Response<DataResult<GetContactV3DepartmentsDepartmentIdChildrenData>> getContactV3DepartmentsDepartmentIdChildren(@NonNull @NonNull String authorization, @NonNull @NonNull String departmentId, String userIdType, String departmentIdType, Boolean fetchChild, Integer pageSize, String pageToken)
      获取子部门列表
      参数:
      authorization - tenant_access_token 或 user_access_token
      departmentId - 部门ID，根部门的部门ID 为0 department_id的获取方式参见 部门ID说明
      userIdType - 用户 ID 类型 open_id/union_id/user_id 示例值："open_id"
      departmentIdType - 此次调用中使用的部门ID的类型 不同 ID 的说明与department_id的获取方式参见 部门ID说明 department_id/open_department_id 默认值：open_department_id
      fetchChild - 是否递归获取子部门
      pageSize - 分页大小 示例值：10 默认值：10
      pageToken - 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
      返回:
      响应结果

    • getContactV3Scopes

      @NonNull public @NonNull Response<DataResult<GetContactV3ScopesData>> getContactV3Scopes(@NonNull @NonNull String authorization, String userIdType, String departmentIdType, String pageToken, Integer pageSize)
      获取通讯录授权范围
      参数:
      authorization - tenant_access_token
      userIdType - 用户 ID 类型 open_id/union_id/user_id 默认值：open_id
      departmentIdType - 返回值的部门ID的类型 department_id/open_department_id 默认值：open_department_id
      pageToken - 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
      pageSize - 分页大小 最大值：100
      返回:
      响应结果

    • getContactV3UsersFindByDepartment

      @NonNull public @NonNull Response<DataResult<GetContactV3UsersFindByDepartmentData>> getContactV3UsersFindByDepartment(@NonNull @NonNull String authorization, String userIdType, String departmentIdType, @NonNull @NonNull String departmentId, Integer pageSize, String pageToken)
      获取部门直属用户列表
      参数:
      authorization - tenant_access_token 或 user_access_token
      userIdType - 用户 ID 类型 open_id/union_id/user_id 默认值：open_id
      departmentIdType - 返回值的部门ID的类型 department_id/open_department_id 默认值：open_department_id
      departmentId - 填写该字段表示获取该部门下用户，必填。根部门的部门ID为0。ID值与查询参数中的department_id_type 对应。不同 ID 的说明与department_id的获取方式参见 部门ID说明
      pageSize - 分页大小 默认值：10 最大值：50
      pageToken - 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
      返回:
      响应结果

    • getContactV3UsersUserId

      @NonNull public @NonNull Response<DataResult<GetContactV3UsersUserIdData>> getContactV3UsersUserId(@NonNull @NonNull String authorization, @NonNull @NonNull String userId, String userIdType, String departmentIdType)
      获取单个用户信息
      参数:
      authorization - tenant_access_token 或 user_access_token
      userId - 用户ID，类型需要与查询参数中的user_id_type保持一致。 例如user_id_type=open_id，user_id的类型需为open_id 不同ID的说明参见 用户相关的 ID 概念
      userIdType - 用户 ID 类型 open_id/union_id/user_id 默认值：open_id
      departmentIdType - 返回值的部门ID的类型 department_id/open_department_id 默认值：open_department_id
      返回:
      响应结果

    • postIMV1Image

      @NonNull public @NonNull Response<DataResult<PostIMV1ImageData>> postIMV1Image(@NonNull @NonNull String authorization, @NonNull @NonNull PostIMV1ImageRequestBody body)
      上传图片
      参数:
      authorization - tenant_access_token
      body - 请求体
      返回:
      响应结果

    • postIMV1Messages

      @NonNull public @NonNull Response<DataResult<IMV1Messages>> postIMV1Messages(@NonNull @NonNull String authorization, @NonNull @NonNull String receiveIdType, @NonNull @NonNull PostIMV1MessagesRequestBody body)
      发送消息
      参数:
      authorization - tenant_access_token
      receiveIdType - 消息接收者id类型 open_id/user_id/union_id/email/chat_id
      body - 请求体
      返回:
      响应结果

    • patchIMV1MessagesMessageId

      @NonNull public @NonNull Response<DataResult<Object>> patchIMV1MessagesMessageId(@NonNull @NonNull String authorization, @NonNull @NonNull String messageId, @NonNull @NonNull PatchIMV1MessagesMessageIdRequestBody body)
      更新应用发送的消息卡片
      参数:
      authorization - tenant_access_token 或 user_access_token
      messageId - 待更新的消息的ID，仅支持更新消息卡片（interactive类型），详情参见...
      body - 请求体
      返回:
      响应结果

    • postIMV1MessagesMessageIdReply

      @NonNull public @NonNull Response<DataResult<IMV1Messages>> postIMV1MessagesMessageIdReply(@NonNull @NonNull String authorization, @NonNull @NonNull String messageId, @NonNull @NonNull PostIMV1MessagesMessageIdReplyRequestBody body)
      回复消息
      参数:
      authorization - tenant_access_token
      messageId - 待回复的消息的ID，详情参见 消息ID说明
      body - 请求体
      返回:
      响应结果

    • getIMV1MessagesResources

      @NonNull public @NonNull Response<byte[]> getIMV1MessagesResources(@NonNull @NonNull String authorization, @NonNull @NonNull String messageId, @NonNull @NonNull String fileKey, @NonNull @NonNull String type)
      获取消息中的资源文件
      参数:
      authorization - tenant_access_token
      messageId - 待查询资源对应的消息ID
      fileKey - 待查询资源的key
      type - 资源类型 image/file
      返回:
      响应结果

    • postInteractiveV1CardUpdate

      @NonNull public @NonNull Response<Result> postInteractiveV1CardUpdate(@NonNull @NonNull String authorization, @NonNull @NonNull PostInteractiveV1CardUpdateRequestBody body)
      延时更新消息卡片
      参数:
      authorization - tenant_access_token
      body - 请求体
      返回:
      响应结果

    • postMessageV4BatchSend

      @NonNull public @NonNull Response<DataResult<PostMessageV4BatchSendData>> postMessageV4BatchSend(@NonNull @NonNull String authorization, @NonNull @NonNull PostMessageV4BatchSendRequestBody body)
      批量发送消息
      参数:
      authorization - tenant_access_token
      body - 请求体
      返回:
      响应结果

    • getIMV1Chats

      @NonNull public @NonNull Response<DataResult<GetIMV1ChatsData>> getIMV1Chats(@NonNull @NonNull String authorization, String userIdType, String pageToken, Integer pageSize)
      获取用户或机器人所在的群列表
      参数:
      authorization - tenant_access_token 或 user_access_token
      userIdType - 用户 ID 类型 open_id/union_id/user_id 默认值：open_id
      pageToken - 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
      pageSize - 分页大小 默认值：20 最大值：100
      返回:
      响应结果

    • getIMV1ChatsMembers

      @NonNull public @NonNull Response<DataResult<GetIMV1ChatsMembersData>> getIMV1ChatsMembers(@NonNull @NonNull String authorization, @NonNull @NonNull String chatId, String memberIdType, String pageToken, Integer pageSize)
      获取群成员列表
      参数:
      authorization - tenant_access_token 或 user_access_token
      chatId - 群 ID，详情参见 群ID 说明
      memberIdType - 群成员 用户 ID 类型，详情参见 用户相关的 ID 概念
      pageToken - 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
      pageSize - 分页大小 默认值：20 最大值：100
      返回:
      响应结果

    • variables

      @NonNull protected static @NonNull List<@Nullable String> variables(Object... variables)
      生成路径中的变量对应的字符串的列表
      参数:
      variables - 路径中的变量数组
      返回:
      路径中的变量字符串列表

    • headers

      protected static okhttp3.Headers headers(okhttp3.Headers... headers)
      合成头部信息
      参数:
      headers - 待合成的头部信息数组
      返回:
      合成后的头部信息

    • toJsonRequestBody

      @NonNull protected static @NonNull okhttp3.RequestBody toJsonRequestBody(@NonNull @NonNull Object body)
      生成Json格式的请求体
      参数:
      body - 请求体对象
      返回:
      Json请求体

    • toMultipartBody

      @NonNull protected static @NonNull okhttp3.MultipartBody toMultipartBody(@NonNull @NonNull MultipartBodySupplier supplier)
      生成复合请求体
      参数:
      supplier - 复合请求体提供方法
      返回:
      复合请求体

    • toJsonResultMapper

      @NonNull protected static <T> @NonNull JsonResultMapper<T> toJsonResultMapper(@NonNull @NonNull com.google.gson.reflect.TypeToken<? extends T> typeToken)
      生成按Json格式转化为Java对象的转化方法
      类型参数:
      T - Java对象的类型
      参数:
      typeToken - 类凭据
      返回:
      按Json格式转化为Java对象的转化方法

    • request

      @NonNull protected <T> @NonNull Response<T> request(@NonNull @NonNull UnaryOperator<okhttp3.Request.Builder> method, @NonNull @NonNull String path, okhttp3.Headers headers, @NonNull @NonNull Function<okhttp3.ResponseBody,? extends T> resultMapper)
      执行HTTP请求
      类型参数:
      T - 响应结果的类型
      参数:
      method - 请求方法
      path - 路径
      headers - 头部信息
      resultMapper - 结果转化方法
      返回:
      响应结果

    • get

      @NonNull protected <T> @NonNull Response<T> get(@NonNull @NonNull String path, okhttp3.Headers headers, @NonNull @NonNull Function<okhttp3.ResponseBody,? extends T> resultMapper)
      执行HTTP GET请求
      类型参数:
      T - 响应结果的类型
      参数:
      path - 路径
      headers - 头部信息
      resultMapper - 结果生成方法
      返回:
      响应结果

    • post

      @NonNull protected <T> @NonNull Response<T> post(@NonNull @NonNull String path, okhttp3.Headers headers, @NonNull @NonNull okhttp3.RequestBody body, @NonNull @NonNull Function<okhttp3.ResponseBody,? extends T> resultMapper)
      执行HTTP POST请求
      类型参数:
      T - 响应结果的类型
      参数:
      path - 路径
      headers - 头部信息
      body - 请求体
      resultMapper - 结果生成方法
      返回:
      响应结果

    • patch

      @NonNull protected <T> @NonNull Response<T> patch(@NonNull @NonNull String path, okhttp3.Headers headers, @NonNull @NonNull okhttp3.RequestBody body, @NonNull @NonNull Function<okhttp3.ResponseBody,? extends T> resultMapper)
      执行HTTP PATCH请求
      类型参数:
      T - 响应结果的类型
      参数:
      path - 路径
      headers - 头部信息
      body - 请求体
      resultMapper - 结果生成方法
      返回:
      响应结果

    • delete

      @NonNull protected <T> @NonNull Response<T> delete(@NonNull @NonNull String path, okhttp3.Headers headers, okhttp3.RequestBody body, @NonNull @NonNull Function<okhttp3.ResponseBody,? extends T> resultMapper)
      执行HTTP DELETE请求
      类型参数:
      T - 响应结果的类型
      参数:
      path - 路径
      headers - 头部信息
      body - 请求体
      resultMapper - 结果生成方法
      返回:
      响应结果

    • post

      @NonNull protected <T> @NonNull Response<T> post(@NonNull @NonNull OpenAPIEnum openApiEnum, Collection<@Nullable String> pathVariables, okhttp3.Headers headers, @NonNull @NonNull okhttp3.RequestBody body, @NonNull @NonNull Function<okhttp3.ResponseBody,? extends T> resultMapper)
      执行HTTP POST请求
      类型参数:
      T - 响应结果的类型
      参数:
      openApiEnum - 开放接口枚举
      pathVariables - 路径中的变量字符串（多个）
      headers - 头部信息
      body - 请求体
      resultMapper - 结果生成方法
      返回:
      响应结果

    • patch

      @NonNull protected <T> @NonNull Response<T> patch(@NonNull @NonNull OpenAPIEnum openApiEnum, Collection<@Nullable String> pathVariables, okhttp3.Headers headers, @NonNull @NonNull okhttp3.RequestBody body, @NonNull @NonNull Function<okhttp3.ResponseBody,? extends T> resultMapper)
      执行HTTP PATCH请求
      类型参数:
      T - 响应结果的类型
      参数:
      openApiEnum - 开放接口枚举
      pathVariables - 路径中的变量字符串（多个）
      headers - 头部信息
      body - 请求体
      resultMapper - 结果生成方法
      返回:
      响应结果

    • delete

      @NonNull protected <T> @NonNull Response<T> delete(@NonNull @NonNull OpenAPIEnum openApiEnum, Collection<@Nullable String> pathVariables, okhttp3.Headers headers, okhttp3.RequestBody body, @NonNull @NonNull Function<okhttp3.ResponseBody,? extends T> resultMapper)
      执行HTTP DELETE请求
      类型参数:
      T - 响应结果的类型
      参数:
      openApiEnum - 开放接口枚举
      pathVariables - 路径中的变量字符串（多个）
      headers - 头部信息
      body - 请求体
      resultMapper - 结果生成方法
      返回:
      响应结果