纷享销客开发者手册

简体中文

English

Fx.file

约 4956 字大约 17 分钟

2026-01-09

目录

摘要

本文档的概要说明如下： 本文档介绍 Fx.file 的API定义、使用方式及相关说明。

1. uploadFile 文件上传

Fx.file.uploadFile(<String extensionName>, <Integer fileSize>, <byte[] fileBytes>, <Integer userId>)

参数说明

入参格式

参数名称object描述是否必填
extensionNameString拓展名是
fileSizeInteger文件大小是
fileBytesbyte[]文件内容byte数组是
userIdInteger用户名--

出参格式

参数名称APIResult描述
isErrorBoolean是否错误
dataMap
messageString信息
dataMap描述
extensionNameString拓展名
pathStringNPath
sizeInteger文件大小

出参样例


{
    "isError": false,
    "data": {
        "extensionName": ".xlsx",
        "path": "N_202411_11_f20d33d4520e49738be560448001b451",
        "size": 25
    },
    "message": ""
}

Groovy 举例


def text = "aaa" as String
def byteData = Strings.toUTF8Bytes(text)
def ret = Fx.file.uploadFile(".txt", byteData.size(), byteData, 1000)
def data = ret.data
log.info(data)
log.info(data['path'])
log.info(data['size'])
log.info(data['extensionName'])

注意事项

  • 该API对结果处理时，要使用def来接收，且不能as Map

2. uploadFileByStream 把外部API的文件上传

Fx.file.uploadFileByStream(<Request request>)

参数说明

入参格式

参数名称类型描述是否必填
requestRequest请求体是

出参格式

参数名称APIResult描述
isErrorBoolean是否错误
dataMap
messageString信息
dataMap描述
extensionNameString拓展名
fileNameString文件名
pathStringNPath
sizeInteger文件大小

出参样例


{
    "isError": false,
    "data": {
        "extensionName": ".xlsx",
        "fileName": "123tom.xlsx",
        "path": "N_202411_11_f20d33d4520e49738be560448001b451",
        "size": 25
    },
    "message": ""
}

Groovy 举例


Map map = ["id": "123", "name": "tom"]
StringBody body = StringBody.builder().content(map).build()

Request request = Request.builder()
.method("POST")
.url('http://www.baidu.com/image/download')
.timeout(7000)
.retryCount(0)
.header("Content-Type", "application/json")
.body(body)
.build()

def res = Fx.file.uploadFileByStream(request)
log.info(res.data)
//path=N_202411_11_8ae08f8997c84e1f984bf7515ad6a1be, size=25, extensionName=.xlsx, fileName=123tom.xlsx

参考对象

注意事项

  • 如果对方返回header中包含Content-Length，包含文件的大小，通过文件流处理不会进行文件大小校验；如果不包含则会校验文件大小，不可超过5m；
  • .header('Transfer-Encoding', 'gzip').header('Accept-Encoding','identity') --增加这两个header部分场景对方服务header会返回Content-Length

3. downloadFile 文件下载返回byte[]

Fx.file.downloadFile(<String path>)

参数说明

入参格式

参数名称object描述是否必填
pathStringNpath是

出参格式

参数名称APIResult描述
isErrorBoolean是否错误
dataFileDownloadData
messageString信息
dataFileDownloadData描述
extensionNameString拓展名
fileNameString文件名
fileDatabyte[]文件内容
fileSizeInteger文件大小

出参样例


{
    "isError": false,
    "data": {
        "extensionName": ".xlsx",
        "fileName": "123tom.xlsx",
        "fileSize": 25
    },
    "message": ""
}

Groovy 举例


def ret = Fx.file.downloadFile("N_202007_12_001731386ccf40698523c39744b0161c")
def fileDowloadData = ret[1]
def fileData = fileDowloadData['fileData'] as byte[]
def str = Strings.toUTF8String(fileData) as String

参考对象

注意事项

  • 下载文件有10m限制

4. downloadStream 文件下载返回InputStream

