互动卡片MCP复制页面创建并投放卡片POST/v1.0/card/instances/createAndDeliver调试Run in ApifoxRun in Apifox**接口调用量说明**钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。调用本接口为创建并投放卡片接口。接口功能介绍#调用本接口，可以创建卡片实例，并将卡片投放至多个指定场域，创建卡片的时候，除了设置卡片的基本数据，还可以设置动态数据源等。说明目前支持将卡片投放至以下场域：IM群聊、IM机器人单聊、吊顶、协作、文档。接口调用说明#在将卡片投放到不同的场域时，使用outTrackId唯一标识一张卡片，通过openSpaceId标识需要被投放的场域及其场域Id，通过openDeliverModels传入不同的投放场域。场域类型及其sapceId定义如下：场域类型SpaceTypeSpaceIdSpaceId含义IM群聊IM_GROUPopenConversationId会话idIM机器人单聊IM_ROBOTuserId/unionId员工id吊顶ONE_BOXopenConversationId会话id协作COOPERATON_FEEDuserId/unionId员工id文档DOCdocKey文档key权限#要调用此API，需要以下权限之一。应用类型是否支持权限API Explorer调试企业内部应用支持互动卡片实例写权限API Explorer第三方企业应用支持互动卡片实例写权限API Explorer第三方个人应用暂不支持互动卡片实例写权限暂不支持错误码#HttpCode错误码错误信息说明400param.emptyparam.empty入参为空400param.outTrackIdEmptyparam.outTrackIdEmpty业务标识outTrackId为空400param.openSpaceIdEmptyparam.openSpaceIdEmpty投放openSpaceId为空400param.openDeliverModelEmptyparam.openDeliverModelEmpty场域投放模型为空400param.openDeliverModelErrorparam.openDeliverModelError场域投放模型格式错误400param.openSpaceIdInvalidparam.openSpaceIdInvalidopenSpaceId不符合规范400param.cardTemplateIdEmptyparam.cardTemplateIdEmpty卡片模版Id为空400param.userIdEmptyparam.userIdEmpty用户userId为空400param.cardPublicDataEmptyparam.cardPublicDataEmpty卡片公共数据为空400param.userIdNotExistparam.userIdNotExist用户user不存在400param.dynamicDataMappingEmptyparam.dynamicDataMappingEmpty动态数据源数据映射为空400param.dynamicSourceIdEmptyparam.dynamicSourceIdEmpty动态数据源配置ID为空400param.dynamicDataPullConfigEmptyparam.dynamicDataPullConfigEmpty动态数据源拉取配置为空400param.dynamicDataPullIntervalInvalidparam.dynamicDataPullIntervalInvalid动态数据源拉取间隔时间为空或非法400param.dynamicDataPullIntervalTimeUnitInvalidparam.dynamicDataPullIntervalTimeUnitInvalid动态数据源拉取间隔时间单位为空或非法400param.dynamicDataSourcePullStrategyEmptyparam.dynamicDataSourcePullStrategyEmpty动态数据源拉取策略为空400param.dynamicDataMappingPathEmptyparam.dynamicDataMappingPathEmpty动态数据源数据映射路径为空400param.dynamicDataValueTypeEmptyparam.dynamicDataValueTypeEmpty动态数据源数据类型为空400param.contentUnsafeparam.contentUnsafe卡片数据不能通过安全审查400param.openSpaceModelInvalidparam.openSpaceModellnvalid错误的场域属性模型400param.cardNotExistparam.cardNotExist卡片不存在400param.cardAlreadyExistparam.cardAlreadyExist卡片已经存在400param.templateNotExistparam.templateNotExist模板不存在400param.templateUnpublishedparam.templateUnpublished模板未发布400param.invalidparam.invalid存在非法参数500system.busysystem.busy系统繁忙请求参数Header 参数生成代码Body 参数application/json生成代码示例返回响应🟢200成功application/json生成代码Bodyapplication/json生成代码请求示例请求示例ShellJavaScriptJavaSwiftcURLcURL-WindowsHttpiewgetPowerShellcurl --location 'https://api.dingtalk.com/v1.0/card/instances/createAndDeliver' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data '{
"userId" : "String",
"cardTemplateId" : "String",
"outTrackId" : "String",
"callbackRouteKey" : "String",
"cardData" : {
"cardParamMap" : {
"key" : "String"
}
},
"privateData" : {
"key" : {
"cardParamMap" : {
"key" : "String"
}
}
},
"openDynamicDataConfig" : {
"dynamicDataSourceConfigs" : [ {
"dynamicDataSourceId" : "String",
"constParams" : {
"key" : "String"
},
"pullConfig" : {
"pullStrategy" : "String",
"interval" : Integer,
"timeUnit" : "String"
}
} ]
},
"imGroupOpenSpaceModel" : {
"supportForward" : Boolean,
"lastMessageI18n" : {
"key" : "String"
},
"searchSupport" : {
"searchIcon" : "String",
"searchTypeName" : "String",
"searchDesc" : "String"
},
"notification" : {
"alertContent" : "String",
"notificationOff" : Boolean
}
},
"imRobotOpenSpaceModel" : {
"supportForward" : Boolean,
"lastMessageI18n" : {
"key" : "String"
},
"searchSupport" : {
"searchIcon" : "String",
"searchTypeName" : "String",
"searchDesc" : "String"
},
"notification" : {
"alertContent" : "String",
"notificationOff" : Boolean
}
},
"coFeedOpenSpaceModel" : {
"title" : "String",
"coolAppCode" : "String"
},
"topOpenSpaceModel" : {
"spaceType" : "String"
},
"openSpaceId" : "String",
"imGroupOpenDeliverModel" : {
"robotCode" : "String",
"atUserIds" : {
"key" : "String"
},
"recipients" : [ "String" ]
},
"imRobotOpenDeliverModel" : {
"spaceType" : "String"
},
"topOpenDeliverModel" : {
"expiredTimeMillis" : Long,
"userIds" : [ "String" ],
"platforms" : [ "String" ]
},
"coFeedOpenDeliverModel" : {
"bizTag" : "String",
"gmtTimeLine" : Long
},
"docOpenDeliverModel" : {
"userId" : "String"
},
"userIdType" : Integer
}'响应示例响应示例{
"success": true,
"result": {
"outTrackId": "string",
"deliverResults": [
{
"spaceType": "string",
"spaceId": "string",
"success": true,
"carrierId": "string",
"errorMsg": "string"
}
]
}
}【钉钉】API开发者 微信交流群
用微信扫右侧二维码，加入【钉钉】API开发者 交流群，互助沟通
扫码加入交流群修改于 2024-01-16 09:16:19上一页更新卡片下一页注册卡片回调地址LLMs.txt克隆导出Built with