淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
deliver_msg_card_param	AllInOneConversationCardMsgTopApiSendReqDTO	必须			一通会话卡片消息发送请求
└ biz_id String 可选 BIZ202609240001 业务单号 └ biz_type String 可选 xxx 业务类型 └ order_no Number 可选 123456 三方会话订单号（已废弃） card_msg_data AllInOneConversationCardMsgTopApiDataDTO 必须卡片数据 └ card_template_id Number 必须 1001 卡片模板ID └ card_data_json String 可选 {"text":"xxx"} 卡片内容 └ extension_json String 可选 {} 卡片级扩展 └ extension_json String 可选 {} 消息级扩展 └ send_scene String 可选 xxx 发送场景

名称	类型	示例值	描述
result	ResultDTO		返回结果
result AllInOneConversationCardMsgSendResDTO 卡片消息发送结果 └ app_conid String xxx 会话ID └ im_paas_message_id String xxx IM PASS消息ID └ create_time Number 1727145600000 创建时间 └ sub_code_alias String sub_code_alias 子错误码 └ success_alias Boolean true 是否成功 └ sub_extra_err_msg String sub_extra_err_msg 子错误描述 └ state_code String state_code 错误码 └ extra_err_msg String extra_err_msg 错误详细描述

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaJymImserverConversationAllinoneDelivermsgcardRequest req = new AlibabaJymImserverConversationAllinoneDelivermsgcardRequest();
AlibabaJymImserverConversationAllinoneDelivermsgcardRequest.AllInOneConversationCardMsgTopApiSendReqDTO obj1 = new AlibabaJymImserverConversationAllinoneDelivermsgcardRequest.AllInOneConversationCardMsgTopApiSendReqDTO();
obj1.setBizId("BIZ202609240001");
obj1.setBizType("xxx");
obj1.setOrderNo(123456L);
AlibabaJymImserverConversationAllinoneDelivermsgcardRequest.AllInOneConversationCardMsgTopApiDataDTO obj2 = new AlibabaJymImserverConversationAllinoneDelivermsgcardRequest.AllInOneConversationCardMsgTopApiDataDTO();
obj2.setCardTemplateId(1001L);
obj2.setCardDataJson("{\"text\":\"xxx\"}");
obj2.setExtensionJson("{}");
obj1.setCardMsgData(obj2);
obj1.setExtensionJson("{}");
obj1.setSendScene("xxx");
req.setDeliverMsgCardParam(obj1);
AlibabaJymImserverConversationAllinoneDelivermsgcardResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaJymImserverConversationAllinoneDelivermsgcardRequest req = new AlibabaJymImserverConversationAllinoneDelivermsgcardRequest();
AlibabaJymImserverConversationAllinoneDelivermsgcardRequest.AllInOneConversationCardMsgTopApiSendReqDTODomain obj1 = new AlibabaJymImserverConversationAllinoneDelivermsgcardRequest.AllInOneConversationCardMsgTopApiSendReqDTODomain();
obj1.BizId = "BIZ202609240001";
obj1.BizType = "xxx";
obj1.OrderNo = 123456L;
AlibabaJymImserverConversationAllinoneDelivermsgcardRequest.AllInOneConversationCardMsgTopApiDataDTODomain obj2 = new AlibabaJymImserverConversationAllinoneDelivermsgcardRequest.AllInOneConversationCardMsgTopApiDataDTODomain();
obj2.CardTemplateId = 1001L;
obj2.CardDataJson = "{\"text\":\"xxx\"}";
obj2.ExtensionJson = "{}";
obj1.CardMsgData= obj2;
obj1.ExtensionJson = "{}";
obj1.SendScene = "xxx";
req.DeliverMsgCardParam_ = obj1;
AlibabaJymImserverConversationAllinoneDelivermsgcardResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaJymImserverConversationAllinoneDelivermsgcardRequest;
$deliver_msg_card_param = new AllInOneConversationCardMsgTopApiSendReqDTO;
$deliver_msg_card_param->biz_id="BIZ202609240001";
$deliver_msg_card_param->biz_type="xxx";
$deliver_msg_card_param->order_no="123456";
$card_msg_data = new AllInOneConversationCardMsgTopApiDataDTO;
$card_msg_data->card_template_id="1001";
$card_msg_data->card_data_json="{\"text\":\"xxx\"}";
$card_msg_data->extension_json="{}";
$deliver_msg_card_param->card_msg_data = $card_msg_data;
$deliver_msg_card_param->extension_json="{}";
$deliver_msg_card_param->send_scene="xxx";
$req->setDeliverMsgCardParam(json_encode($deliver_msg_card_param));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.jym.imserver.conversation.allinone.delivermsgcard' \
-d 'partner_id=apidoc' \
-d 'sign=6DD955D5A5AB6D462A229F99B334BC95' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-09-25+21%3A37%3A56' \
-d 'v=2.0' \
-d 'deliver_msg_card_param=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaJymImserverConversationAllinoneDelivermsgcardRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.deliver_msg_card_param="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.jym.imserver.conversation.allinone.delivermsgcard");
add_param(pRequest,"deliver_msg_card_param","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.jym.imserver.conversation.allinone.delivermsgcard', {
	'deliver_msg_card_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_jym_imserver_conversation_allinone_delivermsgcard_response>
    <result>
        <result>
            <app_conid>xxx</app_conid>
            <im_paas_message_id>xxx</im_paas_message_id>
            <create_time>1727145600000</create_time>
        </result>
        <sub_code_alias>sub_code_alias</sub_code_alias>
        <success_alias>true</success_alias>
        <sub_extra_err_msg>sub_extra_err_msg</sub_extra_err_msg>
        <state_code>state_code</state_code>
        <extra_err_msg>extra_err_msg</extra_err_msg>
    </result>
</alibaba_jym_imserver_conversation_allinone_delivermsgcard_response>

{
    "alibaba_jym_imserver_conversation_allinone_delivermsgcard_response":{
        "result":{
            "result":{
                "app_conid":"xxx",
                "im_paas_message_id":"xxx",
                "create_time":1727145600000
            },
            "sub_code_alias":"sub_code_alias",
            "success_alias":true,
            "sub_extra_err_msg":"sub_extra_err_msg",
            "state_code":"state_code",
            "extra_err_msg":"extra_err_msg"
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

交易猫API

alibaba.jym.imserver.conversation.allinone.delivermsgcard (一通会话卡片消息发送)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