文档中心 > API类目 > 钉钉API

dingtalk.oapi.dingpay.redenvelope.get (查询钉钉红包详情)

查询钉钉红包详情

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
corp_biz_no	String	必须	dingxxx		企业订单号

响应参数

名称	类型	示例值	描述
errcode	Number	400	错误码
errmsg	String	系统错误	错误信息
result	RedEnvelopeGetResult	redEnvelopeGetResult	红包查询结果
└ theme_id String dingtidxxx 红包主题ID └ receiver_id String dinguidxxx 红包接收人ID └ sender_id String dinguidxxx 红包发送人ID，当红包类型为SINGLE_QUOTA时有值 └ type String 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 红包金额 └ status String PICKED 红包状态 └ order_no String dingrnoxxx 红包订单号 └ corp_biz_no String dingcnoxxx 企业订单号，企业传入 └ greetings String 新年好红包祝福语

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/dingpay/redenvelope/get");
OapiDingpayRedenvelopeGetRequest req = new OapiDingpayRedenvelopeGetRequest();
req.setCorpBizNo("dingxxx");
OapiDingpayRedenvelopeGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/dingpay/redenvelope/get");
OapiDingpayRedenvelopeGetRequest req = new OapiDingpayRedenvelopeGetRequest();
req.CorpBizNo = "dingxxx";
OapiDingpayRedenvelopeGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiDingpayRedenvelopeGetRequest;
$req->setCorpBizNo("dingxxx");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/dingpay/redenvelope/get");

curl -X POST "https://oapi.dingtalk.com/topapi/dingpay/redenvelope/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=32cc7339-f14c-4237-8753-601839ddd151' \
-d 'corp_biz_no=dingxxx'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiDingpayRedenvelopeGetRequest("https://oapi.dingtalk.com/topapi/dingpay/redenvelope/get")

req.corp_biz_no="dingxxx"
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.dingpay.redenvelope.get");
add_param(pRequest,"corp_biz_no","dingxxx");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.dingpay.redenvelope.get', {
	'corp_biz_no':'dingxxx'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":400,
    "errmsg":"系统错误",
    "result":{
        "theme_id":"dingtidxxx",
        "receiver_id":"dinguidxxx",
        "sender_id":"dinguidxxx",
        "type":"SINGLE_QUOTA",
        "refund_amount":"10",
        "pick_amount":"10",
        "refund_time":"2021-01-01 00:00:00",
        "pick_time":"2021-01-01 00:00:00",
        "send_time":"2021-01-01 00:00:00",
        "total_amount":"100",
        "status":"PICKED",
        "order_no":"dingrnoxxx",
        "corp_biz_no":"dingcnoxxx",
        "greetings":"新年好"
    }
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.dingpay.redenvelope.get (查询钉钉红包详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