是否存在可跟踪已发送DocuSign信封状态的相关API?
DocuSign 仪表盘集成解决方案
完全可以通过DocuSign官方开放的API实现你描述的需求,核心用到eSignature REST API下的两组接口:
1. 协议签署状态跟踪
调用Envelopes: list接口可批量拉取账号下所有已发送信封(即DocuSign协议)的实时状态,返回结果包含以下核心字段:
- 信封唯一标识
envelopeId,作为仪表盘与DocuSign文档的关联主键 - 协议实时状态:包含
completed(已完成签署)、sent(已发送待签署)、declined(签署人拒签)、voided(已作废)等全量流程状态 - 各签署节点时间戳、所有签署方的单独签署状态
- 关联的文档元数据
如果需要避免轮询拉取的性能损耗,可搭配DocuSign Connect webhook服务使用:完成配置后,信封状态发生变更时DocuSign会主动向你指定的服务地址推送事件数据,实现状态实时更新。
2. 文档跳转关联
调用EnvelopeViews: createConsole接口可生成对应信封的免登访问链接,用户在你的仪表盘点击链接即可直接跳转至DocuSign的信封详情页,查看完整协议内容、签署历史、下载已签署文件,链接默认有效期为5分钟,可根据需求调整。
如果需要直接在仪表盘内下载文档,可调用EnvelopeDocuments: get接口直接拉取对应信封的已签署文档二进制流。
常用请求示例
拉取指定时间段内所有信封状态:
GET /restapi/v2.1/accounts/{你的账户ID}/envelopes?from_date={起始时间}
生成信封详情跳转链接:
POST /restapi/v2.1/accounts/{你的账户ID}/envelopes/{目标envelopeId}/views/console
请求体只需传入当前访问用户绑定的DocuSign邮箱,即可生成对应权限的访问链接。
注意事项
- 所有接口调用前需要完成OAuth 2.0鉴权,企业内部集成场景推荐使用JWT授权模式,实现服务端无感调用
- 接口支持自定义返回字段,你可以根据仪表盘实际需要过滤冗余字段,降低数据传输开销,提升加载速度
内容的提问来源于stack exchange,提问作者Nathindu Himansha
相关产品推荐
相关产品推荐