Fx.file.downloadStream(<String path>)

参数说明

入参格式

参数名称object描述是否必填
pathStringNpath是

出参格式

参数名称APIResult描述
isErrorBoolean是否错误
dataFileDownloadData
messageString信息
dataFileDownloadData描述
extensionNameString拓展名
fileNameString文件名
inputStreamInputStream文件流
fileSizeInteger文件大小

出参样例


{
    "isError": false,
    "data": {
        "extensionName": ".xlsx",
        "fileName": "123tom.xlsx",
        "fileSize": 25
    },
    "message": ""
}

Groovy 举例


def(Boolean err, Object fileData, String msg) = Fx.file.downloadStream("N_202111_29_6eb71dca766944c582b87e6a5213f3a3.docx")
if (err) {
  log.info("downloadStream error :" + msg)
} else {
  log.info("file data :" + fileData)
}
InputStream inputStream = fileData['inputStream'] as InputStream
log.info(fileData)

参考对象

5. packedFile 将文件列表的文件打包为一个压缩包并返回下载地址码

Fx.file.packedFile(<List files>)

参数说明

入参格式

参数名称类型描述是否必填
filesList文件path列表是

出参格式

参数名称APIResult描述
isErrorboolean是否错误
dataMap返回的数据
messagestring信息

出参样例


{
  "isError" : false,
  "data" : {},
  "message" : ""
}

Groovy 举例


List files = [
     [
         "Name":"888.jpg",
         "Path":"N_202201_24_db48abc2723d4d978f240f0fb9bf35ac.webp"
     ]
]
def (Boolean error, Map data, String message) = Fx.file.packedFile(files)
if (error) {
  log.info("error :" + message)
} else {
  log.info(data)
}

注意事项

  • 返回的数据类型: Map {"status":0, "token":"xxxxx"}, status为0表示成功，token为下载地址码, status为1表示超时，没有生成下载地址码

6. packedFile 文件打包发送给指定用户

Fx.file.packedFile(<List files>, <List userIds>)

参数说明

入参格式

参数名称object描述是否必填
filesList[string]文件列表是
userIdsList[string]发送用户列表是

出参格式

参数名称APIResult描述
isErrorboolean是否错误
dataMap返回的数据
messagestring信息

出参样例


{
  "isError" : false,
  "data" : {},
  "message" : ""
}

Groovy 举例


//定义需要打包发送的文件，参数分别为：打包后的文件名、对象下的文件路径（通过find方法可查询到）、文件后缀、文件打包后的包内存放路径
UserFile file = UserFile.of("文件1","N_201907_31_57a33fb0c999447bb93fa1e4cc6e649d","jpg","/image")
List packFileList = []
packFileList.add(file)
//把fileList中的文件打包后，通过人员id参数发送给指定人
final APIResult result = Fx.file.packedFile(packFileList, Lists.newArrayList("1000"));

7. createFileShareTokens 无权限文件下载，获取文件下载token

Fx.file.createFileShareTokens(<List paths>, <String expireMinute>)

参数说明

入参格式

参数名称类型描述是否必填
pathsList[string]文件nPath列表是
expireMinuteString过期时间，以分钟为单位,最大支持15分钟是

出参格式

参数名称APIResult描述
isErrorBoolean是否错误
dataobject响应数据
messageString消息

出参样例


{
    "isError": false,
    "data": {
        
    },
    "message": "success"
}

Groovy 举例


//获取无权限文件的shareToken
List paths = ['N_202102_03_54c5ede542154b748c6f9381d96a1956']
//获取无权限文件的shareToken
def(boolean error, Map data, String  errorMessage)  = Fx.file.createFileShareTokens(5, paths)
if (error) {
    log.info(errorMessage)
} else {
    log.info(data)
}
//获取到shareToken后用下列链接下载文件：
//http://www.fxiaoke.com/FSC/N/FileShare/DownloadFileBySharedTokenV2?sharedToke******************************************************************************************************************************************************************************7AE3&name=111.jpg

