发送企业红包

POST

http://127.0.0.1/topapi/dingpay/redenvelope/send

历史文档（不推荐）/钉钉红包

最后修改时间：2022-08-30 09:19:21

责任人：未设置

说明

调用本接口发送企业红包。
服务地址：https://oapi.dingtalk.com

权限

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

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

错误码

参数	原因	排查方法
-1	系统繁忙	服务器暂不可用，建议稍后再重试1次，最多重试3次。
681001	企业订单号非法	检查企业订单号是否正确。
681002	红包类型非法	检查红包类型是否正确，目前支持：SINGLE_QUOTA（个人单聊红包）。
681003	红包支付方式非法	检查红包支付方式是否正确，目前支持：WITHHOLD（代扣模式）。
681004	红包支付签名非法	检查支付签名是否正确，签名计算方式请参考RSA私钥对参数进行签名。
68105	红包金额非法	检查红包金额是否正确，单位分，最小1元，即最小值100。
681006	红包发送人非法	检查红包发送人填写是否正确，可通过获取部门用户userid列表接口获取。
681007	红包接收人非法	检查红包接收人是否正确，可通过获取部门用户userid列表接口获取。
681008	红包祝福语过长	检查红包祝福语是否长度超出限制，长度小于128的字符串。
681009	企业不支持使用代扣支付	检查扣款账户是否正常。
681010	企业和员工关系非法	检查员工是否在该企业下。
681011	红包发送人和接收人相同	发送人和接收人不能为同一人。
681012	合约号非法	检查合约号是否正确。
681014	企业红包生成失败	检查网络是否正常或刷新重新。
681015	支付扣款失败	检查网络是否正常或刷新重新。
681016	发送红包消息失败	检查红包发送人是否开启高管模式或刷新后重试。

请求参数

Query 参数

access_token

string

必需

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

示例值:

dc73axxxx

Body 参数application/json

ext_params

object

扩展字段。

可选

greetings

string

可选

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

theme_id

string

可选

企业定制红包主题ID。企业定制红包主题ID可联系技术支持或运营获取。

receiver_id

string

必需

接收人的userid，可通过获取部门用户userid列表接口获取。接收人的userid不能和发送人的userid相同。

sender_id

string

可选

发送人的userid，可通过获取部门用户userid列表接口获取。

total_amount

string

必需

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

type

string

必需

红包类型：SINGLE_QUOTA：个人单聊红包

pay_sign

string

必需

支付签名，签名计算方式请参考RSA私钥对参数进行签名。

pay_method

string

必需

支付方式：WITHHOLD：代扣模式。

corp_biz_no

string

必需

企业订单号，每个订单号必须唯一。取值范围为0~~9、a~~z、A~Z。接口根据企业订单号支持幂等，组成参考：corp_id+yyyymmdd+10位一天内不能重复的数字。

示例

{
  "corp_biz_no": "dingcorpxxx",
  "ext_params": "{\"key\":\"value\"}",
  "total_amount": "100",
  "receiver_id": "user01",
  "theme_id": "user02",
  "greetings": "新年好",
  "pay_method": "WITHHOLD",
  "type": "SINGLE_QUOTA",
  "sender_id": "dinguidxxx",
  "pay_sign": "dingsignxxx"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/topapi/dingpay/redenvelope/send?access_token=dc73axxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "corp_biz_no": "dingcorpxxx",
    "ext_params": "{\"key\":\"value\"}",
    "total_amount": "100",
    "receiver_id": "user01",
    "theme_id": "user02",
    "greetings": "新年好",
    "pay_method": "WITHHOLD",
    "type": "SINGLE_QUOTA",
    "sender_id": "dinguidxxx",
    "pay_sign": "dingsignxxx"
}'

返回响应

🟢200成功

application/json

Body

result

object

红包发送结果。

可选

order_no

string

可选

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

corp_biz_no

string

企业订单号。

可选

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

示例

{
  "result": {
    "order_no": "string",
    "corp_biz_no": "string"
  },
  "errcode": 0,
  "errmsg": "string"
}

查询红包详情

发送企业红包

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码