选择应用类型
企业内部应用开发
学习地图
动态与公告
应用开发平台简介(新版)
应用开发平台简介
开发应用(新版)
开发应用
服务端API
客户端API
事件订阅
参考
常见问题
历史文档

查询红包详情

更新于 2024-01-11调用本接口根据企业订单号查询红包详情。

说明

为提升接口的使用体验,钉钉红包接口正在升级,后续产品会将红包作为一种支付的产品形式开放。钉钉红包API文档已于2021年10月21日移动至历史文档(不推荐)目录,接口不再支持新应用接入,已接入的应用可继续调用。新产品开放上线时间请关注文档更新日志。

权限

服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。

应用类型

是否支持调用

权限申请方式

API Explorer调试

企业内部应用

开发者后台申请

暂不支持

第三方企业应用

开发者后台申请

暂不支持

第三方个人应用

基本信息

请求方式:POST

请求地址https://oapi.dingtalk.com/topapi/dingpay/redenvelope/get

Query参数

名称

类型

是否必填

示例值

描述

access_token

String

dc73axxxx

调用服务端API的应用凭证。

Body参数

名称

类型

是否必填

示例值

描述

corp_biz_no

String

dingcorpxxx

企业订单号。

返回参数

名称

类型

示例值

描述

request_id

String

4cmx63u8ue76

请求ID。

errcode

Number

0

返回码。

errmsg

String

ok

返回码描述。

result

RedEnvelopeGetResult

红包查询结果。

theme_id

String

dingtidxxx

企业定制红包主题ID。

receiver_id

String

user01

接收人用户userid。

sender_id

String

user02

发送人用户userid。

type

String

SINGLE_QUOTA

红包类型,目前支持:SINGLE_QUOTA(个人单聊红包)。

refund_amount

String

10

红包退款金额。

pick_amount

String

10

红包领取金额。

refund_time

String

2021-01-01 00:00:00

红包退款时间。

pick_time

String

2021-01-01 00:00:00

红包领取时间。

send_time

String

2021-01-01 00:00:00

红包发送时间。

total_amount

String

100

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

status

String

PICKED

红包状态:

  • SENDING:发送中

  • SENT:已发送,待领取

  • PICKED:已领取

  • REFUNDING:退款中

  • REFUND:已退款

order_no

String

202101xxxx

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

corp_biz_no

String

dingcorpxxx

企业订单号,企业传入。

greetings

String

新年好

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

示例

请求示例(HTTP)

Loading...

请求正文

Loading...

请求示例(JAVA SDK)

Loading...

返回示例

Loading...

错误码

参数

原因

排查方法

681013

企业红包记录不存在

检查企业订单号是否正确。

点击纠错