淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
rpc_context	Json	可选	{}	RpcContext
common_whitelist_d_t_o	CommonWhitelistDto	可选		commonWhitelistDTO
└ white_name String 可选 xxxxx 白名单名称 └ external_whitelist_id String 可选 xxxxx 外部平台白名单Id detail_d_t_o_s WhitelistDetailDto [] 可选白名单明细列表 └ url_type String 可选 xxxxx 链接类型 └ account_url String 可选 xxxxx 账号链接 └ publish_account_id String 可选 xxxxx 发布人Id └ publish_account_name String 可选 xxxxx 发布人名称 └ cooperate_start_time Date 可选 2000-01-01 00:00:00 合作开始时间 └ cooperate_end_time Date 可选 2000-01-01 00:00:00 合作结束时间 └ platform_code String 可选 xxxxx 平台名称code └ external_whitelist_detail_id String 可选 xxxxx 外部平台白名单明细Id └ operate_type String 可选 xxxxx 操作

名称	类型	示例值	描述
lvms_result_d_t_o	LvmsResultDto		lvmsResultDTO
└ count Number 10 返回数量 └ success Boolean false 是否成功 └ code String xxxxx 操作编码 └ message String xxxxx 错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaLvmsCopyrightPushcommonwhitelistRequest req = new AlibabaLvmsCopyrightPushcommonwhitelistRequest();
req.setRpcContextString("{}");
AlibabaLvmsCopyrightPushcommonwhitelistRequest.CommonWhitelistDto obj1 = new AlibabaLvmsCopyrightPushcommonwhitelistRequest.CommonWhitelistDto();
obj1.setWhiteName("xxxxx");
obj1.setExternalWhitelistId("xxxxx");
List<AlibabaLvmsCopyrightPushcommonwhitelistRequest.WhitelistDetailDto> list3 = new ArrayList<AlibabaLvmsCopyrightPushcommonwhitelistRequest.WhitelistDetailDto>();
AlibabaLvmsCopyrightPushcommonwhitelistRequest.WhitelistDetailDto obj4 = new AlibabaLvmsCopyrightPushcommonwhitelistRequest.WhitelistDetailDto();
list3.add(obj4);
obj4.setUrlType("xxxxx");
obj4.setAccountUrl("xxxxx");
obj4.setPublishAccountId("xxxxx");
obj4.setPublishAccountName("xxxxx");
obj4.setCooperateStartTime(StringUtils.parseDateTime("2000-01-01 00:00:00"));
obj4.setCooperateEndTime(StringUtils.parseDateTime("2000-01-01 00:00:00"));
obj4.setPlatformCode("xxxxx");
obj4.setExternalWhitelistDetailId("xxxxx");
obj4.setOperateType("xxxxx");
obj1.setDetailDTOS(list3);
req.setCommonWhitelistDTO(obj1);
AlibabaLvmsCopyrightPushcommonwhitelistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaLvmsCopyrightPushcommonwhitelistRequest req = new AlibabaLvmsCopyrightPushcommonwhitelistRequest();
req.RpcContext = "{}";
AlibabaLvmsCopyrightPushcommonwhitelistRequest.CommonWhitelistDtoDomain obj1 = new AlibabaLvmsCopyrightPushcommonwhitelistRequest.CommonWhitelistDtoDomain();
obj1.WhiteName = "xxxxx";
obj1.ExternalWhitelistId = "xxxxx";
List<AlibabaLvmsCopyrightPushcommonwhitelistRequest.WhitelistDetailDtoDomain> list3 = new List<AlibabaLvmsCopyrightPushcommonwhitelistRequest.WhitelistDetailDtoDomain>();
AlibabaLvmsCopyrightPushcommonwhitelistRequest.WhitelistDetailDtoDomain obj4 = new AlibabaLvmsCopyrightPushcommonwhitelistRequest.WhitelistDetailDtoDomain();
list3.Add(obj4);
obj4.UrlType = "xxxxx";
obj4.AccountUrl = "xxxxx";
obj4.PublishAccountId = "xxxxx";
obj4.PublishAccountName = "xxxxx";
obj4.CooperateStartTime = DateTime.Parse(2000-01-01 00:00:00");
obj4.CooperateEndTime = DateTime.Parse(2000-01-01 00:00:00");
obj4.PlatformCode = "xxxxx";
obj4.ExternalWhitelistDetailId = "xxxxx";
obj4.OperateType = "xxxxx";
obj1.DetailDTOS= list3;
req.CommonWhitelistDTO_ = obj1;
AlibabaLvmsCopyrightPushcommonwhitelistResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaLvmsCopyrightPushcommonwhitelistRequest;
$req->setRpcContext("{}");
$common_whitelist_d_t_o = new CommonWhitelistDto;
$common_whitelist_d_t_o->white_name="xxxxx";
$common_whitelist_d_t_o->external_whitelist_id="xxxxx";
$detail_d_t_o_s = new WhitelistDetailDto;
$detail_d_t_o_s->url_type="xxxxx";
$detail_d_t_o_s->account_url="xxxxx";
$detail_d_t_o_s->publish_account_id="xxxxx";
$detail_d_t_o_s->publish_account_name="xxxxx";
$detail_d_t_o_s->cooperate_start_time="2000-01-01 00:00:00";
$detail_d_t_o_s->cooperate_end_time="2000-01-01 00:00:00";
$detail_d_t_o_s->platform_code="xxxxx";
$detail_d_t_o_s->external_whitelist_detail_id="xxxxx";
$detail_d_t_o_s->operate_type="xxxxx";
$common_whitelist_d_t_o->detail_d_t_o_s = $detail_d_t_o_s;
$req->setCommonWhitelistDTO(json_encode($common_whitelist_d_t_o));
$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.lvms.copyright.pushcommonwhitelist' \
-d 'partner_id=apidoc' \
-d 'sign=C27D0AD7C3A2698D314FF08C7AEAA033' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-14+20%3A03%3A15' \
-d 'v=2.0' \
-d 'common_whitelist_d_t_o=null' \
-d 'rpc_context=%7B%7D'

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

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

req.rpc_context="{}"
req.common_whitelist_d_t_o=""
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.lvms.copyright.pushcommonwhitelist");
add_param(pRequest,"rpc_context","{}");
add_param(pRequest,"common_whitelist_d_t_o","数据结构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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.lvms.copyright.pushcommonwhitelist', {
	'rpc_context':'{}',
	'common_whitelist_d_t_o':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_lvms_copyright_pushcommonwhitelist_response>
    <lvms_result_d_t_o>
        <count>10</count>
        <success>false</success>
        <code>xxxxx</code>
        <message>xxxxx</message>
    </lvms_result_d_t_o>
</alibaba_lvms_copyright_pushcommonwhitelist_response>

{
    "alibaba_lvms_copyright_pushcommonwhitelist_response":{
        "lvms_result_d_t_o":{
            "count":10,
            "success":false,
            "code":"xxxxx",
            "message":"xxxxx"
        }
    }
}

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.lvms.copyright.pushcommonwhitelist (同步通用白名单信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