创建并开启互动卡片吊顶

POST

/v2.0/im/topBoxes

**
接口调用量说明**钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口创建并开启会话中的互动卡片吊顶。

接口功能介绍

调用本接口，开启会话内的互动卡片吊顶，具体示例如下图所示：

接口调用说明

1.对于群聊会话类型，支持以下场景使用：

基于群模板创建的群

企业内部应用，详情参见创建群。

第三方企业应用，详情参见创建群。

安装群聊酷应用的群。

企业内部应用，详情参见群聊酷应用。

第三方企业应用，详情参见酷应用。

2.对于单聊助手会话类型，支持以下场景：

此接口只适用于已经建立会话的单聊助手，即第一次开启吊顶前，需要先使用机器人给用户发送单聊消息，以建立单聊助手会话。

企业内部应用，调用发送普通版互动卡片接口或发送高级版互动卡片接口或批量发送单聊消息接口。

第三方企业应用，调用发送普通版互动卡片接口或发送高级版互动卡片接口或批量发送单聊消息接口。

3.单个会话中最多可开启10个吊顶。若会话内已经存在10个未关闭的吊顶，需要关闭已开启的吊顶，然后再开启新的吊顶。

4.接口调用方需要自己记录每个会话内的互动卡片吊顶的相关信息（比如：outTrackId, openConversationId, userId, unionId, robotCode等信息），以便于管理会话中的互动卡片吊顶。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	chat相关接口的管理权限	API Explorer
第三方企业应用	支持	chat相关接口的管理权限	API Explorer
第三方个人应用	暂不支持	chat相关接口的管理权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	param.empty	请求参数为空	请求参数为空
400	cidParse.wrong	会话id解码失败	会话id解码失败
400	chat.notExist	会话不存在	会话不存在
400	group.org.checkFailed	群不属于当前企业	群不属于当前企业
400	chat.coolApp.notInstalled	酷应用未安装到会话内	酷应用未安装到会话内
400	permission.coolApp.checkFailed	无权限，酷应用不属于当前token对应的应用名下	无权限，酷应用不属于当前token对应的应用名下
400	group.groupTemplate.notInstalled	群模板未安装到群内	群模板未安装到群内
400	permission.sceneGroup.checkFailed	无权限，该群安装的群模板不属于当前token对应的应用名下	无权限，该群安装的群模板不属于当前token对应的应用名下
400	card.content.checkFailed	卡片内容违规	卡片内容违规
400	cardInstance.wrong	创建卡片实例失败，先检查卡片模板是否已发布	创建卡片实例失败，先检查卡片模板是否已发布
400	receiver.id.parseFailed	吊顶可见者id解析失败	吊顶可见者id解析失败
400	open.topbox.failed	开启吊顶失败	开启吊顶失败
400	user.not.found	用户不存在	用户不存在
400	robot.not.found	机器人不存在	机器人不存在
400	conversationType.illegal	会话类型值无效	会话类型值无效
400	param.illegal	请求参数无效	请求参数无效
400	robot.queryFalied	机器人查询失败	机器人查询失败
400	mainApp.queryFailed	主应用查询失败	主应用查询失败
400	coolAppCode.empty	酷应用编码为空	酷应用编码为空
400	openConversationId.empty	会话id为空	会话id为空
400	userIdOrUnionId.empty	用户id为空	用户id为空
400	robotCode.empty	机器人编码为空	机器人编码为空
400	cardTemplate.not.exist	卡片模板不存在	卡片模板不存在
400	auth.failed	%s	权限校验不通过
500	system.busy	系统繁忙	系统异常错误

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dingtalk.com/v2.0/im/topBoxes' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw 'POST /v2.0/im/topBoxes HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:String
Content-Type:application/json

{
  "cardTemplateId" : "String",
  "outTrackId" : "String",
  "callbackRouteKey" : "String",
  "cardData" : {
    "cardParamMap" : {
      "key" : "String"
    }
  },
  "userIdPrivateDataMap" : {
    "key" : {
      "cardParamMap" : {
        "key" : "String"
      }
    }
  },
  "unionIdPrivateDataMap" : {
    "key" : {
      "cardParamMap" : {
        "key" : "String"
      }
    }
  },
  "cardSettings" : {
    "pullStrategy" : Boolean
  },
  "conversationType" : Integer,
  "openConversationId" : "String",
  "userId" : "String",
  "unoinId" : "String",
  "robotCode" : "String",
  "coolAppCode" : "String",
  "groupTemplateId" : "String",
  "receiverUserIdList" : [ "String" ],
  "receiverUnionIdList" : [ "String" ],
  "expiredTime" : Long,
  "platforms" : "String"
}'

