纷享销客开发者手册

简体中文

English

Fx.tag

约 2330 字大约 8 分钟

2026-01-09

目录

摘要

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

1. findTagDefine 查找对象适用的标签

Fx.tag.findTagDefine(<string objectApiName>)

参数说明

入参格式

参数名称object描述是否必填
objectApiNamestring对象apiName是

出参格式

参数名称APIResult描述
isErrorboolean是否错误
dataQueryResult返回的数据
messagestring信息
dataQueryResult返回的数据
dataListarray[object]
sizeinteger数量
totalinteger总量
dataListobject标签的描述
tagGroupstring标签所在分组
tagGroupIdstring标签所在分组id
tagIdstring标签id
tagApiNamestring标签api
namestring标签名称
tagGroupApiNamestring标签分组api

出参样例


{
    "isError": false,
    "data": {
        "dataList": [
            {
                "tagGroup": "lzhh-tag",
                "tagGroupId": "66d981dde18ae10007ce06f3",
                "tagId": "66d981dde18ae10007ce06f4",
                "tagApiName": "label_Uj3sC__c",
                "name": "lzhh标签名称2",
                "tagGroupApiName": "group_RW66c__c"
            }
        ],
        "size": 1,
        "total": 1
    },
    "message": ""
}

Groovy 举例


APIResult ret  = Fx.tag.findTagDefine("object_76is3__c")
log.info(ret)

参考对象

2. findTagById 查找某条数据上的所有标签

Fx.tag.findTagById(<string objectApiName>, <string dataId>)

参数说明

入参格式

参数名称object描述是否必填
objectApiNamestring是
dataIdstring是

出参格式

参数名称APIResult描述
isErrorboolean是否错误
dataarray[object]返回的数据列表
messagestring信息
dataobject标签信息
tagIdstring标签id
namestring标签名称

出参样例


{
    "isError": false,
    "data": [
        {
            "tagId": "642fb2458085c60001d03744",
            "name": "2"
        }
    ],
    "message": ""
}

Groovy 举例


APIResult ret  = Fx.tag.findTagById( "obj_lzhh_pure__c", "66d956ca0410610007694b99")
log.info(ret)

3. update 更新数据的标签

Fx.tag.update(<string objectApiName>, <string dataId>, <array tagIdList>)

参数说明

入参格式

参数名称object描述是否必填
objectApiNamestring是
dataIdstring是
tagIdListarray[string]是

出参格式

参数名称APIResult描述
isErrorboolean是否错误
datastring被更新标签的id
messagestring信息

出参样例


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

Groovy 举例


def (Boolean error,String data,String errorMessage) = Fx.tag.update("obj_lzhh_pure__c", "66d956ca0410610007694b99", [])
log.info(data)

注意事项

  • 空list会删除所有标签
  • 会检查tag和数据是否适配, 不适配回参error=true, 如果错误信息是Error in bulkHangTagForData, 原因大概率是tag不适用当前对象, 可以使用Fx.tag.findTagDefine查找适用的tag

4. createTag 创建标签

Fx.tag.createTag(<string description>, <string groupId>, <string tagApiName>, <string tagName>)

参数说明

入参格式

参数名称object描述是否必填
descriptionstring是
groupIdstringtag组的id, 必须已经存在是
tagApiNamestring是
tagNamestring是

出参格式

参数名称APIResult描述
isErrorboolean是否错误
datastring生成的标签的id
messagestring信息

出参样例


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

Groovy 举例


def arg = TagArg.builder()
        .groupId("5ea3b0e5e1a70b0001e2f65b")
        .tagApiName("tag_scDwW_tesat2__c")
        .tagName("函数创建标签1-aafj-test2")
        .description("test001")
        .build();
APIResult ret  = Fx.tag.createTag(arg)
log.info(ret)

参考对象

注意事项

  • tag组必须已经存在

5. updateTag 更新标签

Fx.tag.updateTag(<string description>, <string groupId>, <string tagId>, <string tagName>)

参数说明

入参格式

参数名称object描述是否必填
descriptionstring是
groupIdstring是
tagIdstring是
tagNamestring是

出参格式

参数名称APIResult描述
isErrorboolean是否错误
datanull
messagestring信息

出参样例


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

Groovy 举例


def arg = TagArg.builder()
       .groupId("5ea3b0e5e1a70b0001e2f65b")
       .tagId("66da75ab6a3bb50007ad52de")
       .tagName("函数签03-f--asas---j")
       .description("更新标签3")
       .build()
def result = Fx.tag.updateTag(arg)

参考对象

注意事项

  • 更新是异步进行的, 所以这函数没有返回值, 可以通过Fx.tag.findTagByTagIds来查看是否修改成功

6. createTagGroup 创建标签分组