8. getPresignedUrl 获取附件预签名url（仅文件专属企业可用）

Fx.file.getPresignedUrl(<List paths>, <Integer expire>)

参数说明

入参格式

参数名称类型描述是否必填
pathsList[string]文件path集合是
expireInteger过期时间(秒)是

出参格式

参数名称APIResult描述
isErrorBoolean是否错误
dataarray[object]响应数据
messageString消息
dataobject描述
pathString文件路径
urlString文件的URL

出参样例


{
    "isError": false,
    "data": [
        {
            "path": "N_202410_22_a981ae9fe95c43bea8ee8aaebc0c9490.pdf",
            "url": ""
        }
    ],
    "message": ""
}

Groovy 举例


List npaths = ["N_202207_06_2b51df0dd11043ee9c0ad341742f95bb"]
int expire = 100
def(boolean error, List data, String message) = Fx.file.getPresignedUrl(npaths, expire)
if (error) {
  log.info("error: " + message)
} else {
  log.info(data)
}

注意事项

  • 无需携带后缀

9. convertPath 转换为无权限npath

Fx.file.convertPath(<String path>, <String extension_name>)

参数说明

入参格式

参数名称类型描述是否必填
pathString文件的路径是
extension_nameString文件的扩展名是

出参格式

参数名称APIResult描述
isErrorBoolean是否错误
dataarray[object]响应数据
messageString消息
dataobject描述
path文件路径文件的路径
extension_name文件扩展名文件的扩展名

出参样例


{
    "isError": false,
    "data": [
        {
            "path": "N_202411_05_3df5da66c3d548a48792d75ed4bc7582",
            "extension_name": "pdf"
        }
    ],
    "message": ""
}

Groovy 举例


def (Boolean error, Map data, String message) = Fx.file.convertPath("N_202208_01_3628e0ba470b4086aa04dd8f3e93ed5a")
if (error) {
  log.info("error :" + message)
} else {
  log.info(data)
}

注意事项

  • 用户需要对输入的Npath对应的文件有权限

10. wordToPdf 将纷享上的word文件转成pdf

Fx.file.wordToPdf(<String npath>)

参数说明

入参格式

参数名称类型描述是否必填
npathString文件npath是

出参格式

参数名称APIResult描述
isErrorBoolean指示是否发生错误
dataList响应数据
messageString信息
dataList响应数据
pageCountInteger页面数量
employeeIdInteger员工ID
eaIntegerea
npathsList[String]npath List
fileTypeString文件类型

出参样例


{
    "isError": false,
    "data": {
        "pageCount": 1,
        "employeeId": -10000,
        "ea": 90325,
        "npaths": [
            "TN_c50f77531989492aba2765f2247371d5"
        ],
        "fileType": "pdf"
    },
    "message": "操作成功"
}

Groovy 举例


// 文件的NPath需要加上后缀名，新板文件NPath都是自带后缀的就不要再补了，老的NPath不带后缀名，需要拼上后缀
def (Boolean error, Map data, String message) = Fx.file.wordToPdf("N_202303_08_e11c1c5bb1c0486d83c5a6ece65a902f.docx")
if (error) {
  log.info("error :" + message)
} else {
  log.info(data)
}

注意事项

  • 用户需对文件有权限

11. getPdfMetaInfo 获取PDF文件的页码

Fx.file.getPdfMetaInfo(<String npath>)

参数说明

入参格式

参数名称String描述是否必填
npathString文件path,支持A、N、TA、TN文件Path,必须携带扩展名是

出参格式

参数名称APIResult描述
isErrorBoolean是否错误
dataobject响应数据
messageString消息
dataobject响应数据
pageCountInteger页面数量
employeeIdInteger员工ID

出参样例


{
    "isError": false,
    "data": {
        "pageCount": 8,
        "employeeId": 0
    },
    "message": ""
}

Groovy 举例


