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

alibaba.taobao.live.platformgift.allow (支付宝直播双十一合作需求 - 支持查看用户是否有平台新人礼)

支付宝直播双十一合作需求 - 支持查看用户是否有平台新人礼

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
platform_gift_allow_request PlatformGiftAllowRequest 可选 入参
  • └ live_source
  • String
  • 可选
  • zhifubao
  • 来源方渠道编码
  • └ biz_id
  • String
  • 可选
  • 11
  • 规则id
  • └ user_id
  • Number
  • 可选
  • 213
  • 用户id
  • └ entry_live_source
  • String
  • 可选
  • zhifubao
  • 来源方渠道编码
  • └ scene
  • String
  • 可选
  • live
  • 发放场景
  • └ is_test
  • Boolean
  • 可选
  • false
  • 是否压测流量

响应参数

名称 类型 示例值 描述
business_code String 200 错误码
data PlatformGiftAllowInfo 结果
  • red_package_info
  • RedPacketInfo
  • 红包信息
  • └ display_amount
  • String
  • 1
  • 红包金额(元)
  • └ display_start_fee
  • String
  • 1
  • 红包门槛(元)
  • └ status
  • String
  • unObtained
  • 红包金额状态 未领取 unObtained / 已领取 alreadySuccessObtained / 其他状态
  • └ allow_result
  • Boolean
  • false
  • 是否目标用户
  • └ status
  • Number
  • 1
  • 玩法状态 0-未开始(可领) 1-进行中(已领) 2-已完成 3-已失效
is_success Boolean true 是否成功
error_message String success 错误码信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTaobaoLivePlatformgiftAllowRequest req = new AlibabaTaobaoLivePlatformgiftAllowRequest();
AlibabaTaobaoLivePlatformgiftAllowRequest.PlatformGiftAllowRequest obj1 = new AlibabaTaobaoLivePlatformgiftAllowRequest.PlatformGiftAllowRequest();
obj1.setLiveSource("zhifubao");
obj1.setBizId("11");
obj1.setUserId(213L);
obj1.setEntryLiveSource("zhifubao");
obj1.setScene("live");
obj1.setIsTest(false);
req.setPlatformGiftAllowRequest(obj1);
AlibabaTaobaoLivePlatformgiftAllowResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_taobao_live_platformgift_allow_response>
    <business_code>200</business_code>
    <data>
        <red_package_info>
            <display_amount>1</display_amount>
            <display_start_fee>1</display_start_fee>
            <status>unObtained</status>
        </red_package_info>
        <allow_result>false</allow_result>
        <status>1</status>
    </data>
    <is_success>true</is_success>
    <error_message>success</error_message>
</alibaba_taobao_live_platformgift_allow_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

返回
顶部