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

taobao.tmc.user.permit (为已授权的用户开通消息服务)

为已授权的用户开通消息服务,授权消息使用。
注意:topic覆盖更新,务必传入全量topic,或者不传topics,使用appkey订阅的所有topic

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
topics String [] 可选 taobao_trade_TradeCreate,taobao_refund_RefundCreate
  • 最大列表长度:100
  • 消息主题列表,用半角逗号分隔。当用户订阅的topic是应用订阅的子集时才需要设置,不设置表示继承应用所订阅的所有topic,一般情况建议不要设置。

    响应参数

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

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TmcUserPermitRequest req = new TmcUserPermitRequest();
    req.setTopics("taobao_trade_TradeCreate,taobao_refund_RefundCreate");
    TmcUserPermitResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

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

    错误码解释

    错误码 错误描述 解决方案
    isp.system-error: TIMServiceException 消息服务内部错误 重试
    isv.need-subscribe: subscribe-topic-first 应用没有订阅指定的topic,无法给用户开通 请先订阅指定的topic
    isv.invalid-param: topic-empty 应用没有订阅任何topic 请到TOP控制台为应用订阅至少一个topic

    API工具

    如何获得此API

    FAQ

    返回
    顶部