String npath ="N_202211_22_42918a541aed45038f3ab7cfdfb99aeb.pdf";
def(boolean error, Map data, String message) = Fx.file.getPdfMetaInfo(npath);
Integer pageCount = 0
if(error){
  log.info("error:"+message);
}else{
  log.info("PDF文档信息："+data);
  pageCount = (Integer) data.pageCount;
  log.info("PDF文档页码：" + pageCount);
}

12. mergerPdf 按集合的顺序追加合并PDF

Fx.file.mergerPdf(<List npaths>, <String documentType>)

参数说明

入参格式

参数名称类型描述是否必填
npathsList[string]要合并的文件npaths是
documentTypeString要合并的文件类型后缀（不加.)是

出参格式

参数名称APIResponse描述
isErrorBoolean指示请求是否发生错误
dataobject响应数据
messageString请求结果信息
dataobject响应数据
employeeIdInteger员工id
eaInteger企业account
npathsList[string]npath集合
fileTypeString文件的类型

出参样例


{
    "isError": false,
    "data": {
        "employeeId": 1000,
        "ea": 90325,
        "npaths": [
            "TN_fcdc479583414586a36fde4a6c2fed9a"
        ],
        "fileType": "pdf"
    },
    "message": "success"
}

Groovy 举例


List<String>npaths = Lists.newArrayList(
  "N_202410_21_093c72730bdd41e1b02d98510729330b.pdf",
  "N_202410_22_a981ae9fe95c43bea8ee8aaebc0c9490.pdf"
)
String documentType="pdf";
def (boolean error, Map data, String message) = Fx.file.mergerPdf(npaths, documentType);
if(error) {
  log.info("error:"+message);
} else {
  log.info("合并后文件的信息："+data);
  List mergerNpaths = data.npaths as List;
  String masterNpath = mergerNpaths[0];
  log.info("合并后的PDF文件path:"+ masterNpath);
}

13. getBigFilePresignedUrl 获取大文件签名url

Fx.file.getBigFilePresignedUrl(<String filePath>)

参数说明

入参格式

参数名称类型描述是否必填
filePathString大文件ALI_OSS Path是

出参格式

参数名称APIResult描述
isErrorBoolean指示请求是否发生错误
dataobject返回的数据
messageMessage请求结果信息
dataobject返回的数据
urlString文件的下载链接

出参样例


{
    "isError": false,
    "data": {
        "url": ""
    },
    "message": "请求成功，文件可下载"
}

Groovy 举例


def (Boolean error, Map data, String message) = Fx.file.getBigFilePresignedUrl("ALIOSS_851a3c46b81f4adaba45c2965892dd09")
if (error) {
  log.info("error :" + message)
} else {
  log.info(data)
}

注意事项

  • 注意区分大文件和普通文件，大文件是以 ALIOSS_ 开头的文件！！！

14. generateQRCode 将文本生成二维码或者条形码，并以Cpath或Npath的形式返回

Fx.file.generateQRCode(<string content>, <String fileName>, <Integer size>, <Boolean encode>, <Boolean needCdn>)

参数说明

入参格式

参数名称类型描述是否必填
contentstring需要转换为QRCode的内容,非空是
fileNameString下载时默认的源文件名称,默认为QRCode是
sizeInteger图片大小,默认为400是
encodeBooleancontent是否使用base64编码,默认为false,使用URL编码是
needCdnBoolean是否需要CDN加速,如果为true返回Cpath,默认为false返回Npath是

出参格式

参数名称APIResult描述
isErrorboolean指示请求是否出错，false表示请求成功
dataobject包含请求返回的主要数据
messagestring请求的结果消息，通常用于提示用户
dataobject包含请求返回的主要数据
encodeboolean指示内容是否使用base64编码，false表示使用URL编码
pathstring生成的二维码或条形码图片 path
fileNamestring下载时默认的源文件名称，默认为QRCode
needCdnboolean指示是否需要CDN加速，true表示需要
sizestring二维码或条形码的大小
employeeIdinteger员工id
eaintegerea
contentstring转换为二维码或条形码的内容

出参样例


