阿里安全开放平台-阿里聚安全

请求地址：

环境	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。

名称	类型	是否必须	示例值	描述
file_info	NodeDTO	必须		文件信息
└ file_name String 必须 test.mp4 文件全名 └ file_size Number 必须 7546310 文件大小(B) └ material_type String 必须 mp4 文件自定义类型 └ md5 String 必须 4a97dfe2e74071fe997a05e44db92e12 文件的 md5 值
scene_dto	SceneDTO	必须		上传的基本逻辑信息封装，当前用户id 和类型必须制定，这个必须要有
└ scene_type Number 必须 1 场景类型 └ from_account_id String 必须 111 发送人阿里账号ID └ to_account_id String 必须 222 接收人阿里账号ID └ id_type Number 必须 3 ID类型，[账号ID:3]
params	String	必须	{"source":"","needCardUrl":true}	额外字段，如果有特殊需求，用于填入特殊字段内容

名称	类型	示例值	描述
result	ApiResult		返回结果
└ success Boolean true 成功标识 └ code Number 200 错误码 └ msg Number 系统错误错误信息 └ ext_msg String {"code":100,"msg":"系统错误"} 扩展错误信息 data NodeDTO 结果数据 └ id Number 2395872215 文件ID └ parent_id Number 1410129110 父级ID └ gmt_create String 2024-03-19 23:15:46 创建时间 └ gmt_modified String 2024-03-19 23:15:46 修改时间 └ gmt_modified_long Number 1710915346000 修改时间戳 └ node_name String 卡比.jpg 文件名 └ node_size Number 98142 文件大小 └ node_type String file 文件分类 └ material_type String jpg 文件类型 └ bucket String hz-icbuim-file 文件桶 └ md5 String 39de172192ac999928cb7281a002b07b MD5 └ oss_key String file/39de172192ac999928cb7281a002b07b.jpg 文件OSS地址 └ thumbnail_url String https://clouddisk.alibaba.com/file/videoThumb.htm?appkey=OneChat&id=2395872215&parentId=1410129110&secOperateAliId=MC1IDX1PdpBbUR4ZAdxk7EoU5xolGUK0AvxyRHINIaffaPTN9ys-tFJfkgK3hqTdUIn9Bsn&scene=1 缩略图地址 └ redirect_file_url String https://clouddisk.alibaba.com/file/redirectFileUrl.htm?appkey=OneChat&id=2395872215&parentId=1410129110&secOperateAliId=MC1IDX1antcSTkb4vXpGol-w4lniwSuaJyPVfJl2I9X2ama_xpUGdBRwbj4GnoToC5WXknk&fileAction=imagePreview&scene=1 重定向地址 └ file_card_url String https://workspace.alibaba.com/card?type=13&from=cn1531680279gldp&to=cn1530216743exhd&picWidth=1080&picHeight=1036&extensionType=jpg&id=2395872215&orgSize=1080x1036&version=1&parentId=1410129110&md5=39de172192ac999928cb7281a002b07b&ctime=1710915346808&sign=9E49FA7B2F4905024DFE06992DC150DFACE0877E 文件卡片地址 └ source String hz 来源 └ view_status Number 0 查看状态 extend JSONObject 扩展 └ private_chat_name String OneChat\|2207670947568\|2207975307058 私聊名称 └ creator Number 2207975307058 私聊创建者ID └ gmt_create_long Number 1710915346000 创建时间戳

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaInteractionImAssistantFileSendRequest req = new AlibabaInteractionImAssistantFileSendRequest();
AlibabaInteractionImAssistantFileSendRequest.NodeDTO obj1 = new AlibabaInteractionImAssistantFileSendRequest.NodeDTO();
obj1.setFileName("test.mp4");
obj1.setFileSize(7546310L);
obj1.setMaterialType("mp4");
obj1.setMd5("4a97dfe2e74071fe997a05e44db92e12");
req.setFileInfo(obj1);
AlibabaInteractionImAssistantFileSendRequest.SceneDTO obj2 = new AlibabaInteractionImAssistantFileSendRequest.SceneDTO();
obj2.setSceneType(1L);
obj2.setFromAccountId("111");
obj2.setToAccountId("222");
obj2.setIdType(3L);
req.setSceneDto(obj2);
req.setParams("{\"source\":\"\",\"needCardUrl\":true}");
AlibabaInteractionImAssistantFileSendResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaInteractionImAssistantFileSendRequest req = new AlibabaInteractionImAssistantFileSendRequest();
AlibabaInteractionImAssistantFileSendRequest.NodeDTODomain obj1 = new AlibabaInteractionImAssistantFileSendRequest.NodeDTODomain();
obj1.FileName = "test.mp4";
obj1.FileSize = 7546310L;
obj1.MaterialType = "mp4";
obj1.Md5 = "4a97dfe2e74071fe997a05e44db92e12";
req.FileInfo_ = obj1;
AlibabaInteractionImAssistantFileSendRequest.SceneDTODomain obj2 = new AlibabaInteractionImAssistantFileSendRequest.SceneDTODomain();
obj2.SceneType = 1L;
obj2.FromAccountId = "111";
obj2.ToAccountId = "222";
obj2.IdType = 3L;
req.SceneDto_ = obj2;
req.Params = "{\"source\":\"\",\"needCardUrl\":true}";
AlibabaInteractionImAssistantFileSendResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaInteractionImAssistantFileSendRequest;
$file_info = new NodeDTO;
$file_info->file_name="test.mp4";
$file_info->file_size="7546310";
$file_info->material_type="mp4";
$file_info->md5="4a97dfe2e74071fe997a05e44db92e12";
$req->setFileInfo(json_encode($file_info));
$scene_dto = new SceneDTO;
$scene_dto->scene_type="1";
$scene_dto->from_account_id="111";
$scene_dto->to_account_id="222";
$scene_dto->id_type="3";
$req->setSceneDto(json_encode($scene_dto));
$req->setParams("{\"source\":\"\",\"needCardUrl\":true}");
$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.interaction.im.assistant.file.send' \
-d 'partner_id=apidoc' \
-d 'sign=838DEFBF9C3186EE5BCA366E2138ABBA' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-19+06%3A00%3A27' \
-d 'v=2.0' \
-d 'file_info=null' \
-d 'params=%7B%5C%22source%5C%22%3A%5C%22%5C%22%2C%5C%22needCardUrl%5C%22%3Atrue%7D' \
-d 'scene_dto=null'

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

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

