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

taobao.tmc.user.get (获取商家所在分组及其已授权(广播)消息topics)

查询指定用户开通的消息通道和组

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
fields String 必须 user_nick,topics,user_id,is_valid,created,modified 需返回的字段列表,多个字段以半角逗号分隔。可选值:TmcUser结构体中的所有字段,一定要返回topic。
nick String 必须 testnick
  • 最大长度:100
  • 用户昵称
    user_platform String 可选 tbUIC
  • 默认值:tbUIC
  • 用户所属的平台类型,tbUIC:淘宝用户; icbu: icbu用户;ae:ae用户

    响应参数

    名称 类型 示例值 描述
    tmc_user TmcUser 开通的用户数据
    • └ created
    • Date
    • 2015-01-01 00:00:00
    • 用户首次开通时间
    • └ group_name
    • String
    • default
    • 接收用户消息的组名
    • └ is_valid
    • Boolean
    • true
    • 用户授权是否有效,true表示授权有效,false表示授权过期
    • └ modified
    • Date
    • 2015-05-01 00:00:00
    • 用户最后开通时间
    • └ topics
    • String []
    • taobao_trade_TradeCreate,taobao_trade_TradeBuyerPay
    • 用户开通的消息类型列表。如果为空表示应用开通的所有类型
    • └ user_id
    • Number
    • 32123423
    • 用户ID
    • └ user_nick
    • String
    • testUser1
    • 用户昵称
    • └ user_platform
    • String
    • tbUIC
    • 用户所属的平台类型,tbUIC:淘宝用户; icbu: icbu用户

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TmcUserGetRequest req = new TmcUserGetRequest();
    req.setFields("user_nick,topics,user_id,is_valid,created,modified");
    req.setNick("testnick");
    req.setUserPlatform("tbUIC");
    TmcUserGetResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tmc_user_get_response>
        <tmc_user>
            <created>2015-01-01 00:00:00</created>
            <group_name>default</group_name>
            <is_valid>true</is_valid>
            <modified>2015-05-01 00:00:00</modified>
            <topics>
                <string>taobao_trade_TradeCreate</string>
                <string>taobao_trade_TradeBuyerPay</string>
            </topics>
            <user_id>32123423</user_id>
            <user_nick>testUser1</user_nick>
            <user_platform>tbUIC</user_platform>
        </tmc_user>
    </tmc_user_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>

    错误码解释

    错误码 错误描述 解决方案
    isv.invalid-param: usernick-empty 参数nick未传 传入相应参数
    isv.tmc-switch-off: appkey 应用未开通消息服务 应用开通消息服务
    isv.invalid-param: nick-error nick错误或与user_platform不匹配 请传入正确的userNick与user_platform

    API工具

    如何获得此API

    FAQ

    返回
    顶部