文档中心 > API类目 > 消息服务API

taobao.tmc.groups.get (获取自定义用户分组列表)

获取自定义用户分组列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
group_names String [] 可选 vip_user
  • 最大列表长度:20
  • 要查询分组的名称,多个分组用半角逗号分隔,不传代表查询所有分组信息,但不会返回组下面的用户信息。如果应用没有设置分组则返回空。组名不能以default开头,default开头是系统默认的组。
    page_no Number 可选 1
  • 默认值:1
  • 页码
    page_size Number 可选 40
  • 默认值:40
  • 每页返回多少个分组

    响应参数

    名称 类型 示例值 描述
    groups TmcGroup [] dasdasd
    • └ name
    • String
    • vip_user
    • 分组名称
    total_results Number 123 分组总数

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TmcGroupsGetRequest req = new TmcGroupsGetRequest();
    req.setGroupNames("vip_user");
    req.setPageNo(1L);
    req.setPageSize(40L);
    TmcGroupsGetResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tmc_groups_get_response>
        <groups>
            <tmc_group>
                <name>vip_user</name>
            </tmc_group>
        </groups>
        <total_results>123</total_results>
    </tmc_groups_get_response>

    异常示例

    • 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>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部