文档中心 > API类目 > 店铺会员管理API

taobao.crm.group.add (卖家创建一个分组)

卖家创建一个新的分组，接口返回一个创建成功的分组的id

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
group_name	String	必须	春子	最大长度：15	分组名称，每个卖家最多可以拥有100个分组

响应参数

名称	类型	示例值	描述
group_id	Number	123456	新增分组的id
is_success	Boolean	true	添加分组是否成功

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CrmGroupAddRequest req = new CrmGroupAddRequest();
req.setGroupName("春子");
CrmGroupAddResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CrmGroupAddRequest req = new CrmGroupAddRequest();
req.GroupName = "春子";
CrmGroupAddResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CrmGroupAddRequest;
$req->setGroupName("春子");
$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.crm.group.add' \
-d 'partner_id=apidoc' \
-d 'session=f6ae2ce7-89e6-4ddc-bb6a-4000018f42bd' \
-d 'sign=08AD36613FF8FD6B1FD793BB65892DED' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-10+12%3A57%3A49' \
-d 'v=2.0' \
-d 'group_name=%E6%98%A5%E5%AD%90'

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

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

req.group_name="春子"
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.crm.group.add");
add_param(pRequest,"group_name","春子");
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.crm.group.add', {
	'group_name':'春子'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<crm_group_add_response>
    <group_id>123456</group_id>
    <is_success>true</is_success>
</crm_group_add_response>

{
    "crm_group_add_response":{
        "group_id":123456,
        "is_success":true
    }
}

异常示例

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"
	}
}

错误码解释

错误码	错误描述	解决方案
isv.invalid-parameter:group_name	新分组名称中含有\|或者:	去掉分组名中含有的“\|”或者：.
isv.checkname-service-error:group_name	新的分组名称和已有的分组名称重复	重新输入一个已经存在的分组
isv.checknum-service-error	卖家的分组数量已经达到上限	目前只能删除分组，或者编辑分组
isp.crmtop-service-unavailable	当前服务不可用	请稍后再试
isv.invalid-permission	当前登录的权限不够	检查帐号权限

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部