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

taobao.tmc.group.delete (删除指定的分组或分组下的用户)

删除指定的分组或分组下的用户,授权消息使用

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
group_name String 必须 vip_user 分组名称,分组删除后,用户的消息将会存储于默认分组中。警告:由于分组已经删除,用户之前未消费的消息将无法再获取。不能以default开头,default开头为系统默认组。
nicks String [] 可选 helloworld
  • 最大列表长度:20
  • 用户列表,不传表示删除整个分组,如果用户全部删除后,也会自动删除整个分组
    user_platform String 可选 tbUIC
  • 默认值:tbUIC
  • 用户所属于的平台类型,tbUIC:淘宝用户; icbu: icbu用户;ae:ae用户

    响应参数

    名称 类型 示例值 描述
    is_success Boolean true 是否成功

    请求示例

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

    响应示例

    • XML示例
    • JSON示例
    <tmc_group_delete_response>
        <is_success>true</is_success>
    </tmc_group_delete_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

    返回
    顶部