写入图片

向电子表格某个工作表的单个指定单元格写入图片，支持传入图片的二进制流，支持多种图片格式。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/:spreadsheetToken/values_image
HTTP Method	POST
接口频率限制	100 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	drive:drive 查看、评论、编辑和管理云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格

请求头

名称	类型	必填	描述
Authorization	string	是	通过访问凭证（access_token）对调用者身份进行鉴权。可选值： - tenant_access_token： 租户授权凭证。应用代表租户（即企业或团队）执行对应操作。示例值："Bearer t-7f1bcd13fc57d46bac21793aabcef" - user_access_token：用户授权凭证。应用代表用户执行对应操作。示例值："Bearer u-7f1bcd13fc57d46bac21793aabcef" 了解更多，参考获取访问凭证。
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	必填	描述
spreadsheetToken	string	是	电子表格的 token。可通过以下两种方式获取。了解更多，参考电子表格概述。 - 电子表格的 URL：https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== - 调用获取文件夹中的文件清单 示例值："Iow7sNNEphp3WbtnbCscPqabcef"

请求体

名称	类型	必填	描述
range	string	是	指定写入图片的单元格。格式为``。其中： - sheetId 为工作表 ID，通过获取工作表 获取 - <开始单元格>:<结束单元格> 用于指定单元格，开始单元格与结束单元格需保持一致，如：A1:A1。其中，数字表示行索引，字母表示列索引。如 A1:A1 表示该工作表第 1 行 A 列的单元格。了解更多，参考电子表格概述
image	array<byte>	是	需要写入的图片的二进制流，支持 "PNG"、"JPEG"、"JPG"、"GIF"、"BMP"、"JFIF"、"EXIF"、 "TIFF"、"BPG"、"HEIC" 等图片格式。
name	string	是	写入的图片名称。 注意：该参数需加后缀名，如 test.png。支持的后缀名有："PNG"、"JPEG"、"JPG"、"GIF"、"BMP"、"JFIF"、"EXIF"、 "TIFF"、"BPG"、"HEIC"。不区分大小写。

请求体示例

{ 
    "range": "Q7PlXT!H7:H7", 
    "image": [137,80,78,71,13,10,26,10,0,0,0,13,73,72,68,82,0,0,0,2,0,0,0,1,1,0,0,0,0,220,89,66,39,0,0,0,2,116,82,78,83,0,0,118,147,205,56,0,0,0,10,73,68,65,84,8,215,99,104,0,0,0,130,0,129,221,67,106,244,0,0,0,0,73,69,78,68,174,66,96,130],
    "name": "test.png"
}

cURL 请求示例

curl --location --request POST 'https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/shtcngNygNfuqhxTBf588jabcef/values_image' \
--header 'Authorization: Bearer t-e346617a4acfc3a11d4ed24dca0d0c0fc8e0067e' \
--header 'Content-Type: application/json' \
--data-raw '{ 
    "range": "Q7PlXT!H7:H7",
    "image": [137,80,78,71,13,10,26,10,0,0,0,13,73,72,68,82,0,0,0,2,0,0,0,1,1,0,0,0,0,220,89,66,39,0,0,0,2,116,82,78,83,0,0,118,147,205,56,0,0,0,10,73,68,65,84,8,215,99,104,0,0,0,130,0,129,221,67,106,244,0,0,0,0,73,69,78,68,174,66,96,130],
    "name": "test.png"
}'

使用 Python 获取图片二进制流示例

def uploadImage():
    with open("./07.png", "rb") as f:
        url = "https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/X5assEfmnhepJtthAr4bY9Dlcxb/values_image"
        fb = f.read()
        misssing_padding = 4 - len(fb) % 4
        if misssing_padding:
            fb += b'=' * misssing_padding
        fb = base64.b64encode(fb).decode('utf-8')
        data = {
            "range": "CKu2Rq!A3:A3",
            "image": fb,
            "name": "a.png",
        }
        rsp = requests.post(url, data=json.dumps(data), headers={"Authorization": "Bearer 1nDxwUe_x5aGdZTDrefV5Xwk2hTt10BzMq20kk000Axr",
                                                                 "Content-Type": "application/json"})
        print(rsp.json())

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ spreadsheetToken	string	电子表格的 token
└ updatedRange	string	写入图片的范围
└ revision	int	工作表的版本号。从 0 开始计数，更新一次版本号加一。

响应体示例

{
    "code": 0,
    "data": {
        "revision": 80,
        "spreadsheetToken": "shtcngNygNfuqhxTBf588jabcef",
        "updateRange": "Q7PlXT!H7:H7"
    },
    "msg": "success"
}

错误码

具体可参考：服务端错误码说明