如何通过DocuSign API获取全用户即将过期信封及触发回调?
DocuSign API 获取即将过期信封及回调配置
获取所有用户即将过期的信封
使用Envelopes: list API端点(GET /v2.1/accounts/{accountId}/envelopes),通过以下参数筛选目标信封:
- 核心参数设置:
status=sent:仅筛选已发送且待签署的信封(只有这类信封会有过期时间)filter=expires_on_or_before={ISO_DATE}:指定过期截止日期,比如未来7天内过期就填当前日期加7天的ISO 8601格式(如2024-12-31T23:59:59Z)include=expirations:要求返回信封的过期相关字段(比如过期时间、剩余天数)from_date:可选,配合to_date缩小时间范围,避免返回过多历史数据
如果需要获取所有用户的信封,需确保调用API的账号有账户管理员权限,或者使用代表用户的OAuth令牌逐个查询(管理员权限方式更高效)。
即将过期信封的回调触发
DocuSign Connect本身没有直接的「即将过期」原生事件,但可以通过两种方式实现类似效果:
- 定时API查询+自定义回调:定期调用上述Envelopes: list接口,筛选出即将过期的信封后,主动触发你的系统回调。这种方式灵活性高,完全可控。
- 利用系统提醒事件:
- 先在DocuSign账户设置中开启「Envelope Expiration Reminders」功能,配置提醒发送时间(比如过期前3天发送邮件)
- 然后在DocuSign Connect中监听
envelope_reminder_sent事件,当系统发送过期提醒时,会向你配置的URL发送包含信封信息的POST请求,以此作为即将过期的触发信号。
注意:如果需要严格的「即将过期」触发逻辑,第一种定时查询的方式更可靠,第二种依赖系统提醒配置,仅当提醒发送时才会触发回调。
内容的提问来源于stack exchange,提问作者user1044169
相关产品推荐
相关产品推荐

