目录
可以通过工作表 Webhook 地址向智能表格的工作表添加一行或多行新记录。单表最多允许有100000行记录,15000000个单元格。
注意
暂不支持通过Webhook给公式、自动编号、查找引用、关联、创建人、创建时间、最后编辑人、最后编辑时间、群聊、文件字段添加记录。
请求方式:POST(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/wedoc/smartsheet/webhook?key=KEY
开启「接收外部数据」获取到的工作表Webhook地址即为请求地址,启用入口详见配置说明
请求包体写法请参考对应工作表提供的「示例数据」,示例数据位置详见配置说明
请求包体:
{
"add_records": [{
"values": {
"FIELD_ID": [{
"type": "text",
"text": "文本内容"
}]
}
}]
}
参数说明
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| add_records | Object[](AddRecord) | 是 | 需要添加的记录的具体内容组成的 JSON 数组 |
返回示例
{
"errcode": 0,
"errmsg": "ok",
"add_records": [
]
}
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 错误码 |
| errmsg | string | 错误码说明 |
| add_records | Object[](CommonRecord) | 由添加成功的记录的具体内容组成的 JSON 数组 |
添加记录:
| 参数名 | 类型 | 描述 |
|---|---|---|
| values | Object | 记录的具体内容,key 为字段标题或字段 ID ,value 详见(Value) |
在智能表格的某个工作表中添加记录响应、更新记录请求和更新记录响应的通用参数:
| 参数名 | 类型 | 描述 |
|---|---|---|
| record_id | string | 记录 ID |
| values | Object | 记录的具体内容,key 为字段标题或字段 ID ,value 详见(Value) |
各种类型的字段对应的单元格的值
| 字段类型 | 单元格值类型 | 描述 |
|---|---|---|
| 文本(FIELD_TYPE_TEXT) | string | Object[](CellTextValue) | 文本单元格内容。 简单模式:传入字符串,如 "Hello"完整模式:传入对象数组,如 [{"type":"text","text":"Hello"}]请求时支持两种模式写入,返回时默认为完整模式 |
| 数字(FIELD_TYPE_NUMBER) | double | |
| 复选框(FIELD_TYPE_CHECKBOX) | bool | |
| 日期(FIELD_TYPE_DATE_TIME) | string(以毫秒为单位的unix时间戳) | |
| 图片(FIELD_TYPE_IMAGE) | Object[](CellImageValue) | |
| 成员(FIELD_TYPE_USER) | string[] | Object[](CellUserValue) | 成员单元格内容。 姓名(别名)模式:传入字符串数组,支持输入企微人员姓名(别名)添加,如 ["张三","lisi","王五(wangwu)"]。当前仅支持添加本企业内成员,在管理端可查询、设置当前企业成员的姓名(别名)userid 模式:传入对象数组,如 [{"user_id":"USERID"}]请求时支持两种模式写入, 返回时也是对应的模式 |
| 链接(FIELD_TYPE_URL) | Object[](CellUrlValue) | 数组类型为预留能力,目前只支持展示一个链接,建议只传入一个链接 |
| 多选(FIELD_TYPE_SELECT) | Object[](Option) | |
| 进度(FIELD_TYPE_PROGRESS) | double | |
| 电话(FIELD_TYPE_PHONE_NUMBER) | string | |
| 邮箱(FIELD_TYPE_EMAIL) | string | |
| 单选(FIELD_TYPE_SINGLE_SELECT) | Object[](Option) | |
| 地理位置(FIELD_TYPE_LOCATION) | Object[](CellLocationValue) | 长度不大于1的数组。 |
| 货币(FIELD_TYPE_CURRENCY) | double | |
| 百分数(FIELD_TYPE_PERCENTAGE) | double | |
| 条码(FIELD_TYPE_BARCODE) | string |
文本类型字段的单元值类型
| 参数名 | 类型 | 描述 |
|---|---|---|
| type | string | 内容为文本(值为text)、内容为链接(值为url) |
| text | string | 单元格内容 |
| link | string | 当type时url时,表示链接跳转url |
| 参数名 | 类型 | 描述 |
|---|---|---|
| title | string | 图片标题 |
| image_base64 | string | 图片内容的base64编码 |
| 参数名 | 类型 | 描述 |
|---|---|---|
| user_id | string | 成员ID |
开发者可通过「获取成员ID列表」接口获取成员 userid。
数组类型为预留能力,目前只支持展示一个链接,建议只传入一个链接
示例
{
"link": "https://developer.work.weixin.qq.com/document/path/97392",
"text": "企业微信开发者中心"
}
| 参数名 | 类型 | 描述 |
|---|---|---|
| text | string | 链接显示文本 |
| link | string | 链接跳转url |
示例
{
"text": "1"
}
| 参数名 | 类型 | 描述 |
|---|---|---|
| style | int(Style) | 选项颜色。新增选项时填写 |
| text | string | 要填写的选项内容。新增选项时填写,已经存在时优先匹配已经存在的选项,否则会新增选项 |
示例
{
"id": "14313005936863363130",
"latitude": "23.10647",
"longitude": "113.32446",
"source_type": 1,
"title": "广州塔"
}
| 参数名 | 类型 | 描述 |
|---|---|---|
| source_type | uint32 | 填1,表示来源为腾讯地图。目前只支持腾讯地图来源 |
| id | string | 地点ID |
| latitude | string | 纬度 |
| longitude | string | 经度 |
| title | string | 地点名称 |