{
    "isError": false,
    "data": {
        "encode": false,
        "path": "N_202411_05_c71f3e81b6344eb9a823d10cbe3fe554",
        "fileName": "QRCode",
        "needCdn": false,
        "size": "400*400",
        "employeeId": 1000,
        "ea": 90325,
        "content": "http://weixin.qq.com/q/02Z6nOpuoT8__1jyGaNA1Q"
    },
    "message": "请求成功，文件可下载"
}

Groovy 举例


// 需要转换的QRCode的内容（非空）
String content = "http%3A%2F%2Fweixin.qq.com%2Fq%2F02Z6nOpuoT8__1jyGaNA1Q";
// 生成QRCode Image后,使用Npath或Cpath,通过文件服务下载时默认生成的保存文件名 默认QRcode
String fileName = "QRCode";
// 生成的图片的大小, 默认400.
Integer size=400;
// 是否使用Base64对content内容进行了编码,默认false(URL 编码)
// 为什么需要编码？ 一些特殊符号,会导致请求失败或者在生成QRCode时失败
boolean encode = false;
// 是否需要CDN加速？ true 返回Cpath 默认false 返回Npath
boolean needCdn = false;
def(boolean error, Map data, String message) = Fx.file.generateQRCode(content, fileName, size, encode, needCdn);
if (error) {
  log.info("error:" + message)
} else {
  log.info("data:" + data)
}

注意事项

    1. 注意encode是true还是false
    1. 如果您有创建条形码的需求，请使用 【Fx.file.generateBarCode】 这个方法， 当前方法只能生成二维码（待下线）， generateBarCode 可生成二维码或条形码，建议您使用新方法。

15. asyncPackageFile 异步批量打包文件，发送CRM通知给操作人和需要通知的用户

Fx.file.asyncPackageFile(<List notifies>, <Map queryParam>)

参数说明

入参格式

参数名称类型描述是否必填
notifiesList[object]通知用户的 userId集合是
queryParamMap打包参数是
notifiesobject描述是否必填
userIdString用户Id是
queryParamMap打包参数是否必填
documentsList打包文件的信息是
skipDuplicatedFileBoolean是否跳过重复的文件， true:跳过，false：保留重复文件是
securityGroupString文件的安全组，如果是网盘文件，需带上XiaoKeNetDisk--
fileName文件名打包文件的名称,需带.zip 后缀是
documentsList打包文件的信息是否必填
filesList[object]文件信息List是
filesobject描述是否必填
NameString文件的完整名称，需带文件后缀是
PathStringNpath是

出参格式

参数名称APIResult描述
isErrorboolean是否错误
dataMap返回的任务数据
errorMessagestring信息
dataMap返回的任务数据
idstring任务ID
statusinteger任务状态，0 表示任务提交成功

出参样例


{
    "isError": false,
    "data": {
        "id": "67385e8385210a0007797c74",
        "status": 0
    },
    "message": ""
}

Groovy 举例


List notifies = [
    [userId: "1000"],
    [userId: "1002"]
]
Map queryParam = [
    documents: [
        files: [
            [
                Name: "青浦.zip",
                Path: "N_202410_15_c545828e983e4c20aabd5aba8510ebae.zip"
            ]
        ]
    ],
    skipDuplicatedFile : false,
    securityGroup: "XiaoKeNetDisk",
    fileName: "打包文件测试.zip"
]


def (Boolean error, Map data, String errorMessage) = Fx.biz.callAPI("Fx.file.asyncPackageFile",notifies,queryParam)
if (error) {
  log.info("error :" + message)
} else {
  log.info(data.status)
  log.info(message)
  log.info(error)
}

注意事项

    1. 下载网盘文件需设置参数 securityGroup: "XiaoKeNetDisk"
    1. 自定义下载文件名需加.zip后缀
    1. 必选参数必须携带！！

16. 将文本生成二维码或者条形码，并以Cpath或Npath的形式返回