req.file_info="数据结构示例JSON格式"
req.scene_dto="数据结构示例JSON格式"
req.params="{\"source\":\"\",\"needCardUrl\":true}"
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.interaction.im.assistant.file.send");
add_param(pRequest,"file_info","数据结构JSON示例");
add_param(pRequest,"scene_dto","数据结构JSON示例");
add_param(pRequest,"params","{\"source\":\"\",\"needCardUrl\":true}");
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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.interaction.im.assistant.file.send', {
	'file_info':'数据结构JSON示例',
	'scene_dto':'数据结构JSON示例',
	'params':'{\"source\":\"\",\"needCardUrl\":true}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_interaction_im_assistant_file_send_response>
    <result>
        <success>true</success>
        <code>200</code>
        <msg>系统错误</msg>
        <ext_msg>{&quot;code&quot;:100,&quot;msg&quot;:&quot;系统错误&quot;}</ext_msg>
        <data>
            <id>2395872215</id>
            <parent_id>1410129110</parent_id>
            <gmt_create>2024-03-19 23:15:46</gmt_create>
            <gmt_modified>2024-03-19 23:15:46</gmt_modified>
            <gmt_modified_long>1710915346000</gmt_modified_long>
            <node_name>卡比.jpg</node_name>
            <node_size>98142</node_size>
            <node_type>file</node_type>
            <material_type>jpg</material_type>
            <bucket>hz-icbuim-file</bucket>
            <md5>39de172192ac999928cb7281a002b07b</md5>
            <oss_key>file/39de172192ac999928cb7281a002b07b.jpg</oss_key>
            <thumbnail_url>https://clouddisk.alibaba.com/file/videoThumb.htm?appkey=OneChat&amp;id=2395872215&amp;parentId=1410129110&amp;secOperateAliId=MC1IDX1PdpBbUR4ZAdxk7EoU5xolGUK0AvxyRHINIaffaPTN9ys-tFJfkgK3hqTdUIn9Bsn&amp;scene=1</thumbnail_url>
            <redirect_file_url>https://clouddisk.alibaba.com/file/redirectFileUrl.htm?appkey=OneChat&amp;id=2395872215&amp;parentId=1410129110&amp;secOperateAliId=MC1IDX1antcSTkb4vXpGol-w4lniwSuaJyPVfJl2I9X2ama_xpUGdBRwbj4GnoToC5WXknk&amp;fileAction=imagePreview&amp;scene=1</redirect_file_url>
            <file_card_url>https://workspace.alibaba.com/card?type=13&amp;from=cn1531680279gldp&amp;to=cn1530216743exhd&amp;picWidth=1080&amp;picHeight=1036&amp;extensionType=jpg&amp;id=2395872215&amp;orgSize=1080x1036&amp;version=1&amp;parentId=1410129110&amp;md5=39de172192ac999928cb7281a002b07b&amp;ctime=1710915346808&amp;sign=9E49FA7B2F4905024DFE06992DC150DFACE0877E</file_card_url>
            <source>hz</source>
            <view_status>0</view_status>
            <extend>
                <private_chat_name>OneChat|2207670947568|2207975307058</private_chat_name>
                <creator>2207975307058</creator>
            </extend>
            <gmt_create_long>1710915346000</gmt_create_long>
        </data>
    </result>
