淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	描述
top_service_context	TopServiceContext	必须	请求体
└ biz_code String 必须 xxxxx api业务线编码
area_query_v_o	AreaQueryVo	可选	地域码表查询
└ campaign_id Number 可选 68796878069 计划id,计划已经存在场景必填,eg:添加主体、编辑计划状态等场景

名称	类型	示例值	描述
result	TopResult		结果体
info TopInfo 请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 area_group_v_o AreaGroupVo 结果集 letter_groups BigAreaVo [] 字母开头的 └ name String 测试名称 └ id String 471 id provinces AreaVo [] 地域集合 └ name String 测试名称 └ id Number 357 id cities AreaVo [] 城市集合 └ name String 测试名称 └ id Number 357 id provinces AreaVo [] 省集合 └ name String 测试名称 └ id Number 357 id location_groups BigAreaVo [] 地理大区开头的 └ name String 测试名称 └ id String 471 id provinces AreaVo [] 地域集合 └ name String 测试名称 └ id Number 357 id cities AreaVo [] 城市集合 └ name String 测试名称 └ id Number 357 id provinces AreaVo [] 省集合 └ name String 测试名称 └ id Number 357 id last_provinces AreaVo [] 非常用地域 └ name String 测试名称 └ id Number 357 id cities AreaVo [] 城市集合 └ name String 测试名称 └ id Number 357 id provinces AreaVo [] 省集合 └ name String 测试名称 └ id Number 357 id overseas AreaVo [] 海外 └ name String 测试名称 └ id Number 357 id cities AreaVo [] 城市集合 └ name String 测试名称 └ id Number 357 id provinces AreaVo [] 省集合 └ name String 测试名称 └ id Number 357 id

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpCommonapiGetcodeconfigRequest req = new UniversalbpCommonapiGetcodeconfigRequest();
UniversalbpCommonapiGetcodeconfigRequest.TopServiceContext obj1 = new UniversalbpCommonapiGetcodeconfigRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpCommonapiGetcodeconfigRequest.AreaQueryVo obj2 = new UniversalbpCommonapiGetcodeconfigRequest.AreaQueryVo();
obj2.setCampaignId(68796878069L);
req.setAreaQueryVO(obj2);
UniversalbpCommonapiGetcodeconfigResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpCommonapiGetcodeconfigRequest req = new UniversalbpCommonapiGetcodeconfigRequest();
UniversalbpCommonapiGetcodeconfigRequest.TopServiceContextDomain obj1 = new UniversalbpCommonapiGetcodeconfigRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
req.TopServiceContext_ = obj1;
UniversalbpCommonapiGetcodeconfigRequest.AreaQueryVoDomain obj2 = new UniversalbpCommonapiGetcodeconfigRequest.AreaQueryVoDomain();
obj2.CampaignId = 68796878069L;
req.AreaQueryVO_ = obj2;
UniversalbpCommonapiGetcodeconfigResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpCommonapiGetcodeconfigRequest;
$top_service_context = new TopServiceContext;
$top_service_context->biz_code="xxxxx";
$req->setTopServiceContext(json_encode($top_service_context));
$area_query_v_o = new AreaQueryVo;
$area_query_v_o->campaign_id="68796878069";
$req->setAreaQueryVO(json_encode($area_query_v_o));
$resp = $c->execute($req, $sessionKey);

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=taobao.universalbp.commonapi.getcodeconfig' \
-d 'partner_id=apidoc' \
-d 'session=94dc8e2a-7951-477b-9744-3a242de1b9a4' \
-d 'sign=DD3FEAFA982DB1F2D46E34945ECF20E0' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A32%3A30' \
-d 'v=2.0' \
-d 'area_query_v_o=null' \
-d 'top_service_context=null'

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

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

req.top_service_context=""
req.area_query_v_o=""
try:
	resp= req.getResponse(sessionkey)
	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,"taobao.universalbp.commonapi.getcodeconfig");
