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

dingtalk.oapi.dingpay.redenvelope.send (发送钉钉红包)

支持企业通过接口给员工发送钉钉红包

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	描述
ext_params	Json	可选	{"key":"value"}	额外参数
greetings	String	可选	新年好	红包祝福语
theme_id	String	可选	dingtidxxx	红包主题ID
receiver_id	String	必须	dinguidxxx	接收人ID
sender_id	String	可选	dinguidxxx	发送人ID
total_amount	String	必须	100	红包金额
type	String	必须	SINGLE_QUOTA	红包类型，目前支持：SINGLE_QUOTA，个人单聊红包
pay_sign	String	必须	dingsignxxx	签名方式咨询技术支持
pay_method	String	必须	支付方式	支付方式，WITHHOLD：代扣模式，目前只支持该方式
corp_biz_no	String	必须	dingcorpxxx	企业业务订单号（每个订单号必须唯一。取值范围：0~9，a~z，A~Z），接口根据企业订单号支持幂等，组成参考：corp_id+yyyymmdd+10位一天内不能重复的数字
open_conversation_id	String	可选	cidxxxx	群会话ID
chat_id	String	可选	chatxxxx	群会话ID

响应参数

名称	类型	示例值	描述
result	RedEnvelopeGetResult	redEnvelopeGetResult	红包发送结果
└ order_no String 202101013435445210023 订单订单号 └ corp_biz_no String ding380d4e7xxx20201231sdsd23343 企业订单号
errcode	Number	400	错误码
errmsg	String	系统异常	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/dingpay/redenvelope/send");
OapiDingpayRedenvelopeSendRequest req = new OapiDingpayRedenvelopeSendRequest();
req.setExtParamsString("{\"key\":\"value\"}");
req.setGreetings("新年好");
req.setThemeId("dingtidxxx");
req.setReceiverId("dinguidxxx");
req.setSenderId("dinguidxxx");
req.setTotalAmount("100");
req.setType("SINGLE_QUOTA");
req.setPaySign("dingsignxxx");
req.setPayMethod("支付方式");
req.setCorpBizNo("dingcorpxxx");
req.setOpenConversationId("cidxxxx");
req.setChatId("chatxxxx");
OapiDingpayRedenvelopeSendResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/dingpay/redenvelope/send");
OapiDingpayRedenvelopeSendRequest req = new OapiDingpayRedenvelopeSendRequest();
req.ExtParams = "{\"key\":\"value\"}";
req.Greetings = "新年好";
req.ThemeId = "dingtidxxx";
req.ReceiverId = "dinguidxxx";
req.SenderId = "dinguidxxx";
req.TotalAmount = "100";
req.Type = "SINGLE_QUOTA";
req.PaySign = "dingsignxxx";
req.PayMethod = "支付方式";
req.CorpBizNo = "dingcorpxxx";
req.OpenConversationId = "cidxxxx";
req.ChatId = "chatxxxx";
OapiDingpayRedenvelopeSendResponse 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 OapiDingpayRedenvelopeSendRequest;
$req->setExtParams("{\"key\":\"value\"}");
$req->setGreetings("新年好");
$req->setThemeId("dingtidxxx");
$req->setReceiverId("dinguidxxx");
$req->setSenderId("dinguidxxx");
$req->setTotalAmount("100");
$req->setType("SINGLE_QUOTA");
$req->setPaySign("dingsignxxx");
$req->setPayMethod("支付方式");
$req->setCorpBizNo("dingcorpxxx");
$req->setOpenConversationId("cidxxxx");
$req->setChatId("chatxxxx");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/dingpay/redenvelope/send");

curl -X POST "https://oapi.dingtalk.com/topapi/dingpay/redenvelope/send" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=6de754e2-41f4-4650-a374-bec6872e5f2d' \
-d 'chat_id=chatxxxx' \
-d 'corp_biz_no=dingcorpxxx' \
-d 'ext_params=%7B%5C%22key%5C%22%3A%5C%22value%5C%22%7D' \
-d 'greetings=%E6%96%B0%E5%B9%B4%E5%A5%BD' \
-d 'open_conversation_id=cidxxxx' \
-d 'pay_method=%E6%94%AF%E4%BB%98%E6%96%B9%E5%BC%8F' \
-d 'pay_sign=dingsignxxx' \
-d 'receiver_id=dinguidxxx' \
-d 'sender_id=dinguidxxx' \
-d 'theme_id=dingtidxxx' \
-d 'total_amount=100' \
-d 'type=SINGLE_QUOTA'

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

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

req.ext_params="{\"key\":\"value\"}"
req.greetings="新年好"
req.theme_id="dingtidxxx"
req.receiver_id="dinguidxxx"
req.sender_id="dinguidxxx"
req.total_amount="100"
req.type="SINGLE_QUOTA"
req.pay_sign="dingsignxxx"
req.pay_method="支付方式"
req.corp_biz_no="dingcorpxxx"
req.open_conversation_id="cidxxxx"
req.chat_id="chatxxxx"
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.send");
add_param(pRequest,"ext_params","{\"key\":\"value\"}");
add_param(pRequest,"greetings","新年好");
add_param(pRequest,"theme_id","dingtidxxx");
add_param(pRequest,"receiver_id","dinguidxxx");
add_param(pRequest,"sender_id","dinguidxxx");
add_param(pRequest,"total_amount","100");
add_param(pRequest,"type","SINGLE_QUOTA");
add_param(pRequest,"pay_sign","dingsignxxx");
add_param(pRequest,"pay_method","支付方式");
add_param(pRequest,"corp_biz_no","dingcorpxxx");
add_param(pRequest,"open_conversation_id","cidxxxx");
add_param(pRequest,"chat_id","chatxxxx");
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.send', {
	'ext_params':'{\"key\":\"value\"}',
	'greetings':'新年好',
	'theme_id':'dingtidxxx',
	'receiver_id':'dinguidxxx',
	'sender_id':'dinguidxxx',
	'total_amount':'100',
	'type':'SINGLE_QUOTA',
	'pay_sign':'dingsignxxx',
	'pay_method':'支付方式',
	'corp_biz_no':'dingcorpxxx',
	'open_conversation_id':'cidxxxx',
	'chat_id':'chatxxxx'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "order_no":"202101013435445210023",
        "corp_biz_no":"ding380d4e7xxx20201231sdsd23343"
    },
    "errcode":400,
    "errmsg":"系统异常"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

亲，您还没填写反馈内容。

联系方式

亲，电话号码格式不正确。

验证码刷新
亲，验证码错啦！

提交反馈

用户反馈

感谢您的反馈！

用户反馈

网络异常，请重新提交！
重新提交

钉钉API

dingtalk.oapi.dingpay.redenvelope.send (发送钉钉红包)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