Fx.tag.createTagGroup(<String api_name>, <String tag_group_name>, <String describe_api_names>, <String is_applied_to_all>)

参数说明

入参格式

参数名称类型描述是否必填
api_nameString分组apiName是
tag_group_nameString分组名称是
describe_api_namesString[string]适用对象列表是
is_applied_to_allString是否适用全部对象是

出参格式

参数名称类型描述
tagDescribeobject
tagDescribeobject描述
createTimeInterger创建时间
deletedBoolean是否删除
isActiveBoolean是否禁用
apiNameString分组apiName
lastModifiedByString最后修改人
tagRangeList[string]适用对象列表
isAllBoolean是否适用所有对象
tagDefineTypeString类型
groupDescriptionString分组描述
tenantIdString企业id
createdByString创建人
idString分组id
typeString分组名称
lastModifiedTimeInteger最后修改时间

出参样例


{
    "createTime": 1728649707933,
    "deleted": false,
    "isActive": true,
    "apiName": "group_YpkQ3__c",
    "lastModifiedBy": "1000",
    "tagRange": [
        "MarketingKeywordObj",
        "EnterpriseInfoObj"
    ],
    "isAll": false,
    "tagDefineType": "custom",
    "groupDescription": "实打实打算",
    "tenantId": "78057",
    "createdBy": "1000",
    "id": "670919eb4306ff0007bf397f",
    "type": "测试",
    "lastModifiedTime": 1728649707933,
    "containerDocument": {
        "_id": "670919eb4306ff0007bf397f",
        "tenant_id": "78057",
        "type": "测试",
        "is_deleted": false,
        "tag_define_type": "custom",
        "describe_api_name": null,
        "created_by": "1000",
        "last_modified_by": "1000",
        "create_time": 1728649707933,
        "last_modified_time": 1728649707933,
        "tag_range": [
            "MarketingKeywordObj",
            "EnterpriseInfoObj"
        ],
        "is_all": false,
        "api_name": "group_YpkQ3__c",
        "is_mutex": null,
        "is_active": true,
        "group_description": "实打实打算"
    }
}

Groovy 举例


def (String message,Map data,Boolean error) = Fx.tag.createTagGroup(["AccountObj"],"group_ceshi11__c",false,"测试分组名称123")

7. updateTagGroup 修改标签分组

Fx.tag.updateTagGroup(<String api_name>, <String id>, <List describe_api_names>, <Boolean is_applied_to_all>, <String tag_group_name>)

参数说明

入参格式

参数名称类型描述是否必填
api_nameString标签分组apiName是
idString标签分组id是
describe_api_namesList[String]该标签分组适用的对象列表是
is_applied_to_allBoolean是否适用全部对象是
tag_group_nameString分组名称是

出参格式

参数名称object描述
Resultobject
Valueobject
Resultobject描述
FailureCodeinteger
StatusCodeinteger
UserInfoobject
UserInfoobject描述
EmployeeIDinteger
EnterpriseAccountstring
Valueobject描述
tagDescribeobject
tagDescribeobject描述
createTimeInteger创建时间
isActiveBoolean分组状态
deletedBoolean是否删除
tagRangeList[string]适用对象范围
isAllBoolean是否适用全部对象
isMutexBoolean是否互斥
apiNameString分组apiName
tagDefineTypeString标签分类类型
groupDescriptionString分组描述
lastModifiedByString最后修改人
createdByString创建人
tenantIdString企业id
idString分组id
rangeObject人员适用范围
typeString分组名称
lastModifiedTimeInteger最后修改时间

出参样例


{
    "Result": {
        "FailureCode": 0,
        "StatusCode": 0,
        "UserInfo": {
            "EmployeeID": 1000,
            "EnterpriseAccount": "74255"
        }
    },
    "Value": {
        "tagDescribe": {
            "createTime": 1587785957907,
            "isActive": true,
            "deleted": false,
            "tagRange": [
                "AccountFinInfoObj"
            ],
            "isAll": false,
            "isMutex": false,
            "apiName": "ceshi002__c",
            "tagDefineType": "custom",
            "groupDescription": "测试数据描述",
            "lastModifiedBy": "1000",
            "createdBy": "1000",
            "tenantId": "74255",
            "id": "5ea3b0e5e1a70b0001e2f65b",
            "range": {},
            "type": "测试数据",
            "lastModifiedTime": 1728565061702
        }
    }
}

Groovy 举例


def(String message,Map data,Boolean error) = Fx.tag.updateTagGroup("group_ceshi11__c","624272c1babe24000101d2e5",[],true,"更改测试名")
if

注意事项

  • 1.参数api_name限制：（1）不能为空，（2）不能修改
  • 2.参数tag_group_name：（1）不能为空，（2）数量不能大于10个字符

8. deleteTagGroup 删除标签分组

Fx.tag.deleteTagGroup(<String api_name>, <String id>)

