文档中心 > API类目 > 淘宝直播API

alibaba.matrix.tcp.outer.getserverlist (服务商视角查询接口)

服务商视角查询接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
query_servant_list_request QueryServantListRequest 必须 服务商视角查询参数
  • └ type
  • Number
  • 必须
  • 1
  • 计划类型(通用计划/定向计划)
  • └ current_page_num
  • Number
  • 必须
  • 1
  • 分页
  • └ page_size
  • Number
  • 必须
  • 10
  • 分页展示的size(不要太大)
  • └ plan_status
  • Number
  • 可选
  • 1
  • 计划状态(默认为null)
  • └ anchor_ids
  • Number []
  • 可选
  • ""
  • 选择的达人id列表(默认为null)
  • └ item_ids
  • Number []
  • 可选
  • ""
  • 选择的商品id列表(默认为null)

响应参数

名称 类型 示例值 描述
result Result 返回结果
  • model
  • PageInfo
  • 页面信息
  • └ total
  • Number
  • 100
  • 返回的list总数
  • data
  • FlowCommissionV2VO []
  • 当前明细
  • └ id
  • Number
  • 1000123
  • 计划id
  • └ gmt_create
  • Date
  • Thu Apr 06 14:23:48 CST 2023
  • 创建时间
  • └ user_id
  • Number
  • 123456
  • 主播id
  • └ type
  • Number
  • 4
  • 业务类型
  • └ status
  • Number
  • 1
  • 状态
  • └ status_desc
  • String
  • "zhuangtaimiaoshu"
  • 状态描述
  • └ interrupt_status
  • Number
  • 1
  • 终止状态
  • └ interrupt_status_desc
  • String
  • "同意终止"
  • 终止状态描述
  • └ servant_id
  • Number
  • 123456
  • 服务商idstartTime
  • └ start_time
  • Date
  • Thu Apr 06 14:23:48 CST 2023
  • 开始时间
  • └ end_time
  • Date
  • Thu Apr 06 14:23:48 CST 2023
  • 结束时间
  • └ live_start_time
  • Date
  • Thu Apr 06 14:23:48 CST 2023
  • 预计开播时间
  • └ item_id
  • Number
  • “item01”
  • 商品id
  • └ item_name
  • String
  • "milk"
  • 商品名称
  • └ item_pic
  • String
  • “pictureadress”
  • 商品图片
  • └ ration_str
  • String
  • "10"
  • 佣金率
  • └ alter_ratio_str
  • String
  • "20"
  • 团长场景的直播客比例,只在团长场景不为空
  • └ ratio_type
  • Number
  • 10
  • 佣金类型,相对主播
  • └ alter_ratio_type
  • Number
  • 1
  • 佣金类型,相对团长比例
  • └ msg_code
  • String
  • ” SYSTEM_ERROR“
  • 失败时错误码
  • └ msg_info
  • String
  • "系统异常"
  • 错误信息
  • └ success
  • Boolean
  • true
  • 是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMatrixTcpOuterGetserverlistRequest req = new AlibabaMatrixTcpOuterGetserverlistRequest();
AlibabaMatrixTcpOuterGetserverlistRequest.QueryServantListRequest obj1 = new AlibabaMatrixTcpOuterGetserverlistRequest.QueryServantListRequest();
obj1.setType(1L);
obj1.setCurrentPageNum(1L);
obj1.setPageSize(10L);
obj1.setPlanStatus(1L);
obj1.setAnchorIds(new Long[] { \"\" };
);
obj1.setItemIds(new Long[] { \"\" };
);
req.setQueryServantListRequest(obj1);
AlibabaMatrixTcpOuterGetserverlistResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_matrix_tcp_outer_getserverlist_response>
    <result>
        <model>
            <total>100</total>
            <data>
                <flow_commission_v2_v_o>
                    <id>1000123</id>
                    <gmt_create>Thu Apr 06 14:23:48 CST 2023</gmt_create>
                    <user_id>123456</user_id>
                    <type>4</type>
                    <status>1</status>
                    <status_desc>&quot;zhuangtaimiaoshu&quot;</status_desc>
                    <interrupt_status>1</interrupt_status>
                    <interrupt_status_desc>&quot;同意终止&quot;</interrupt_status_desc>
                    <servant_id>123456</servant_id>
                    <start_time>Thu Apr 06 14:23:48 CST 2023</start_time>
                    <end_time>Thu Apr 06 14:23:48 CST 2023</end_time>
                    <live_start_time>Thu Apr 06 14:23:48 CST 2023</live_start_time>
                    <item_id>“item01”</item_id>
                    <item_name>&quot;milk&quot;</item_name>
                    <item_pic>“pictureadress”</item_pic>
                    <ration_str>&quot;10&quot;</ration_str>
                    <alter_ratio_str>&quot;20&quot;</alter_ratio_str>
                    <ratio_type>10</ratio_type>
                    <alter_ratio_type>1</alter_ratio_type>
                </flow_commission_v2_v_o>
            </data>
        </model>
        <msg_code>” SYSTEM_ERROR“</msg_code>
        <msg_info>&quot;系统异常&quot;</msg_info>
        <success>true</success>
    </result>
</alibaba_matrix_tcp_outer_getserverlist_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

返回
顶部