注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > 店小蜜API

taobao.timi.alphax.transferguide.guidestep (店小蜜新手引导流程中获取各个进度接口)

店小蜜新手引导过程中获取各个进度的接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
scope String 可选 cntaobao
  • 默认值:cntaobao
  • 业务域
    type_list String [] 必须 TRANSFER,ROBOT_GUIDE,NEW_GUIDE,PLAN
  • 最大列表长度:20
  • 类型列表
    from String 必须 DXM 来源

    响应参数

    名称 类型 示例值 描述
    result Result result
    • └ message
    • String
    • message
    • data
    • Data
    • data
    • data
    • └ plan
    • String
    • 配置方案
    • └ has_plan
    • Boolean
    • 是否有配置方案
    • └ guide_readed
    • Boolean
    • 是否已完成新手引导
    • └ transfer_step
    • Number
    • 迁移进度
    • └ robot_guide
    • Number
    • 小机器人引导进度
    • └ from
    • String
    • 来源(埋点使用)
    • └ support_guide
    • Number
    • 智能辅助引导进度
    • └ knowledge_simplify
    • Number
    • 简版知识库进度
    • └ open_robot
    • Number
    • 全自动开启进度
    • └ open_assistant
    • Number
    • 智能辅助开启进度
    • └ code
    • String
    • code
    • └ success
    • Boolean
    • false
    • success

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TimiAlphaxTransferguideGuidestepRequest req = new TimiAlphaxTransferguideGuidestepRequest();
    req.setScope("cntaobao");
    req.setTypeList("TRANSFER,ROBOT_GUIDE,NEW_GUIDE,PLAN");
    req.setFrom("DXM");
    TimiAlphaxTransferguideGuidestepResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <timi_alphax_transferguide_guidestep_response>
        <result>
            <message></message>
            <data>
                <plan></plan>
                <has_plan></has_plan>
                <guide_readed></guide_readed>
                <transfer_step></transfer_step>
                <robot_guide></robot_guide>
                <from></from>
                <support_guide></support_guide>
                <knowledge_simplify></knowledge_simplify>
                <open_robot></open_robot>
                <open_assistant></open_assistant>
            </data>
            <code></code>
            <success>false</success>
        </result>
    </timi_alphax_transferguide_guidestep_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

    返回
    顶部