查询 Red Envelope 对象列表

返回之前创建 red_envelope 对象的一个列表。列表是按创建时间进行排序,总是将最新的 red_envelope 对象显示在最前。

请求参数描述
app[id] expandable required string红包使用的 app 对象的 idexpandable 可展开,查看如何获取App ID
limit optional int限制每页可以返回多少对象,范围为 1~100 项,默认是 10 项。
starting_after optional string在分页时使用的指针,决定了列表的第一项从何处开始。假设你的一次请求返回列表的最后一项的 idobj_end,你可以使用 starting_after = obj_end 去获取下一页。
ending_before optional string在分页时使用的指针,决定了列表的最末项在何处结束。假设你的一次请求返回列表的第一项的 idobj_start,你可以使用 ending_before = obj_start 去获取上一页。
channel optional string支付使用的第三方支付渠道,目前仅支持wx_pub
status optional string红包状态。目前支持 6 种状态:sending: 发放中; sent: 已发放待领取; failed: 发放失败; received: 已领取; refunding: 退款中; refund: 已退款。
created optional timestamp对象的创建时间,用 Unix 时间戳表示,具体参考下表 created 参数。
created 参数描述
created[gt] optional int大于 red_envelope 对象的创建时间,用 Unix 时间戳表示。
created[gte] optional int大于或等于 red_envelope 对象的创建时间,用 Unix 时间戳表示。
created[lt] optional int小于 red_envelope 对象的创建时间,用 Unix 时间戳表示。
created[lte] optional int小于或等于 red_envelope 对象的创建时间,用 Unix 时间戳表示。

返回

根据请求参数返回一个 red_envelope 对象列表,如果列表为空,则返回的 data 为空数组。遇到错误时返回相应错误信息,详见 错误

定义

GET https://api.pingxx.com/v1/red_envelopes?expand[]=app
\Pingpp\RedEnvelope::all();
RedEnvelope.all(Map options);
Pingpp::RedEnvelope.all
pingpp.RedEnvelope.list();
pingpp.RedEnvelope.all()
redEnvelope.List(&RedenvelopeListParams)
list(Dictionary<String, Object> params)

请求示例

curl https://api.pingxx.com/v1/red_envelopes/?limit=3?expand[]=app \
-u sk_test_ibbTe5jLGCi5rzfH4OqPW9KC:
\Pingpp\Pingpp::setApiKey('sk_test_ibbTe5jLGCi5rzfH4OqPW9KC');

\Pingpp\RedEnvelope::all(array('limit' => 3));
Pingpp.apiKey = "sk_test_ibbTe5jLGCi5rzfH4OqPW9KC";

Map<String, Object> redEnvelopeParams = new HashMap<String, Object>();
redEnvelopeParams.put("limit", 3);

RedEnvelope.all(redEnvelopeParams);
Pingpp.api_key = "sk_test_ibbTe5jLGCi5rzfH4OqPW9KC"
Pingpp::RedEnvelope.all(:limit => 3)
var pingpp = require('pingpp')('sk_test_ibbTe5jLGCi5rzfH4OqPW9KC');
pingpp.RedEnvelope.list({ limit: 3 }, function(err, RedEnvelope) {
   // 异步调用
});
pingpp.api_key = 'sk_test_ibbTe5jLGCi5rzfH4OqPW9KC'
res = pingpp.RedEnvelope.all(limit=3)
pingpp.Key = "sk_test_ibbTe5jLGCi5rzfH4OqPW9KC"
params := &pingpp.RedEnvelopeListParams{}
params.Filters.AddFilter("limit", "", "3")
params.Single = true
i := redEnvelope.List(params)
for i.Next() {
     c := i.RedEnvelope()
}
Dictionary<String, Object> params = new Dictionary<String, Object>();
chargeParams.Add("limit", 3);
  try {
     RedEnvelopeList reds = RedEnvelope.list(params);
     Console.WriteLine(reds);
  } catch (Exception e) {
     Console.WriteLine(e.Message.ToString());
}

返回示例

{
  "object": "list",
  "url": "/v1/red_envelopes",
  "has_more": true,
  "data": [
      {
        "id": "red_KCabLO58W5G0rX90iT0az5a9",
        "object": "red_envelope",
        "created": 1428499439,
        "received": null,
        "refunded": null,
        "livemode": true,
        "status": "sending",
        "app": "app_1Gqj58ynP0mHeX1q",
        "channel": "wx_pub",
        "order_no": "123456789",
        "transaction_no": null,
        "amount": 100,
        "amount_settle": 100,
        "currency": "cny",
        "recipient": "Openid",
        "subject": "Your Subject",
        "body": "Your Body",
        "description": "Your Description",
        "failure_msg":null,
        "extra": {
          "send_name": "Send Name"
          }
      }
  ]
}