响应示例

{
    "success": true
}

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

Body 参数application/json

cardTemplateId

string

必需

互动卡片的消息模板ID。企业内部应用，调用创建消息模板接口获取模板ID。第三方企业应用，调用创建消息模板接口获取模板ID。

outTrackId

string

必需

唯一标识一张卡片的外部ID，最大长度64。说明调用者自己定义的卡片唯一标识。需保存outTrackId，否则无法进行关闭互动卡片吊顶。一般情况下，如果使用了新的 cardTemplateId 或 cardData 等参数，则需要生成一个全新的 outTrackId，否则更改不会生效。

callbackRouteKey

string

可选

可控制卡片回调时的路由Key，用于指定特定的callbackUrl。企业内部应用，调用注册互动卡片回调地址接口获取参数callbackRouteKey。第三方企业应用，调用注册互动卡片回调地址接口获取参数callbackRouteKey。

cardData

object

卡片数据。

必需

cardParamMap

object

可选

卡片模板内容替换参数： - 普通文本类型：key为变量名，value为文本内容。 - 多媒体类型：key为变量名，value为媒体文件： - 企业内部应用，调用上传媒体文件接口的获取media_id参数值。 - 第三方企业应用，调用上传媒体文件接口的获取media_id参数值。说明 - 属性字段只支持 String 类型，非 String 类型的属性填写请参考文档：常见问题文档中“设置卡片数据时，如何处理非 String 类型的参数”小节。 - 务必确保属性值的类型与卡片搭建器中所配置的变量类型相匹配，否则可能出现属性不生效，或者在移动端无法显示等问题。

userIdPrivateDataMap

object

可选

卡片模板userId差异用户参数。 key：用户userId。 value：卡片数据。

key

object

必需

unionIdPrivateDataMap

object

可选

卡片模板unionId差异用户参数。 key：用户unionId。 value：卡片数据。

key

object

必需

cardSettings

object

卡片设置项。

可选

openConversationId

string

可选

会话id：群聊（此参数必传）：基于群模板创建的群。企业内部应用，调用创建群接口获取open_conversation_id参数值。第三方企业应用，调用创建群接口获取open_conversation_id参数值。安装群聊酷应用的群。企业内部应用，通过群内安装酷应用事件获取回调参数OpenConversationId参数值。单聊助手：不传入此参数。

conversationType

integer

必需

会话类型： 1：群聊 2：单聊助手

userId

string

可选

用户userId：当会话类型为单聊助手时，userId和unionId二选一必填。其他会话类型，不需要传入此参数。

unoinId

string

可选

用户unionId：当会话类型为单聊助手时，userId和unionId二选一必填。其他会话类型，不需要传入此参数。

robotCode

string

可选

机器人编码： - 单聊助手，此参数必填。 - 企业内部开发-机器人应用的AppKey值。

- 企业内部应用机器人。

- 第三方企业应用机器人

- 其他会话类型，不需要传入此参数

coolAppCode

string

可选

酷应用编码： - 群聊： - 基于群模板创建的群，不需要传入此参数。 - 安装群聊酷应用的群，必须传入此参数。

- 单聊助手：不需传入此参数。

groupTemplateId

string

可选

群模板id： - 群聊： - ·基于群模板创建的群，必须传入此参数。

- 安装群聊酷应用的群，不需要传入此参数。 - 其他会话类型不需传入此参数。

receiverUserIdList

array[string]

可选

吊顶可见者userId，最多可传100个userId：群聊：若不传入receiverUserIdList和receiverUnionIdList，则默认吊顶对会话内所有人可见。传入参数receiverUserIdList或receiverUnionIdList，则吊顶仅对对应用户可见。单聊助手：不需要传入此参数。

receiverUnionIdList

array[string]

可选

吊顶可见者unionId，最多可传100个unionId：群聊：若不传入receiverUserIdList和receiverUnionIdList，则默认吊顶对会话内所有人可见。传入参数receiverUserIdList或receiverUnionIdList，则吊顶仅对对应用户可见。单聊助手：不需要传入此参数。

platforms

string

可选

期望吊顶的端，如果有多个用“｜”分隔。例如：ios|mac|android|win表示iOS、MAC、安卓和windows端。

示例