阿里大于 -

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述

名称	类型	示例值	描述
result	ResultTo		result
└ error_message String demo errorMessage module CustomServicePlatformUserDo false module └ auto_task Number 1 autoQuest └ gmt_create Date 20170403 gmtCreate └ gmt_modified Date 20170403 gmtModified └ id Number 123 id └ main_account_id Number 123123 主账号id └ main_account_nick String 123123 主账号nick └ mobile_version Number 11 移动端版本 └ quality_check Number 1 质检是否开启 └ realtime_alarm Number 1 实时告警业务 └ realtime_monitor Number 1 实时监控业务 └ hotword Number 1 热词 └ bad_reception Number 1 不良接待 └ alphax_config Number 0 店小秘全自动 └ alphax_solution Number 0 店小秘知识库 └ sampling Number 1 抽检 └ subscribe Number 1 订阅客户管理 └ buyer_record Number 1 买家流水 └ offline_data Number 1 全店服务数据 └ one_on_one_video Number 1 1v1视频 └ success Boolean false success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
QianniuCustomserviceWhitelistRequest req = new QianniuCustomserviceWhitelistRequest();
QianniuCustomserviceWhitelistResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
QianniuCustomserviceWhitelistRequest req = new QianniuCustomserviceWhitelistRequest();
QianniuCustomserviceWhitelistResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QianniuCustomserviceWhitelistRequest;
$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.qianniu.customservice.whitelist' \
-d 'partner_id=apidoc' \
-d 'session=56eecf40-3e0e-431e-a508-cf46285e2054' \
-d 'sign=B4ADFF12801934C7E603D6CD2143A5BF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-08+03%3A09%3A31' \
-d 'v=2.0'

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

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

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.qianniu.customservice.whitelist");
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.qianniu.customservice.whitelist' {
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<qianniu_customservice_whitelist_response>
    <result>
        <error_message>demo</error_message>
        <module>
            <auto_task>1</auto_task>
            <gmt_create>20170403</gmt_create>
            <gmt_modified>20170403</gmt_modified>
            <id>123</id>
            <main_account_id>123123</main_account_id>
            <main_account_nick>123123</main_account_nick>
            <mobile_version>11</mobile_version>
            <quality_check>1</quality_check>
            <realtime_alarm>1</realtime_alarm>
            <realtime_monitor>1</realtime_monitor>
            <hotword>1</hotword>
            <bad_reception>1</bad_reception>
            <alphax_config>0</alphax_config>
            <alphax_solution>0</alphax_solution>
            <sampling>1</sampling>
            <subscribe>1</subscribe>
            <buyer_record>1</buyer_record>
            <offline_data>1</offline_data>
            <one_on_one_video>1</one_on_one_video>
        </module>
        <success>false</success>
    </result>
</qianniu_customservice_whitelist_response>

{
    "qianniu_customservice_whitelist_response":{
        "result":{
            "error_message":"demo",
            "module":{
                "auto_task":1,
                "gmt_create":"20170403",
                "gmt_modified":"20170403",
                "id":123,
                "main_account_id":123123,
                "main_account_nick":"123123",
                "mobile_version":11,
                "quality_check":1,
                "realtime_alarm":1,
                "realtime_monitor":1,
                "hotword":1,
                "bad_reception":1,
                "alphax_config":0,
                "alphax_solution":0,
                "sampling":1,
                "subscribe":1,
                "buyer_record":1,
                "offline_data":1,
                "one_on_one_video":1
            },
            "success":false
        }
    }
}

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

千牛接口

taobao.qianniu.customservice.whitelist (客服主管插件白名单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