Fx.file.generateBarCode(<string content>, <String fileName>, <String size>, <Boolean encode>, <Boolean needCdn>, <String codeModel>)

参数说明

入参格式

参数名称类型描述是否必填
contentstring需要转换为Code的内容,非空是
fileNameString下载时默认的源文件名称是
sizeString生成的图片的大小,单位:像素;如果是二维码,参数设置如400400(数字之间用“”间隔),二维码最大限制为700700,最小限制宽高皆为0,推荐400400,尽量保持宽高大小一致;如果是条形码,不需要输入,默认450*150.是
encodeBooleancontent是否使用base64编码,默认为false,使用URL编码是
needCdnBoolean是否需要CDN加速,如果为true返回Cpath,默认为false返回Npath是
codeModelString所需二维码的类型,BarCode 条形码,QRCode 二维码，此值必填，无默认类型，如果不选择会报错.是

出参格式

参数名称APIResult描述
isErrorboolean指示请求是否出错，false表示请求成功
dataobject包含请求返回的主要数据
messagestring请求的结果消息，通常用于提示用户
dataobject包含请求返回的主要数据
encodeboolean指示内容是否使用base64编码，false表示使用URL编码
pathstring生成的二维码或条形码图片 path
fileNamestring下载时默认的源文件名称，默认为QRCode
needCdnboolean指示是否需要CDN加速，true表示需要
sizestring二维码或条形码的大小
employeeIdinteger员工id
eaintegerea
contentstring转换为二维码或条形码的内容

出参样例


{
    "isError": false,
    "data": {
        "encode": false,
        "path": "N_202411_05_c71f3e81b6344eb9a823d10cbe3fe554",
        "fileName": "QRCode",
        "needCdn": false,
        "size": "400*400",
        "employeeId": 1000,
        "ea": 90325,
        "content": "http://weixin.qq.com/q/02Z6nOpuoT8__1jyGaNA1Q"
    },
    "message": "请求成功，文件可下载"
}

Groovy 举例


// 需要转换的QRCode的内容，如果您选择的是条形码(BarCode),那么限定内容大小100字符.（非空）
String content = "http%3A%2F%2Fweixin.qq.com%2Fq%2F02Z6nOpuoT8__1jyGaNA1Q";
// 生成QRCode Image后,使用Npath或Cpath,通过文件服务下载时默认生成的保存文件名 默认QRcode
String fileName = "QRCode";
// 生成的图片的大小,单位:像素;如果是二维码,参数设置如400*400(数字之间用“*”间隔),二维码最大限制为700*700,最小限制宽高皆为0,推荐400*400,尽量保持宽高大小一致;如果是条形码,不需要输入,默认450*150.
String size="400*400";
// 是否使用Base64对content内容进行了编码,默认false(URL 编码)
// 为什么需要编码？ 一些特殊符号,会导致请求失败或者在生成QRCode时失败
boolean encode = false;
// 是否需要CDN加速？ true 返回Cpath 默认false 返回Npath
boolean needCdn = false;
// 所需二维码的类型,BarCode 条形码,QRCode 二维码，此值必填，无默认类型，如果不选择会报错.
String codeModel="QRCode";
def(boolean error, Map data, String message) = Fx.biz.callAPI("Fx.file.generateBarCode",content, fileName, size, encode, needCdn, codeModel);
if (error) {
  log.info("error:" + message)
} else {
  log.info("data:" + data)
}

注意事项

  • 注意encode是true还是false

17. 通过大附件path删除大附件

Fx.file.deleteBigFile(<string path>)

参数说明

入参格式

参数名称String描述是否必填
pathstring大附件path是

出参格式

参数名称object描述
codeinteger表示请求处理状态
data类型请求返回数据
successboolean是否成功
messagestring请求处理信息

出参样例


{
    "code": 200,
    "data": true,
    "success": true,
    "message": "请求成功"
}

Groovy 举例


String path= "ALIOSS_338bdf957ef64507b457168c821d4f72"
def (Boolean error, Map data, String errorMessage) = Fx.biz.callAPI("Fx.file.deleteBigFile", path)
if (error) {
  log.info("error :" + message)
} else {
  log.info(data)
}

