服务商代开发
基础
数据与智能专区
应用接收专区通知
连接微信
客户联系
办公
服务商代开发
服务端API
文档
获取文档数据
获取文档数据
获取文档数据
最后更新:2023/10/19

目录

  • 获取文档数据
  • 参数详细说明
  •       Node
  •       Type
  •       Property
  •       SectionProperty
  •       PageSize
  •       PageOrientation
  •       PageOrientation
  •       PageMargins
  •       ParagraphProperty
  •       NumberProperty
  •       Spacing
  •       LineSpacingRule
  •       Indent
  •       AlignmentType
  •       TextDirection
  •       RunProperty
  •       Shading
  •       TextVerticalAlign
  •       TableProperty
  •       TableWidth
  •       TableHorizontalAlignmentType
  •       TableLayoutType
  •       TableWidthType
  •       TableRowProperty
  •       TableCellProperty
  •       Borders
  •       BorderProperty
  •       VerticalAlignment
  •       DrawingProperty
  •       Inline
  •       InlinePicture
  •       RelativeRect
  •       ShapeProperties
  •       Transform2D
  •       PositiveSize2D
  •       InlineAddon
  •       AddonSourceType
  •       Anchor
  •       AnchorPicture
  •       PositionHorizontal
  •       RelativeFromHorizontal
  •       PositionVertical
  •       RelativeFromVertical
  •       WrapSquare
  •       WrapText
  • 获取文档数据

    该接口用于获取文档数据

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/document/get?access_token=ACCESS_TOKEN

    请求包体

    {
    	"docid": "DOCID"
    }

    参数说明

    参数类型是否必须说明
    docidstring文档的docid

    权限说明

    • 自建应用需配置到“可调用应用”列表中的应用secret所获取的accesstoken来调用(accesstoken如何获取?
    • 第三方应用需具有“文档”权限
    • 代开发自建应用需具有“文档”权限

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"version": 10,
    	"document": {
    		...
    	}
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    versionuint32文档版本
    documentobject(Node)文档内容根节点,详见Node

    参数详细说明

    由于返回结果比较复杂,在本节分Object分别说明

    Node

    构成文档内容的节点

    示例

    {
    	"begin": 0,
    	"end": 20,
    	"property": {
    		...
    	},
    	"type": "Document",
    	"children": [
    		...
    	],
    	"text": "text content"
    }

    字段说明

    字段类型说明
    beginuint32起始位置
    enduint32结束位置
    propertyobject(Property)该节点的属性
    typestring节点类型,详见Type
    childrenobject(Node)子节点
    textstring文本内容,当节点类型为 Text 时有效

    Type

    Node类型的枚举值描述

    示例

    {
    	"type": "Document"
    }

    字段说明

    枚举值描述
    DocumentDoc 文档
    MainStory文档主节点,文档主体内容
    Section
    Paragraph段落
    Table表格
    TableRow表格行
    TableCell表格单元格
    Text一个具有相同属性集合的文本容器
    Drawing图形化对象 , 例如图表、图片等

    Property

    节点属性

    示例

    {
    	"section_property": {...},
    	"paragraph_property": {...},
    	"run_property": {...},
    	"table_property": {...},
    	"table_row_property": {...},
    	"table_cell_property": {...},
    	"drawing_property": {...}
    }

    字段说明

    字段类型说明
    section_propertyobject(SectionProperty)section 属性
    paragraph_propertyobject(ParagraphProperty段落属性
    run_propertyobject(RunProperty)文本属性
    table_propertyobject(TableProperty)表格属性
    table_row_propertyobject(TableRowProperty)表格行属性
    table_cell_propertyobject(TableCellProperty)表格单元属性
    drawing_propertyobject(DrawingProperty)drawing 属性

    SectionProperty

    示例

    {
      "page_size": {...},
      "page_margins": {...}
    }

    字段说明

    字段类型说明
    page_sizeobject(PageSize)页面尺寸
    page_marginsobject(PageMargins)页边距

     

    PageSize

    用于描述页面的大小

    示例

    {
      "width": 10,
      "height": 10,
      "orientation": {...}
    }

    字段说明

    字段类型说明
    widthdouble页面宽度
    heightdouble页面高度
    orientationobject(PageOrientation)页面方向

    PageOrientation

    示例

    {
      "width": 10,
      "height": 10,
      "orientation": {...}
    }

    字段说明

    字段类型说明
    widthdouble页面宽度
    heightdouble页面高度
    orientationstring页面方向,详见PageOrientation

    PageOrientation

    页面方向

    示例

    {
    	"orientation": "PAGE_ORIENTATION_PORTRAIT"
    }

    字段说明

    枚举值描述
    PAGE_ORIENTATION_UNSPECIFIED未知
    PAGE_ORIENTATION_PORTRAIT纵向
    PAGE_ORIENTATION_LANDSCAPE横向

    PageMargins

    页边距,指定了一个 Section 中所有页面的页边距属性

    示例

    {
      "top": 10,
      "right": 10,
      "bottom": 10,
      "left": 10
    }

    字段说明

    字段类型说明
    topdouble上边距
    rightdouble右边距
    bottomdouble下边距
    leftdouble左边距

    ParagraphProperty

    段落属性

    示例

    {
      "number_property": {...},
      "spacing": {...},
      "indent": {...},
      "alignment_type": "ALIGNMENT_TYPE_CENTER",
      "text_direction": "TEXT_DIRECTION_RIGHT_TO_LEFT"
    }

    字段说明

    字段类型说明
    number_propertyobject(NumberProperty)段落的编号属性
    spacingobject(Spacing)段落间距
    indentobject(Indent)段落缩进
    alignment_typestring文字水平方向的对齐类型, 详见AlignmentType
    text_directionstring文字方向,详见TextDirection

    NumberProperty

    段落的编号属性,描述该段落的项目符号、数字编号

    示例

    {
      "nesting_level": 1,
      "number_id": "2"
    }

    字段说明

    字段类型说明
    nesting_leveluint32编号缩进层级
    number_idstring编号 ID,一个列表中的每个段落编号 ID 相同

    Spacing

    段落间距

    示例

    {
      "before": 10,
      "after":10,
      "line": 10,
      "line_rule": "LINE_SPACING_RULE_AUTO"
    }

    字段说明

    字段类型说明
    beforedouble段后间距,单位是像素(px)
    afterdouble段前间距,单位是像素(px)
    linedouble行间距数值,单位是像素(px)
    line_ruleLineSpacingRule行间距格式

    LineSpacingRule

    行间距规则

    示例

    {
    	"line_rule": "LINE_SPACING_RULE_AUTO"
    }

    字段说明

    枚举值描述
    PAGE_ORIENTATION_UNSPECIFIED未知
    LINE_SPACING_RULE_AUTO自动
    LINE_SPACING_RULE_EXACT精确值
    LINE_SPACING_RULE_AT_LEAST最小行间距

    Indent

    段落缩进

    示例

    {
      "left": 10,
      "left_chars": 10,
      "right": 10,
      "right_chars": 10,
      "hanging": 10,
      "hanging_chars":10,
      "first_line": 10,
      "first_line_chars": 10,
    }

    字段说明

    字段类型说明
    leftdouble缩进左侧,单位是像素(px)
    left_charsuint32缩进左侧字符数,单位 1/20 字符宽度
    rightdouble缩进右侧,单位是像素(px)
    right_charsuint32缩进右侧字符数,单位 1/20 字符宽度
    hangingdouble垂直悬挂,单位是像素(px)
    hanging_charsuint32垂直悬挂字符数,单位 1/20 字符宽度
    first_linedouble首行缩进,单位是像素(px)
    first_line_charsuint32首行缩进字符数,单位 1/20 字符宽度

     

    AlignmentType

    水平方向对齐类型

    示例

    {
    	"alignment_type": "ALIGNMENT_TYPE_CENTER"
    }

    字段说明

    枚举值描述
    ALIGNMENT_TYPE_UNSPECIFIED未知
    ALIGNMENT_TYPE_CENTER指定文本应以文档中两个文本边距之间的中线为中心
    ALIGNMENT_TYPE_BOTH指定文本应在文档的两个文本边距之间对齐
    ALIGNMENT_TYPE_DISTRIBUTE指定文本应在文档的两个文本边距之间对齐,这种对齐方式会增加一行中每个字符中间的距离
    ALIGNMENT_TYPE_LEFT指定文本对齐文档的左边距
    ALIGNMENT_TYPE_RIGHT指定文本对齐文档的右边距

    TextDirection

    文字方向类型枚举
    示例

    {
    	"text_direction": "TEXT_DIRECTION_RIGHT_TO_LEFT"
    }

    字段说明

    枚举值描述
    TEXT_DIRECTION_UNSPECIFIED未知
    TEXT_DIRECTION_RIGHT_TO_LEFT从右至左
    TEXT_DIRECTION_LEFT_TO_RIGHT从左至右

    RunProperty

    text 的属性

    示例

    {
      "font": "",
      "bold": false,
      "italics": false, 
      "underline": false,
      "strike": false,
      "color": "0000FF",
      "spacing": 10, 
      "size": 10,
      "shading": {...},
      "vertical_align": "RUN_VERTICAL_ALIGN_BASELINE",
      "is_placeholder": false
    }

    字段说明

    字段类型说明
    fontstring字体
    boldbool文字是否加粗
    italicsbool文字是否斜体表示
    underlinebool文字是否下划线
    strikebool文字是否被删除线贯穿
    colorstring文字的颜色,颜色使用十六进制,RRGGBB格式
    spacingdouble字符的间距
    sizedouble文字的大小,单位是半个点(half-points),即 1/144 英寸
    shadingobject(Shading)文字阴影
    vertical_alignstring垂直对齐类型,指出当前字符串是否是上标、下标,详见TextVerticalAlign
    is_placeholderbool本节点是否占位符

    Shading

    阴影

    示例

    {
      "foreground_color": "FFFFFF",
      "background_color": "000000"
    }

    字段说明

    字段类型说明
    foreground_colorstring前景色,颜色使用十六进制RRGGBB 格式
    background_colorstring背景色,颜色使用十六进制 RRGGBB格式

    TextVerticalAlign

    竖直对齐类型枚举
    示例

    {
    	"vertical_align": "RUN_VERTICAL_ALIGN_BASELINE"
    }

    字段说明

    枚举值描述 
    RUN_VERTICAL_ALIGN_UNSPECIFIED0未知
    RUN_VERTICAL_ALIGN_BASELINE1对齐基线
    RUN_VERTICAL_ALIGN_SUPER_SCRIPT2上标
    RUN_VERTICAL_ALIGN_SUB_SCRIPT3下标

    TableProperty

    表格属性,指定了一组表格宽度的属性。这个属性对所有的表格行和表格单元都会生效,但是可以被表格行和表格单元的属性覆盖。

    示例

    {
      "table_width": {...},
      "horizontal_alignment_type": "TABLE_HORIZONTAL_ALIGNMENT_TYPE_CENTER",
      "table_layout": "TABLE_LAYOUT_TYPE_FIXED"
    }

    字段说明

    字段类型说明
    table_widthobject(TableWidth)表格宽度,指定该表的首选宽度,单位是像素(px)
    horizontal_alignment_typestring表格的水平对齐的方式,详见TableHorizontalAlignmentType
    table_layoutstring表格布局,详见TableLayoutType

    TableWidth

    表格宽度,指定该表的首选宽度。

    示例

    {
      "width": 20,
      "type": "TABLE_LAYOUT_TYPE_FIXED"
    }

    字段说明

    字段类型说明
    widthdouble表格宽度,单位是像素(px)
    typestring表格宽度类型,详见TableWidthType

    TableHorizontalAlignmentType

    表格的水平对齐的方式

    示例

    {
    	"horizontal_alignment_type": "TABLE_HORIZONTAL_ALIGNMENT_TYPE_CENTER"
    }

    字段说明

    枚举值描述
    TABLE_HORIZONTAL_ALIGNMENT_TYPE_UNSPECIFIED未知
    TABLE_HORIZONTAL_ALIGNMENT_TYPE_CENTER指定当前表格位于一行的中间位置
    TABLE_HORIZONTAL_ALIGNMENT_TYPE_LEFT与文字边缘的左侧对齐
    TABLE_HORIZONTAL_ALIGNMENT_TYPE_START与文字边缘的右侧对齐

    TableLayoutType

    表格布局类型枚举

    示例

    {
    	"table_layout": "TABLE_LAYOUT_TYPE_FIXED"
    }

    字段说明

    枚举值描述
    TABLE_LAYOUT_TYPE_UNSPECIFIED未知
    TABLE_LAYOUT_TYPE_FIXED固定宽度
    TABLE_LAYOUT_TYPE_AUTO_FIT自适应布局

    TableWidthType

    表格宽度类型

    示例

    {
    	"type": "TABLE_LAYOUT_TYPE_FIXED"
    }

    字段说明

    枚举值描述 
    TABLE_LAYOUT_TYPE_UNSPECIFIED0未知
    TABLE_LAYOUT_TYPE_FIXED1固定宽度
    TABLE_LAYOUT_TYPE_AUTO_FIT2自适应布局

    TableRowProperty

    表格行属性

    示例

    {
      "is_header": false
    }

    字段说明

    字段类型说明
    is_headerbool本行是否是表头

    TableCellProperty

    表格单元属性

    示例

    {
      "table_cell_borders": {...},
      "vertical_alignment": "VERTICAL_ALIGNMENT_TOP"
    }

    字段说明

    字段类型说明
    table_cell_bordersobject(Borders)边界属性
    vertical_alignmentstring垂直方向对齐属性,详见VerticalAlignment

    Borders

    表格单元的边界属性

    示例

    {
      "top": {...},
      "left": {...},
      "bottom": {...},
      "right": {...}
    }

    字段说明

    字段类型说明
    topobject(BorderProperty)上边界
    leftobject(BorderProperty)左边界
    bottomobject(BorderProperty)底部边界
    rightobject(BorderProperty)右边界

    BorderProperty

    边界属性

    示例

    {
      "color" : "000000",
      "width" : 3
    }

    字段说明

    字段类型说明
    colorstring边界颜色,颜色使用十六进制RRGGBB格式
    widthuint32边界的宽度,单位是像素(px)

    VerticalAlignment

    垂直方向对齐属性

    示例

    {
      "vertical_alignment": "VERTICAL_ALIGNMENT_TOP"
    }

    字段说明

    枚举值描述
    VERTICAL_ALIGNMENT__UNSPECIFIED未知
    VERTICAL_ALIGNMENT_TOP对齐顶部
    VERTICAL_ALIGNMENT_CENTER居中对齐
    VERTICAL_ALIGNMENT_BOTH自适应对齐
    VERTICAL_ALIGNMENT_BOTTOM对齐底部

    DrawingProperty

    示例

    {
      "inline_keyword": {...},
      "anchor": {...},
      "is_placeholder": false
    }

    字段说明

    字段类型说明
    inline_keywordobject(Inline)Drawing 类型中的实体,如一张图片
    anchorobject(Anchor)Drawing 类型中的悬浮实体,如一张图片
    is_placeholderbool此处是否为占位符

     

    Inline

    Drawing 类型中的实体,如一张图片

    示例

    {
      "picture": {...},
      "addon": {...}
    }

    字段说明

    字段类型说明
    pictureobject(InlinePicture)图片内容
    addonobject(InlineAddon)插件信息

    InlinePicture

    示例

    {
      "uri": "https://xxxxxxx",
      "relative_rect": {...},
      "shape": {...}
    }

    字段说明

    字段类型说明
    relative_rectobject(RelativeRect)裁剪范围
    shapeobject(ShapeProperties)形状属性

    RelativeRect

    示例

    {
      "left": 75000,
      "top": 75000,
      "right": 75000,
      "bottom": 75000
    }

    字段说明

    字段类型说明
    leftuint32距左侧的距离,单位系数是 0.1%(例如:75000 代表 75%)
    topuint32距顶部的距离,单位系数是 0.1%(例如:75000 代表 75%)
    rightuint32距右侧的距离,单位系数是 0.1%(例如:75000 代表 75%)
    bottomuint32距底部的距离,单位系数是 0.1%(例如:75000 代表 75%

    ShapeProperties

    示例

    {
      "transform": {...}
    }

    字段说明

    字段类型说明
    transformobject(Transform2D)图片变换,图片在文本中的裁剪和旋转信息

    Transform2D

    示例

    {
      "extent":{
        "cx": 100,
        "cy": 100
      },
      "rotation": 600000
    }

    字段说明

    字段类型说明
    extentobject(PositiveSize2D)边框,单位是像素(px)
    rotationint32旋转角度,单位 1/60000 度。正数代表顺时针旋转,负数代表逆时针旋转

    PositiveSize2D

    示例

    {
      "cx": 100,
      "cy": 100
    }

    字段说明

    字段类型说明
    cxinteger图片宽,单位是像素(px)
    cyinteger图片高,单位是像素(px)

     

    InlineAddon

    示例

    {
      "addon_id": "ADDON_ID",
      "addon_source": "ADDON_SOURCE_TYPE_NONE"
    }

    字段说明

    字段类型说明
    addon_idstring插件 ID
    addon_sourcestring插件来源,详见AddonSourceType

    AddonSourceType

    示例

    {
      "addon_source": "ADDON_SOURCE_TYPE_NONE"
    }

    字段说明

    枚举值描述 
    ADDON_SOURCE_TYPE_UNSPECIFIED0未知
    ADDON_SOURCE_TYPE_NONE1
    ADDON_SOURCE_TYPE_LATEX2公式
    ADDON_SOURCE_TYPE_SIGN3签名
    ADDON_SOURCE_TYPE_SIGN_BAR4签名占位图

     

    Anchor

    Drawing 类型中浮动的实体,如一张图片

    示例

    {
      "picture": {...},
    }

    字段说明

    字段类型说明
    pictureobject(AnchorPicture)图片内容

    AnchorPicture

    示例

    {
      "uri": "https://xxxxx",
      "relative_rect": {...},
      "shape": {...},
      "position_horizontal": {...},
      "position_vertical": {...},
      "wrap_none": false,
      "wrap_square": false,
      "wrap_top_and_bottom": false,
      "behind_doc": false, 
      "allow_overlap": false
    }

    字段说明

    字段类型说明
    relative_rectobject(RelativeRect)裁剪范围
    shapeobject(ShapeProperties)形状属性
    position_horizontalobject(PositionHorizontal)水平位置
    position_verticalobject(PositionVertical)竖直位置
    wrap_nonebool非文字包围
    wrap_squareobject(WrapSquare)四周型环绕
    wrap_top_and_bottombool上下型环绕
    behind_docbool衬于文字下方
    allow_overlapbool允许重叠

    PositionHorizontal

    示例

    {
      "pos_offset": 10,
      "relative_from": "RELATIVE_FROM_HORIZONTAL_MARGIN"
    }

    字段说明

    字段类型说明
    pos_offsetint32位置偏移
    relative_fromstring相对位置类型,详见RelativeFromHorizontal

    RelativeFromHorizontal

    示例

    {
      "relative_from": "RELATIVE_FROM_HORIZONTAL_MARGIN"
    }

    字段说明

    枚举值描述
    RELATIVE_FROM_HORIZONTAL_UNSPECIFIED未知
    RELATIVE_FROM_HORIZONTAL_MARGIN边缘
    RELATIVE_FROM_HORIZONTAL_PAGE
    RELATIVE_FROM_HORIZONTAL_COLUMN
    RELATIVE_FROM_HORIZONTAL_CHARACTER字符
    RELATIVE_FROM_HORIZONTAL_LEFT_MARGIN左边缘
    RELATIVE_FROM_HORIZONTAL_RIGHT_MARGIN右边缘
    RELATIVE_FROM_HORIZONTAL_INSIDE_MARGIN内部边缘
    RELATIVE_FROM_HORIZONTAL_OUTSIDE_MARGIN外部边缘

     

    PositionVertical

    示例

    {
      "pos_offset": 10,
      "relative_from": "RELATIVE_FROM_VERTICAL_MARGIN"
    }

    字段说明

    字段类型说明
    pos_offsetint32位置偏移
    relative_fromstring相对位置类型,详见RelativeFromVertical

    RelativeFromVertical

    示例

    {
      "relative_from": "RELATIVE_FROM_VERTICAL_MARGIN"
    }

    字段说明

    枚举值描述
    RELATIVE_FROM_VERTICAL_UNSPECIFIED未知
    RELATIVE_FROM_VERTICAL_MARGIN边缘
    RELATIVE_FROM_VERTICAL_PAGE
    RELATIVE_FROM_VERTICAL_PARAGRAPH
    RELATIVE_FROM_VERTICAL_LINE线
    RELATIVE_FROM_VERTICAL_TOP_MARGIN顶端边缘
    RELATIVE_FROM_VERTICAL_BOTTOM_MARGIN底部边缘
    RELATIVE_FROM_VERTICAL_INSIDE_MARGIN内部边缘
    RELATIVE_FROM_VERTICAL_OUTSIDE_MARGIN外部边缘

    WrapSquare

    示例

    {
      "wrap_text": "WRAP_TEXT_BOTH_SIDES"
    }
      
    wrap_textstring四周环绕文字类型,详见WrapText

    WrapText

    示例

    {
      "wrap_text": "WRAP_TEXT_BOTH_SIDES"
    }

    字段说明

    枚举值描述
    WRAP_TEXT_BOTH_UNSPECIFIED未知
    WRAP_TEXT_BOTH_SIDES两边
    WRAP_TEXT_LEFT左边
    WRAP_TEXT_RIGHT右边
    WRAP_TEXT_LARGEST最大
    上一篇更新记录
    下一篇获取表格行列信息
      本节内容
    服务端API
    基础
    数据与智能专区
    应用接收专区通知
    连接微信
    客户联系
    办公
    客户端API
    小程序
    基础
    连接微信
    办公
    WECOM-JSSDK
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们