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

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
user_nick	String	必须	mmp_004		用户Nick

名称	类型	示例值	描述
results	GroupAccountInfoDO []		分流分组信息
└ id Number 150000418 分组自增id └ group_name String 客服中心分组名称 accounts DispatchAccount [] 子账号列表 └ dispatch_status Number 123 分流状态 └ weight Number 123 权重 └ account_id Number 123 账号ID，USER ID └ account_nick String demo 账号nick └ account_status Number 123 账号状态 └ dispatch Boolean false 是否分流 └ user_id Number 3649080808 主账号id └ online_user_numbers_in_group Number 5 组内的在线人数（包含挂起和非挂起） account_status_list AccountBaseStatusDo [] 组内的在线账号状态，不包含不在线的 └ main_account_id Number 123 主账号ID └ account_id Number 456 账号ID └ nick String mmp_004 用户昵称 └ qn_mobile_app_version String iPhone OS_5.3.0 千牛移动端app版本 └ pc_client_online_status Number 1 PC在线状态 └ pc_client_extend_status Number 1 PC扩展状态 └ client_suspend_status Number 1 挂起状态 └ online Boolean false 是否在线 └ wx_sdk_version String 3.0.4_IPHONE_TMS 旺信SDK版本 └ pc_online Boolean false pc是否在线 └ mobile_client_online_status Number 1 移动端是否在线 └ suspend Boolean true suspend └ qn_pc_app_version String 3.10.01N qnPcAppVersion └ mobile_online Boolean false 移动端是否在线

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
QianniuCloudkefuDispatchgroupsGetRequest req = new QianniuCloudkefuDispatchgroupsGetRequest();
req.setUserNick("mmp_004");
QianniuCloudkefuDispatchgroupsGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
QianniuCloudkefuDispatchgroupsGetRequest req = new QianniuCloudkefuDispatchgroupsGetRequest();
req.UserNick = "mmp_004";
QianniuCloudkefuDispatchgroupsGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QianniuCloudkefuDispatchgroupsGetRequest;
$req->setUserNick("mmp_004");
$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=taobao.qianniu.cloudkefu.dispatchgroups.get' \
-d 'partner_id=apidoc' \
-d 'sign=E514BC055629FFADA6120987B0935907' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-26+14%3A27%3A51' \
-d 'v=2.0' \
-d 'user_nick=mmp_004'

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

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

req.user_nick="mmp_004"
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,"taobao.qianniu.cloudkefu.dispatchgroups.get");
add_param(pRequest,"user_nick","mmp_004");
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('taobao.qianniu.cloudkefu.dispatchgroups.get', {
	'user_nick':'mmp_004'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<qianniu_cloudkefu_dispatchgroups_get_response>
    <results>
        <group_account_info_d_o>
            <id>150000418</id>
            <group_name>客服中心</group_name>
            <accounts>
                <dispatch_account>
                    <dispatch_status>123</dispatch_status>
                    <weight>123</weight>
                    <account_id>123</account_id>
                    <account_nick>demo</account_nick>
                    <account_status>123</account_status>
                    <dispatch>false</dispatch>
                </dispatch_account>
            </accounts>
            <user_id>3649080808</user_id>
            <online_user_numbers_in_group>5</online_user_numbers_in_group>
            <account_status_list>
                <account_base_status_do>
                    <main_account_id>123</main_account_id>
                    <account_id>456</account_id>
                    <nick>mmp_004</nick>
                    <qn_mobile_app_version>iPhone OS_5.3.0</qn_mobile_app_version>
                    <pc_client_online_status>1</pc_client_online_status>
                    <pc_client_extend_status>1</pc_client_extend_status>
                    <client_suspend_status>1</client_suspend_status>
                    <online>false</online>
                    <wx_sdk_version>3.0.4_IPHONE_TMS</wx_sdk_version>
                    <pc_online>false</pc_online>
                    <mobile_client_online_status>1</mobile_client_online_status>
                    <suspend>true</suspend>
                    <qn_pc_app_version>3.10.01N</qn_pc_app_version>
                    <mobile_online>false</mobile_online>
                </account_base_status_do>
            </account_status_list>
        </group_account_info_d_o>
    </results>
</qianniu_cloudkefu_dispatchgroups_get_response>

{
    "qianniu_cloudkefu_dispatchgroups_get_response":{
        "results":{
            "group_account_info_d_o":[
                {
                    "id":150000418,
                    "group_name":"客服中心",
                    "accounts":{
                        "dispatch_account":[
                            {
                                "dispatch_status":123,
                                "weight":123,
                                "account_id":123,
                                "account_nick":"demo",
                                "account_status":123,
                                "dispatch":false
                            }
                        ]
                    },
                    "user_id":3649080808,
                    "online_user_numbers_in_group":5,
                    "account_status_list":{
                        "account_base_status_do":[
                            {
                                "main_account_id":123,
                                "account_id":456,
                                "nick":"mmp_004",
                                "qn_mobile_app_version":"iPhone OS_5.3.0",
                                "pc_client_online_status":1,
                                "pc_client_extend_status":1,
                                "client_suspend_status":1,
                                "online":false,
                                "wx_sdk_version":"3.0.4_IPHONE_TMS",
                                "pc_online":false,
                                "mobile_client_online_status":1,
                                "suspend":true,
                                "qn_pc_app_version":"3.10.01N",
                                "mobile_online":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.cloudkefu.dispatchgroups.get (客服分流分组信息查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