注意事项

  • 删除后文件将无法访问

18. 查询异步打包任务状态

Fx.file.queryBatchStatus(<string jobId>)

参数说明

入参格式

参数名称object描述是否必填
jobIdstring任务Id是

出参格式

参数名称object描述
idstringjobId
fileExtstring文件扩展名，例如 zip
urlstring文件的完整 下载URL 地址(base64加密)
statusinteger状态码，表示任务的状态

出参样例


{
  "id": "jobId",
  "fileExt": "zip",
  "url": "base64 加密后的下载url",
  "status": 2
}

Groovy 举例


def (Boolean error, Map data, String errorMessage) = Fx.biz.callAPI("Fx.file.queryBatchStatus", "yourJobId")
if (error) {
  log.info("error :" + message)
} else {
  log.info(data)
}

注意事项

  • 状态码 | 状态名称（中文）
  • ------|-------------
  • 0 | 等待中
  • 1 | 运行中
  • 2 | 成功
  • 3 | 失败
  • 4 | 错误
  • 5 | 取消中
  • 6 | 已取消
  • 7 | 请求取消
  • 8 | 未知状态
  • 只能查询Fx.file.asyncPackageFile返回的JobId

19. 解析excel，通过consumer自定义处理逻辑

Fx.file.parseExcel(<String nPath>, <String sheet>, <Integer startRow>, <Consumer<Map> consumer>)

参数说明

入参格式

参数名称类型描述是否必填
nPathString文件npath是
sheetStringsheet名称，不匹配则不会处理是
startRowInteger<=0都为0处理，0代表标题行，以此往后推算行数，传null默认为1是
consumerConsumer<Map>自定义处理逻辑是

出参格式

参数名称APIResult描述
errorBoolean是否错误
dataMap返回的数据
messageString信息

出参样例


{
    "isError": false,
    "data": {},
    "message": ""
}

Groovy 举例


String npath = "N_202408_05_4210a63c2d5440809b4fad72884f3ef6.xlsx"
String sheet = "Sheet1"
Integer startRow = 0
def ret = Fx.file.parseExcel(npath, sheet, startRow, { e ->
     Fx.object.create("object_1yO4J__c", e, , CreateAttribute.builder().build()).result()
})
log.info(ret)

注意事项

  • 不支持大附件

负责人：斯作益seth

参考类 com.fxiaoke.functions.http.Request

字段说明

参数名称object描述
headersjava.util.Map<java.lang.String,java.util.List<java.lang.String>>请求的header
methodjava.lang.String请求的方法POST/GET/PUT...
retryCountjava.lang.Integer重试次数，0表示不重试，最大3次重试
insecurejava.lang.Boolean是否绕过SSl验证，默认为false，不绕过SSL
bodycom.fxiaoke.functions.http.RequestBody请求的body
timeoutjava.lang.Integer超时时间，最大120s
urljava.lang.String请求的url地址

参考类 com.fxiaoke.functions.model.FileDownloadData

字段说明

参数名称object描述
extensionNamejava.lang.String文件拓展名
fileNamejava.lang.String文件名
fileSizelong文件大小
fileDatabyte[]文件byte数组

版本记录

版本日期变更内容负责人
v1.02026-05-19初始版本

背景说明

本文档详细描述 Fx.file 的相关接口功能和使用方法，帮助开发者快速集成相关能力。

适用场景

具体适用场景由实际业务需求决定，开发者可根据需要选择相应的接口进行集成。

前置条件

  • 已接入纷享销客开放平台
  • 已完成应用授权与配置
  • 了解相关业务领域基础知识

操作步骤

具体操作步骤请参考各接口的详细说明。

注意事项

  • 调用接口前请确保满足前置条件
  • 注意接口调用频率限制
  • 异常情况请参考错误码说明进行处理

兼容性说明：当前版本暂无可用的废弃或兼容性说明。