me.chanjar.weixin.cp.api

接口 WxCpOaWeDocService

所有已知实现类:

WxCpOaWeDocServiceImpl

public interface WxCpOaWeDocService

企业微信文档相关接口. 文档

作者:

Hugo

方法概要

限定符和类型	方法和说明
WxCpDocSheetBatchUpdateResponse	docBatchUpdate(@NonNull WxCpDocSheetBatchUpdateRequest request) 编辑表格内容 该接口可以对一个在线表格批量执行多个更新操作 注意： 1.批量更新请求中的各个操作会逐个按顺序执行，直到全部执行完成则请求返回，或者其中一个操作报错则不再继续执行后续的操作 2.每一个更新操作在执行之前都会做请求校验（包括权限校验、参数校验等等），如果校验未通过则该更新操作会报错并返回，不再执行后续操作 3.单次批量更新请求的操作数量 <= 5 请求方式：POST（HTTPS） 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/batch_update?
WxCpDocCreateData	docCreate(@NonNull WxCpDocCreateRequest request) 新建文档 该接口用于新建文档和表格，新建收集表可前往 收集表管理 查看。
WxCpBaseResp	docDelete(String docId, String formId) 删除文档/收集表 该接口用于删除指定文档/收集表。
WxCpDocInfo	docInfo(@NonNull String docId) 获取文档基础信息 该接口用于获取指定文档的基础信息。
WxCpBaseResp	docRename(@NonNull WxCpDocRenameRequest request) 重命名文档/收集表 该接口用于对指定文档/收集表进行重命名。
WxCpDocShare	docShare(@NonNull String docId) 分享文档 该接口用于获取文档的分享链接。
WxCpDocSheetProperties	getSheetProperties(@NonNull String docId) 获取表格行列信息 该接口用于获取在线表格的工作表、行数、列数等。
WxCpDocSheetData	getSheetRangeData(@NonNull WxCpDocSheetGetDataRequest request) 本接口用于获取指定范围内的在线表格信息，单次查询的范围大小需满足以下限制： 查询范围行数 <=1000 查询范围列数 <=200 范围内的总单元格数量 <=10000 请求方式：POST（HTTPS） 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/get_sheet_range_data?

方法详细资料

docCreate

WxCpDocCreateData docCreate(@NonNull
                            @NonNull WxCpDocCreateRequest request)
                     throws WxErrorException

新建文档 该接口用于新建文档和表格，新建收集表可前往 收集表管理 查看。

请求方式：POST（HTTPS） 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/create_doc?access_token=ACCESS_TOKEN

参数:

request - 新建文档对应请求参数

返回:

url：新建文档的访问链接，docid：新建文档的docid

抛出:

WxErrorException - the wx error exception

docRename

WxCpBaseResp docRename(@NonNull
                       @NonNull WxCpDocRenameRequest request)
                throws WxErrorException

重命名文档/收集表 该接口用于对指定文档/收集表进行重命名。

请求方式：POST（HTTPS） 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/rename_doc?access_token=ACCESS_TOKEN

参数:

request - 重命名文档/收集表

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

docDelete

WxCpBaseResp docDelete(String docId,
                       String formId)
                throws WxErrorException

删除文档/收集表 该接口用于删除指定文档/收集表。

请求方式：POST（HTTPS） 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/del_doc?access_token=ACCESS_TOKEN

参数:

docId - 文档docid（docid、formid只能填其中一个）

formId - 收集表id（docid、formid只能填其中一个）

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

docInfo

WxCpDocInfo docInfo(@NonNull
                    @NonNull String docId)
             throws WxErrorException

获取文档基础信息 该接口用于获取指定文档的基础信息。

请求方式：POST（HTTPS） 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/get_doc_base_info?access_token=ACCESS_TOKEN

参数:

docId - 文档docid

返回:

wx cp doc info

抛出:

WxErrorException - the wx error exception

docShare

WxCpDocShare docShare(@NonNull
                      @NonNull String docId)
               throws WxErrorException

分享文档 该接口用于获取文档的分享链接。

请求方式：POST（HTTPS） 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/doc_share?access_token=ACCESS_TOKEN

参数:

docId - 文档docid

返回:

url 文档分享链接

抛出:

WxErrorException - the wx error exception

docBatchUpdate

WxCpDocSheetBatchUpdateResponse docBatchUpdate(@NonNull
                                               @NonNull WxCpDocSheetBatchUpdateRequest request)
                                        throws WxErrorException

编辑表格内容 该接口可以对一个在线表格批量执行多个更新操作

注意： 1.批量更新请求中的各个操作会逐个按顺序执行，直到全部执行完成则请求返回，或者其中一个操作报错则不再继续执行后续的操作 2.每一个更新操作在执行之前都会做请求校验（包括权限校验、参数校验等等），如果校验未通过则该更新操作会报错并返回，不再执行后续操作 3.单次批量更新请求的操作数量 <= 5

请求方式：POST（HTTPS） 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/batch_update?access_token=ACCESS_TOKEN

参数:

request - 编辑表格内容请求参数

返回:

编辑表格内容批量更新的响应结果

抛出:

WxErrorException - the wx error exception

getSheetProperties

WxCpDocSheetProperties getSheetProperties(@NonNull
                                          @NonNull String docId)
                                   throws WxErrorException

获取表格行列信息 该接口用于获取在线表格的工作表、行数、列数等。

请求方式：POST（HTTPS） 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/get_sheet_properties?access_token=ACCESS_TOKEN

参数:

docId - 在线表格的docid

返回:

返回表格行列信息

抛出:

WxErrorException

getSheetRangeData

WxCpDocSheetData getSheetRangeData(@NonNull
                                   @NonNull WxCpDocSheetGetDataRequest request)
                            throws WxErrorException

本接口用于获取指定范围内的在线表格信息，单次查询的范围大小需满足以下限制：

查询范围行数 <=1000 查询范围列数 <=200 范围内的总单元格数量 <=10000

请求方式：POST（HTTPS） 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/get_sheet_range_data?access_token=ACCESS_TOKEN

参数:

request - 获取指定范围内的在线表格信息请求参数

返回:

返回指定范围内的在线表格信息

抛出:

WxErrorException