互动消息卡片介绍 | Yach开放平台

# 互动消息卡片介绍

本文档介绍互动消息卡片的基本概念、功能特性与应用场景，帮助你快速上手互动消息卡片。

# 什么是互动消息卡片

互动消息是应用的一种能力，互动消息能够将结构化的内容以卡片形式嵌入至助手消息、聊天消息中，提升信息传递效率。用户可以在卡片上通过简单交互完成业务处理，让业务系统触手可及。目前只支持助手消息，点对点普通消息

# 功能特性

互动消息卡片能够结构化你的图文内容，并将其嵌入至业务协作场景中，同时可实现轻量交互等能力。

# 获取互动消息卡片的内容

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称	值
地址	/normal/message/sscard/info?access_token=ACCESS_TOKEN
请求方式	POST
参数	见【参数】
返回值	见【返回值】

# 参数

参数	参数类型	必须	说明
access_token	String	是	调用接口凭证
msg_id	String	是	发送消息的接口返回的消息id
to_id	String	是	接收者ID，接收人的用户ID或者接收群组的ID
conversation_type	int	是	会话类型，1为私聊，2为群聊（目前不支持）

返回值

{
  "code": 200,
  "msg": "",
  "obj": {
    "msg":"[{\"type\":\"select_person\",\"id\":\"select_person\",\"title\":{\"i18n\":{\"zh_cn\":\"\参\会\人\",\"en_us\":\"attendee\"}},\"placeholder_title\":{\"i18n\":{\"zh_cn\":\"\",\"en_us\":\"\"}},\"action_url\":\"https:\\/\\/xxxxx.com\\/\\/test\\/session\\/sscard\",\"limit\":50,\"required\":true,\"required_tips\":{\"i18n\":{\"zh_cn\":\"\请\选\择\参\会\人\",\"en_us\":\"please select attendee\"}},\"prompt_tips\":{\"i18n\":{\"zh_cn\":\"\",\"en_us\":\"\"}},\"default_person\":\"Yach111965,yach088408\",\"locked_person\":\"\"}]",
    "mod_time": 1713769182
  }
}

# 修改互动消息卡片的内容

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称	值
地址	/normal/message/sscard/update?access_token=ACCESS_TOKEN
请求方式	POST
参数	见【参数】
返回值	见【返回值】

# 参数

参数	参数类型	必须	说明
access_token	String	是	调用接口凭证
msg_id	String	是	发送消息的接口返回的消息id
to_id	String	是	接收者ID，接收人的用户ID或者接收群组的ID
conversation_type	int	是	会话类型，1为私聊，2为群聊（目前不支持）
message	String	是	消息格式参考：消息类型与数据格式只支持互动卡片(type=sscard)类型

返回值

{
  "code": 200,
  "msg": "",
  "obj": {
  }
}

← 消息类型与数据格式互动消息卡片组件 →