登录
基础
连接微信
办公目录
该接口可以对一个在线文档批量执行多个更新操作。
注意：
请求方式：POST（HTTPS）
请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/document/batch_update?access_token=ACCESS_TOKEN
请求包体
{
"docid": "DOCID",
"verison": 10,
"requests": [
{
"insert_text": {
"text": "text content",
"location": {
"index": 10
}
}
},
{
"insert_table": {
"rows": 2,
"cols": 2,
"location": {
"index": 10
}
}
}
]
}参数说明
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| docid | string | 是 | 文档的docid |
| version | uint32 | 否 | 操作的文档版本, 该参数可以通过获取文档内容接口获得。操作后文档版本将更新一版。要更新的文档版本与最新文档版本相差不能超过100个。 |
| requests | object[] | 是 | 更新操作列表，详见 UpdateRequest |
权限说明
返回示例
{
"errcode": 0,
"errmsg": "ok"
}参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 错误码 |
| errmsg | string | 错误码说明 |
由于请求参数比较复杂，在本节分Object分别说明
更新文档的操作，每个UpdateRequest的Object中能同时填一个字段，填入多个的只会有一个生效
示例
{
"replace_text": {
},
"delete_content": {
}
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| replace_text | object(ReplaceText) | 替换指定位置文本内容 |
| insert_text | object(InsertText) | 在指定位置插入文本内容 |
| delete_content | object(DeleteContent) | 删除指定位置内容 |
| insert_image | object(InsertImage | 在指定位置插入图片 |
| insert_page_break | object(InsertPageBreak) | 在指定位置插入分页符 |
| insert_table | object(InsertTable) | 在指定位置插入表格 |
| insert_paragraph | object(InsertParagraph) | 在指定位置插入段落 |
| update_text_property | object(UpdateTextProperty) | 更新指定位置文本属性 |
表示从start_index开始的一段范围
示例
{
"start_index": 10,
"length": 5
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| start_index | uint32 | 起始位置，从0开始 |
| length | uint32 | 长度 |
标准文档中的一个位置
示例
{
"index": 10
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| index | uint32 | 位置 |
示例
{
"text": "hello world",
"ranges": [
{
"start_index": 10,
"length": 5
}
]
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| text | string | 要替换的文本 |
| ranges | object[](Range) | 要替换的文档范围，可同时替换多个位置的文本, rangs个数不超过10。 |
插入文本
示例
{
"text": "hello world",
"location": {
"index": 10
}
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| text | string | 要插入的文本 |
| location | object(Location) | 插入的位置 |
删除指定位置内容
示例
{
"range": {
"start_index": 10,
"length": 5
}
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| range | object(Range) | 要删除的范围 |
插入图片
示例
{
"image_id": "https://https://wework.qpic.cn/wwpic/xxxxxx",
"location": {
"index": 10
}
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| image_id | string | 图片url，通过上传图片接口获得 |
| location | object(Location) | 插入的位置 |
| width | uint32 | 图片的宽，单位是像素（px）， 不传默认为图片原始宽度 |
| height | uint32 | 图片的高， 单位是像素（px），不传默认为图片原始高度 |
插入分页符
示例
{
"location": {
"index": 10
}
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| location | object(Location) | 插入的位置 |
在指定位置插入表格，表格大小限制：
<=100<=60<=1000示例
{
"rows": 3,
"cols": 3,
"location": {
"index": 10
}
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| rows | uint32 | 表格行数 |
| cols | uint32 | 表格列数 |
| location | object(Location) | 插入的位置 |
在指定位置插入段落
示例
{
"location": {
"index": 10
}
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| location | object(Location) | 插入的位置 |
文本属性
示例
{
"bold": true,
"color": "000000",
"background_color": "0000FF"
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| blod | bool | 是否加粗 |
| color | string | 文字颜色，十六进制RRGGBB格式 |
| background_color | string | 文字的背景颜色，十六进制RRGGBB 格式 |
更新指定范围的文本属性
示例
{
"text_property": {
},
"ranges": [
]
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| text_property | object(TextProperty) | 文本属性 |
| ranges | object[](Range) | 更新文本属性的范围，ranges个数不超过10 |
基础连接微信办公基础连接微信办公基础连接微信办公