参数说明

入参格式

参数名称object描述是否必填
api_nameString标签分组apiName是
idString标签分组id是

Groovy 举例


def(String message,Map data,Boolean error) = Fx.tag.deleteTagGroup("624272c1babe24000101d2e5")

9. enableTag 启用标签

Fx.tag.enableTag(<String tag_group_id>, <String tag_group_api_name>, <String tag_id>, <String tag_api_name>)

参数说明

入参格式

参数名称object描述是否必填
tag_group_idString标签分组id是
tag_group_api_nameString标签分组apiName是
tag_idString标签id是
tag_api_nameString标签apiName是

Groovy 举例


def result = Fx.tag.enableTag("tag_scDwW__c","group_ceshi11__c","62427820babe24000101d80d","6242784d06e1bf00015f33ec")

10. disableTag 禁用标签

Fx.tag.disableTag(<string tag_group_id>, <string tag_group_api_name>, <string tag_id>, <string tag_api_name>)

参数说明

入参格式

参数名称object描述是否必填
tag_group_idstring是
tag_group_api_namestring是
tag_idstring是
tag_api_namestring是

Groovy 举例


def result = Fx.tag.disableTag("tag_scDwW__c","group_ceshi11__c","62427820babe24000101d80d","6242784d06e1bf00015f33ec")

11. deleteTag 删除标签

Fx.tag.deleteTag(<String tag_group_id>, <String tag_group_api_name>, <String tag_id>, <String tag_api_name>)

参数说明

入参格式

参数名称类型描述是否必填
tag_group_idString标签分组id是
tag_group_api_nameString标签分组apiName是
tag_idString标签id是
tag_api_nameString标签apiName是

Groovy 举例


def result = Fx.tag.deleteTag("tag_scDwW__c","group_ceshi11__c","62427820babe24000101d80d","6242784d06e1bf00015f33ec")

12. findTagGroup 根据apiName查找标签分组及其适用对象

Fx.tag.findTagGroup(<String group_api_name>)

参数说明

入参格式

参数名称类型描述是否必填
group_api_nameString标签分组ApiName是

出参格式

参数名称类型描述
nameString分组名称
apiNameListList[string]适用对象范围
isAppliedToAllBoolean是否使用全部对象
tagGroupIdString标签分组id

出参样例


{
    "name":"分组名称",
    "apiNameList":["AccountObj"],
    "isAppliedToAll":true,
    "tagGroupId":"5e981b91ee56e5446723dd1e"
}

Groovy 举例


def (String message,Map data ,Boolean error) = Fx.tag.findTagGroup("group_ceshi11__c")

13. findTagByTagIds 根据标签id批量查询标签描述

Fx.tag.findTagByTagIds(<array apiNames>)

参数说明

入参格式

参数名称类型描述是否必填
apiNamesarray[string]是

出参格式

参数名称APIResult描述
isErrorboolean是否错误
dataobject返回的数据
messagestring信息
dataobject返回的数据
tagListarray[object]返回的数据列表
tagListobject标签描述
last_modified_timenumber最后修改时间
is_activeboolean是否启用
create_timenumber创建时间
tag_group_idstring标签所属组
namestring标签名称
descriptionstring标签描述
tag_api_namestring标签apiName
idstring标签id
create_userstring创建用户

出参样例


{
    "isError": false,
    "data": {
        "tagList": [
            {
                "last_modified_time": 1723431673765,
                "is_active": true,
                "create_time": 1588770951196,
                "tag_group_id": "5ea3b0e5e1a70b0001e2f65b",
                "name": "测试222222",
                "description": "",
                "tag_api_name": "label_ntys8__c",
                "id": "5eb2b887d653e40001369112",
                "create_user": "1000"
            },
            {
                "last_modified_time": 1722323037015,
                "is_active": false,
                "create_time": 1606540721016,
                "tag_group_id": "5fc1dd880680680001fc1900",
                "name": "上海活动",
                "description": "",
                "tag_api_name": "tag_nyMWk__c",
                "id": "5fc1ddb10680680001fc1906",
                "create_user": "1000"
            }
        ]
    },
    "message": ""
}

Groovy 举例


List tagIds = ["5fc1dd990680680001fc1903"]
def(Boolean error, Map data, String message) = Fx.tag.findTagByTagIds(tagIds)
if (error) {
    log.info("error:" + message)
}
log.info(data)

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

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

字段说明

参数名称object描述
tagIdjava.lang.String标签id
tagApiNamejava.lang.String标签apiName
groupApiNamejava.lang.String可选参数，
groupIdjava.lang.String标签组id
descriptionjava.lang.String描述
tagNamejava.lang.String标签名称

版本记录

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

背景说明

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

适用场景

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

前置条件

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

操作步骤

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

注意事项

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

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