摘要

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

1. executeAsyncFunc 异步执行控制器函数

Fx.function.executeAsyncFunc(<String functionApiName>, <Map param>)

参数说明

入参格式

参数名称	类型	描述	是否必填
functionApiName	String	需要执行的函数apiName	是
param	Map	执行函数时传入的参数	是

Groovy 举例

Map keyValue = [
"key1":"value1",
"key2":"value2"
]

Map param = [
"map":keyValue
]
def (error,result,errorMessage) = Fx.function.executeAsyncFunc("funcCalled__c",param)
if(error){
    log.error("executeAsyncFunc error: "+errorMessage)
    //1.使用报错终止执行
    //Fx.message.throwException("executeAsyncFunc error: "+errorMessage)

    //2.使用return终止执行
    //return;

    //3.继续执行
} 

//dosomething

注意事项

• 异步执行控制器没有执行结果

2. executeOrderlyAsyncFunc 顺序执行异步控制器函数

Fx.function.executeOrderlyAsyncFunc(<String functionApiName>, <Map param>)

参数说明

入参格式

参数名称	类型	描述	是否必填
functionApiName	String	需要执行的函数apiName	是
param	Map	执行函数时传入的参数	是

Groovy 举例

Map keyValue = [
"key1":"value1",
"key2":"value2"
]

Map param = [
"map":keyValue
]
def (error,result,errorMessage) = Fx.function.executeOrderlyAsyncFunc("funcCalled__c",param)
if(error){
    log.error("executeOrderlyAsyncFunc error: "+errorMessage)
    //1.使用报错终止执行
    //Fx.message.throwException("executeOrderlyAsyncFunc error: "+errorMessage)

    //2.使用return终止执行
    //return;

    //3.继续执行
} 

//dosomething

注意事项

• 异步执行没有执行结果

3. ontimeFunc 定时执行控制器函数

Fx.function.ontimeFunc(<String functionApiName>, <Map param>, <String runTime>)

参数说明

入参格式

参数名称	类型	描述	是否必填
functionApiName	String	需要执行的函数apiName	是
param	Map	执行函数时传入的参数	是
runTime	String	定时执行的时间	是

Groovy 举例

Map keyValue = [
"key1":"value1",
"key2":"value2"
]

Map param = [
"map":keyValue
]
def (error,result,errorMessage) = Fx.function.ontimeFunc("funcCalled__c",param,"2021-05-03 00:00:00")
if(error){
    log.error("ontimeFunc error: "+errorMessage)
    //1.使用报错终止执行
    //Fx.message.throwException("ontimeFunc error: "+errorMessage)

    //2.使用return终止执行
    //return;

    //3.继续执行
} 
log.info("transactionId="+result)
//dosomething

注意事项

• 指定执行会返回一个transactionId，该结果对排查问题较为重要，可以考虑做记录

4. asyncOnVipQueue 使用独立的队列执行异步任务，不影响其他异步任务的执行（需要单独付费）

Fx.function.asyncOnVipQueue(<String functionApiName>, <Map param>)

参数说明

入参格式

参数名称	类型	描述	是否必填
functionApiName	String	需要执行的函数apiName	是
param	Map	执行函数时传入的参数	是

Groovy 举例

Map param = [
  "map":[
    "a": 123,
    "b": "sdte"
  ]
]

def (error,result,errorMessage) = Fx.function.asyncOnVipQueue("func_U4Oqt__c", param)
if(error){
    log.error("asyncOnVipQueue error: "+errorMessage)
    //1.使用报错终止执行
    //Fx.message.throwException("asyncOnVipQueue error "+errorMessage)

    //2.使用return终止执行
    //return;

    //3.继续执行
} 
log.info("traceId="+result)
//dosomething

注意事项

• 返回值为traceId

5. asyncOnVipQueue 使用独立的队列执行异步任务，指定队列，不影响其他异步任务的执行（需要单独付费）

Fx.function.asyncOnVipQueue(<String functionApiName>, <Map param>, <Integer queueIndex>)

参数说明

入参格式

参数名称	类型	描述	是否必填
functionApiName	String	需要执行的函数apiName	是
param	Map	执行函数时传入的参数	是
queueIndex	Integer	指定执行的队列（队列的下标，从0开始，当大于购买数量时做取模运算）	是

Groovy 举例

Map param = [
  "map":[
    "a": 123,
    "b": "sdte"
  ]
]


def (error,result,errorMessage) = Fx.function.asyncOnVipQueue("func_U4Oqt__c", param, 0)
if(error){
    log.error("asyncOnVipQueue error: "+errorMessage)
    //1.使用报错终止执行
    //Fx.message.throwException("asyncOnVipQueue error "+errorMessage)

    //2.使用return终止执行
    //return;

    //3.继续执行
} 
log.info("traceId="+result)
//dosomething

版本记录

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

背景说明

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

适用场景

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

前置条件

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

操作步骤

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

注意事项

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

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