登录
基础
连接微信
办公目录
用于向指定页面中批量添加内容块。
请求方式：POST（HTTPS）
请求地址：https://qyapi.weixin.qq.com/cgi-bin/wedoc/smartdoc/add_blocks?access_token=ACCESS_TOKEN
请求包体
{
"docid": "DOC_ID",
"page_id": "PAGE_ID",
"blocks": [
{
"type": "BLOCK_TYPE_TEXT",
"title": "Hello World",
"parent_id": "PARENT_BLOCK_ID",
"after_id": "AFTER_BLOCK_ID",
"props": {}
}
]
}参数说明
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| docid | string | 是 | 智能文档的文档 id，可通过 新建文档 接口创建 |
| page_id | string | 是 | 页面的id |
| blocks | object[](BlockInfo) | 是 | 需要添加的 Block 列表 |
| blocks[].type | string | 是 | Block 类型，参见 BlockType |
| blocks[].title | string | 否 | Block 的文本内容 |
| blocks[].parent_id | string | 否 | 父节点 Block ID |
| blocks[].after_id | string | 否 | 插入位置，表示排在哪个 Block 之后，为空表示插入到最前 |
| blocks[].children | string[] | 否 | 子节点 ID 列表 |
| blocks[].props | object | 否 | Block 属性 |
权限说明
返回示例
{
"errcode": 0,
"errmsg": "ok",
"blocks": [
{
"id": "BLOCK_ID",
"type": "BLOCK_TYPE_TEXT",
"title": "Hello World",
"parent_id": "PARENT_BLOCK_ID",
"after_id": "AFTER_BLOCK_ID",
"children": [],
"props": {}
}
]
}
返回参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 错误码 |
| errmsg | string | 错误码说明 |
| blocks | object[](BlockInfo) | 添加成功后返回的 Block 列表（含生成的 ID） |
| 参数 | 类型 | 说明 |
|---|---|---|
| id | string | Block的唯一标识ID |
| type | string | Block类型，参见 BlockType |
| title | string | Block内容 |
| parent_id | string | 父节点ID |
| after_id | string | 后一个兄弟节点ID，为空表示插入到最前 |
| children | string[] | 子节点ID列表 |
| props | object(BlockProps) | Block属性 |
| 枚举值 | 名称 | 对应的 BlockProps 类型 |
|---|---|---|
| BLOCK_TYPE_TEXT | 文本 | TextBlockProps |
| BLOCK_TYPE_IMAGE | 图片 | ImageBlockProps |
| BLOCK_TYPE_TODO | 待办 | TodoBlockProps |
| BLOCK_TYPE_NUMBERED_LIST | 有序列表 | - |
| BLOCK_TYPE_BULLETED_LIST | 无序列表 | - |
| BLOCK_TYPE_DIVIDER | 分割线 | - |
| BLOCK_TYPE_LINK | 链接 | LinkBlockProps |
| BLOCK_TYPE_COLUMN_LIST | 分栏 | ColumnListProps |
| BLOCK_TYPE_HEADER_1 | 一级标题 | - |
| BLOCK_TYPE_HEADER_2 | 二级标题 | - |
| BLOCK_TYPE_HEADER_3 | 三级标题 | - |
| BLOCK_TYPE_HEADER_4 | 四级标题 | - |
| BLOCK_TYPE_HEADER_5 | 五级标题 | - |
| BLOCK_TYPE_HEADER_6 | 六级标题 | - |
| BLOCK_TYPE_HIGHLIGHT | 背景块 | HighlightBlockProps |
| BLOCK_TYPE_FILE | 文件 | FileBlockProps |
| BLOCK_TYPE_VIEW | 视图 | SmartSheetViewBlockProps |
| BLOCK_TYPE_TABLE | 表格 | TableBlockProps |
| BLOCK_TYPE_CODE | 代码块 | CodeBlockProps |
| BLOCK_TYPE_QUOTE | 引用块 | - |
| 字段 | 类型 |
|---|---|
| text_props | object(TextBlockProps) |
| image_props | object(ImageBlockProps) |
| file_props | object(FileBlockProps) |
| link_props | object(LinkBlockProps) |
| table_props | object(TableBlockProps) |
| view_props | object(SmartSheetViewBlockProps) |
| column_props | object(ColumnListProps) |
| highlight_props | object(HighlightBlockProps) |
| code_props | object(CodeBlockProps) |
| todo_props | object(TodoBlockProps) |
| 字段 | 类型 | 说明 |
|---|---|---|
| align | uint32 | 块级对齐，参见 TextAlign |
| text_align | uint32 | 文本对齐，参见 TextAlign |
| block_color | string | 文本背景色，参见 BlockColor |
| 字段 | 类型 | 说明 |
|---|---|---|
| url | string | 图片地址 |
| width | double | 缩放后宽度 |
| height | double | 缩放后高度 |
| stroke | bool | 是否有图片描边 |
| 字段 | 类型 | 说明 |
|---|---|---|
| file_id | string | 微盘文件ID |
| 字段 | 类型 | 说明 |
|---|---|---|
| link_url | string | 链接地址 |
| link_name | string | 链接名称 |
| link_description | string | 链接描述 |
| 字段 | 类型 | 说明 |
|---|---|---|
| cell_positions | object[](TableCellMerge) | 单元格合并信息 |
| enable_row_header | bool | 是否有行标题 |
| enable_column_header | bool | 是否有列标题 |
| 字段 | 类型 | 说明 |
|---|---|---|
| doc_id | string | 数据表 docid |
| table_id | string | 数据表 id |
| view_id | string | 视图 id |
| table_block_id | string | 数据表的 blockid |
| enable_table_title | bool | 视图标题显示 |
| enable_add_row | bool | 显示添加记录按钮 |
| 字段 | 类型 | 说明 |
|---|---|---|
| column_num | uint32 | 分栏数量，取值范围 [2, 4]，越界自动 clamp 到边界，缺省/0 取最小值 2 |
| 字段 | 类型 | 说明 |
|---|---|---|
| background_image_url | string | 背景图链接 |
| extend_background | bool | 是否扩展背景（背景图是否撑满整个块区域） |
| block_color | string | 块背景色，参见 BlockColor |
| border_color | string | 边框颜色，参见 BorderColor |
| 字段 | 类型 | 说明 |
|---|---|---|
| code_language | object(CodeLanguage) | 代码语言 |
| code_wrap | bool | 是否自动换行 |
| 字段 | 类型 | 说明 |
|---|---|---|
| checked | bool | 是否选中（待办事项是否已完成） |
| 枚举值 | 说明 |
|---|---|
| TEXT_ALIGN_UNSPECIFIED | 未指定 |
| TEXT_ALIGN_LEFT | 左对齐 |
| TEXT_ALIGN_CENTER | 居中对齐 |
| TEXT_ALIGN_RIGHT | 右对齐 |
| TEXT_ALIGN_JUSTIFY | 两端对齐 |
| 枚举值 | 说明 |
|---|---|
| CODE_LANGUAGE_UNSPECIFIED | 未指定 |
| CODE_LANGUAGE_PLAIN_TEXT | Plain Text |
| CODE_LANGUAGE_ABAP | ABAP |
| CODE_LANGUAGE_ACTIONSCRIPT | ActionScript |
| CODE_LANGUAGE_ADA | Ada |
| CODE_LANGUAGE_APACHE | Apache |
| CODE_LANGUAGE_APEX | Apex |
| CODE_LANGUAGE_BASH | Bash |
| CODE_LANGUAGE_C | C |
| CODE_LANGUAGE_CPP | C++ |
| CODE_LANGUAGE_CSHARP | C# |
| CODE_LANGUAGE_CLOJURE | Clojure |
| CODE_LANGUAGE_CMAKE | CMake |
| CODE_LANGUAGE_COFFEESCRIPT | CoffeeScript |
| CODE_LANGUAGE_CRYSTAL | Crystal |
| CODE_LANGUAGE_CSS | CSS |
| CODE_LANGUAGE_D | D |
| CODE_LANGUAGE_DART | Dart |
| CODE_LANGUAGE_DIFF | Diff |
| CODE_LANGUAGE_DJANGO | Django |
| CODE_LANGUAGE_DOCKER | Dockerfile |
| CODE_LANGUAGE_ERLANG | Erlang |
| CODE_LANGUAGE_ELIXIR | Elixir |
| CODE_LANGUAGE_FORTRAN | Fortran |
| CODE_LANGUAGE_FSHARP | F# |
| CODE_LANGUAGE_GIT | Git |
| CODE_LANGUAGE_GO | Go |
| CODE_LANGUAGE_GRAPHQL | GraphQL |
| CODE_LANGUAGE_GROOVY | Groovy |
| CODE_LANGUAGE_HAXE | Haxe |
| CODE_LANGUAGE_HTML | HTML |
| CODE_LANGUAGE_HTTP | HTTP |
| CODE_LANGUAGE_HASKELL | Haskell |
| CODE_LANGUAGE_JAVA | Java |
| CODE_LANGUAGE_JAVASCRIPT | JavaScript |
| CODE_LANGUAGE_JSON | JSON |
| CODE_LANGUAGE_JSX | JSX |
| CODE_LANGUAGE_JULIA | Julia |
| CODE_LANGUAGE_KOTLIN | Kotlin |
| CODE_LANGUAGE_LATEX | LaTeX |
| CODE_LANGUAGE_LESS | Less |
| CODE_LANGUAGE_LISP | Lisp |
| CODE_LANGUAGE_LUA | Lua |
| CODE_LANGUAGE_MAKEFILE | Makefile |
| CODE_LANGUAGE_MATLAB | MATLAB |
| CODE_LANGUAGE_MARKDOWN | Markdown |
| CODE_LANGUAGE_MARKUP | Markup |
| CODE_LANGUAGE_MARKUP_TEMPLATING | Markup templating |
| CODE_LANGUAGE_MATHML | MathML |
| CODE_LANGUAGE_NASM | NASM |
| CODE_LANGUAGE_NGINX | Nginx |
| CODE_LANGUAGE_OBJECTIVE_C | Objective-C |
| CODE_LANGUAGE_OCAML | OCaml |
| CODE_LANGUAGE_PASCAL | Pascal |
| CODE_LANGUAGE_PERL | Perl |
| CODE_LANGUAGE_PHP | PHP |
| CODE_LANGUAGE_POWERSHELL | PowerShell |
| CODE_LANGUAGE_PROTOBUF | ProtoBuf |
| CODE_LANGUAGE_PYTHON | Python |
| CODE_LANGUAGE_PROLOG | Prolog |
| CODE_LANGUAGE_PLSQL | PL/SQL |
| CODE_LANGUAGE_R | R |
| CODE_LANGUAGE_REGEX | Regex |
| CODE_LANGUAGE_RUBY | Ruby |
| CODE_LANGUAGE_RUST | Rust |
| CODE_LANGUAGE_SCALA | Scala |
| CODE_LANGUAGE_SCHEME | Scheme |
| CODE_LANGUAGE_SHELL | Shell |
| CODE_LANGUAGE_SWIFT | Swift |
| CODE_LANGUAGE_SVG | SVG |
| CODE_LANGUAGE_SAS | SAS |
| CODE_LANGUAGE_SASS | SASS |
| CODE_LANGUAGE_SCSS | SCSS |
| CODE_LANGUAGE_SQL | SQL |
| CODE_LANGUAGE_TCL | Tcl |
| CODE_LANGUAGE_TYPESCRIPT | TypeScript |
| CODE_LANGUAGE_VALA | Vala |
| CODE_LANGUAGE_VBNET | VB.NET |
| CODE_LANGUAGE_VELOCITY | Velocity |
| CODE_LANGUAGE_VERILOG | Verilog |
| CODE_LANGUAGE_VHDL | VHDL |
| CODE_LANGUAGE_VISUAL_BASIC | Visual Basic |
| CODE_LANGUAGE_VUE | VUE |
| CODE_LANGUAGE_WASM | WebAssembly |
| CODE_LANGUAGE_XML | XML |
| CODE_LANGUAGE_YAML | YAML |
| 字段 | 类型 | 说明 |
|---|---|---|
| start_cell | object(TableCellPosition) | 合并起始单元格 |
| end_cell | object(TableCellPosition) | 合并结束单元格 |
| 字段 | 类型 | 说明 |
|---|---|---|
| row | uint32 | 行坐标 |
| column | uint32 | 列坐标 |
| 枚举值 | 说明 |
|---|---|
| default_background | 默认 |
| light_grey_background | 浅灰 |
| grey_background | 灰色 |
| dark_background | 深色 |
| light_red_background | 浅红 |
| red_background | 红色 |
| light_orange_background | 浅橙 |
| orange_background | 橙色 |
| light_yellow_background | 浅黄 |
| yellow_background | 黄色 |
| light_green_background | 浅绿 |
| green_background | 绿色 |
| light_cyan_background | 浅青 |
| cyan_background | 青色 |
| light_blue_background | 浅蓝 |
| blue_background | 蓝色 |
| light_accent_blue_background | 浅亮蓝 |
| accent_blue_background | 亮蓝 |
| light_purple_background | 浅紫 |
| purple_background | 紫色 |
| 枚举值 | 说明 |
|---|---|
| default | 默认 |
| grey | 灰色 |
| blue | 蓝色 |
| sky_blue | 天蓝 |
| green | 绿色 |
| yellow | 黄色 |
| orange | 橙色 |
| red | 红色 |
| rose_red | 玫红 |
| purple | 紫色 |
基础连接微信办公基础连接微信办公基础连接微信办公