查询红包详情

说明

调用本接口根据企业订单号查询红包详情。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考权限申请。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	是	开发者后台申请	调试
第三方个人应用	否	—	—

错误码

参数	原因	排查方法
681013	企业红包记录不存在	检查企业订单号是否正确。

请求参数

Query 参数

access_token

string

必需

调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。

示例值:

dc73axxxx

Body 参数application/json

corp_biz_no

string

必需

企业订单号，可通过发送红包接口获取。

示例

{
  "corp_biz_no": "dingcorpxxx"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

request_id

string

请求ID。

可选

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

result

object

红包查询结果。

可选

theme_id

string

可选

企业定制红包主题ID。

receiver_id

string

可选

接收人用户userid。

sender_id

string

可选

发送人用户userid。

type

string

可选

红包类型，目前支持：SINGLE_QUOTA（个人单聊红包）。

refund_amount

string

红包退款金额。

可选

pick_amount

string

红包领取金额。

可选

refund_time

string

红包退款时间。

可选

pick_time

string

红包领取时间。

可选

send_time

string

红包发送时间。

可选

total_amount

string

可选

红包金额，单位分，最小1元，即最小值100。

status

string

可选

红包状态：SENDING：发送中SENT：已发送，待领取PICKED：已领取REFUNDING：退款中REFUND：已退款

order_no

string

可选

钉钉订单号，长度不大于64位。

corp_biz_no

string

可选

企业订单号，企业传入。

greetings

string

可选

红包祝福语，长度小于128的字符串。

示例

{
  "request_id": "string",
  "errcode": 0,
  "errmsg": "string",
  "result": {
    "theme_id": "string",
    "receiver_id": "string",
    "sender_id": "string",
    "type": "string",
    "refund_amount": "string",
    "pick_amount": "string",
    "refund_time": "string",
    "pick_time": "string",
    "send_time": "string",
    "total_amount": "string",
    "status": "string",
    "order_no": "string",
    "corp_biz_no": "string",
    "greetings": "string"
  }
}

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码