add_param(pRequest,"top_service_context","数据结构JSON示例");
add_param(pRequest,"area_query_v_o","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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('taobao.universalbp.commonapi.getcodeconfig', {
	'top_service_context':'数据结构JSON示例',
	'area_query_v_o':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<universalbp_commonapi_getcodeconfig_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <area_group_v_o>
            <letter_groups>
                <big_area_vo>
                    <name>测试</name>
                    <id>471</id>
                    <provinces>
                        <area_vo>
                            <name>测试</name>
                            <id>357</id>
                            <cities>
                                <area_vo>
                                    <name>测试</name>
                                    <id>357</id>
                                </area_vo>
                            </cities>
                            <provinces>
                                <area_vo>
                                    <name>测试</name>
                                    <id>357</id>
                                </area_vo>
                            </provinces>
                        </area_vo>
                    </provinces>
                </big_area_vo>
            </letter_groups>
            <location_groups>
                <big_area_vo>
                    <name>测试</name>
                    <id>471</id>
                    <provinces>
                        <area_vo>
                            <name>测试</name>
                            <id>357</id>
                            <cities>
                                <area_vo>
                                    <name>测试</name>
                                    <id>357</id>
                                </area_vo>
                            </cities>
                            <provinces>
                                <area_vo>
                                    <name>测试</name>
                                    <id>357</id>
                                </area_vo>
                            </provinces>
                        </area_vo>
                    </provinces>
                </big_area_vo>
            </location_groups>
            <last_provinces>
                <area_vo>
                    <name>测试</name>
                    <id>357</id>
                    <cities>
                        <area_vo>
                            <name>测试</name>
                            <id>357</id>
                        </area_vo>
                    </cities>
                    <provinces>
                        <area_vo>
                            <name>测试</name>
                            <id>357</id>
                        </area_vo>
                    </provinces>
                </area_vo>
            </last_provinces>
            <overseas>
                <area_vo>
                    <name>测试</name>
                    <id>357</id>
                    <cities>
                        <area_vo>
                            <name>测试</name>
                            <id>357</id>
                        </area_vo>
                    </cities>
                    <provinces>
                        <area_vo>
                            <name>测试</name>
                            <id>357</id>
                        </area_vo>
                    </provinces>
                </area_vo>
            </overseas>
        </area_group_v_o>
    </result>
</universalbp_commonapi_getcodeconfig_response>

{
    "universalbp_commonapi_getcodeconfig_response":{
        "result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "area_group_v_o":{
                "letter_groups":{
                    "big_area_vo":[
                        {
                            "name":"测试",
                            "id":"471",
                            "provinces":{
                                "area_vo":[
                                    {
                                        "name":"测试",
                                        "id":357,
                                        "cities":{
                                            "area_vo":[
                                                {
                                                    "name":"测试",
                                                    "id":357
                                                }
                                            ]
                                        },
                                        "provinces":{
                                            "area_vo":[
                                                {
                                                    "name":"测试",
                                                    "id":357
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        }
                    ]
                },
                "location_groups":{
                    "big_area_vo":[
                        {
                            "name":"测试",
                            "id":"471",
                            "provinces":{
                                "area_vo":[
                                    {
                                        "name":"测试",
                                        "id":357,
                                        "cities":{
                                            "area_vo":[
                                                {
                                                    "name":"测试",
                                                    "id":357
                                                }
                                            ]
                                        },
                                        "provinces":{
                                            "area_vo":[
                                                {
                                                    "name":"测试",
                                                    "id":357
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        }
                    ]
                },
                "last_provinces":{
                    "area_vo":[
                        {
                            "name":"测试",
                            "id":357,
                            "cities":{
                                "area_vo":[
                                    {
                                        "name":"测试",
                                        "id":357
                                    }
                                ]
                            },
                            "provinces":{
                                "area_vo":[
                                    {
                                        "name":"测试",
                                        "id":357
                                    }
                                ]
                            }
                        }
                    ]
                },
                "overseas":{
                    "area_vo":[
                        {
                            "name":"测试",
                            "id":357,
                            "cities":{
                                "area_vo":[
                                    {
                                        "name":"测试",
                                        "id":357
                                    }
                                ]
                            },
                            "provinces":{
                                "area_vo":[
                                    {
                                        "name":"测试",
                                        "id":357
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        }
    }
}

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

taobao.universalbp.commonapi.getcodeconfig (查询地域码表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