</alibaba_interaction_im_assistant_file_send_response>

{
    "alibaba_interaction_im_assistant_file_send_response":{
        "result":{
            "success":true,
            "code":200,
            "msg":系统错误,
            "ext_msg":"{\"code\":100,\"msg\":\"系统错误\"}",
            "data":{
                "id":2395872215,
                "parent_id":1410129110,
                "gmt_create":"2024-03-19 23:15:46",
                "gmt_modified":"2024-03-19 23:15:46",
                "gmt_modified_long":1710915346000,
                "node_name":"卡比.jpg",
                "node_size":98142,
                "node_type":"file",
                "material_type":"jpg",
                "bucket":"hz-icbuim-file",
                "md5":"39de172192ac999928cb7281a002b07b",
                "oss_key":"file\/39de172192ac999928cb7281a002b07b.jpg",
                "thumbnail_url":"https:\/\/clouddisk.alibaba.com\/file\/videoThumb.htm?appkey=OneChat&id=2395872215&parentId=1410129110&secOperateAliId=MC1IDX1PdpBbUR4ZAdxk7EoU5xolGUK0AvxyRHINIaffaPTN9ys-tFJfkgK3hqTdUIn9Bsn&scene=1",
                "redirect_file_url":"https:\/\/clouddisk.alibaba.com\/file\/redirectFileUrl.htm?appkey=OneChat&id=2395872215&parentId=1410129110&secOperateAliId=MC1IDX1antcSTkb4vXpGol-w4lniwSuaJyPVfJl2I9X2ama_xpUGdBRwbj4GnoToC5WXknk&fileAction=imagePreview&scene=1",
                "file_card_url":"https:\/\/workspace.alibaba.com\/card?type=13&from=cn1531680279gldp&to=cn1530216743exhd&picWidth=1080&picHeight=1036&extensionType=jpg&id=2395872215&orgSize=1080x1036&version=1&parentId=1410129110&md5=39de172192ac999928cb7281a002b07b&ctime=1710915346808&sign=9E49FA7B2F4905024DFE06992DC150DFACE0877E",
                "source":"hz",
                "view_status":0,
                "extend":{
                    "private_chat_name":"OneChat|2207670947568|2207975307058",
                    "creator":2207975307058
                },
                "gmt_create_long":1710915346000
            }
        }
    }
}

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下载

OKKI&TM

alibaba.interaction.im.assistant.file.send (阿里卖家APP插件销售助手发送文件)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