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

taobao.tmc.group.add (为已开通用户添加用户分组)

为已开通用户添加用户分组,授权消息使用

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
group_name String 必须 vip_user
  • 最大长度:32
  • 分组名称,同一个应用下需要保证唯一性,最长32个字符。添加分组后,消息通道会为用户的消息分配独立分组,但之前的消息还是存储于默认分组中。不能以default开头,default开头为系统默认组。
    nicks String [] 必须 lzgary001,lazgary002
  • 最大列表长度:200
  • 用户昵称列表,以半角逗号分隔,支持子账号,支持增量添加用户
    user_platform String 可选 tbUIC
  • 默认值:tbUIC
  • 用户所属于的平台类型,tbUIC:淘宝用户; icbu: icbu用户;ae:ae用户

    响应参数

    名称 类型 示例值 描述
    created Date 2000-01-01 00:00:00 创建时间
    group_name String vip_user 分组名称

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TmcGroupAddRequest req = new TmcGroupAddRequest();
    req.setGroupName("vip_user");
    req.setNicks("lzgary001,lazgary002");
    req.setUserPlatform("tbUIC");
    TmcGroupAddResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tmc_group_add_response>
        <created>2000-01-01 00:00:00</created>
        <group_name>vip_user</group_name>
    </tmc_group_add_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>

    错误码解释

    错误码 错误描述 解决方案
    isv.invalid-param: invalid-group-name group_name的格式不正确 group_name不能用default开头
    isv.invalid-param: nick-error 用户昵称不正确 主输入正确的用户昵称
    isp.system-error: TIMServiceException 服务端错误 重试

    API工具

    如何获得此API

    FAQ

    返回
    顶部