获取DocuSign信封取消或拒绝原因的API教程

本教程详细介绍了如何通过docusign api获取信封的取消或拒绝原因。不同于直接使用`getenvelope`方法，获取此类信息需要查询信封的审计事件列表。文章将指导您如何利用docusign sdk获取审计事件，并从事件描述中解析出具体的取消或拒绝原因，提供示例代码和注意事项，帮助开发者准确追踪信封状态变更的详细情况。

在DocuSign的开发实践中，有时我们需要了解一个信封为何被取消（作废）或被收件人拒绝。标准的getEnvelope API调用通常会返回信封的当前状态和基本信息，但并不会直接提供详细的取消或拒绝原因。要获取这些具体原因，我们需要深入到信封的审计事件（Audit Trail）中进行查找。

1. 理解DocuSign审计事件

DocuSign的每个信封都维护着一个详细的审计日志，记录了信封生命周期中的所有重要事件，例如创建、发送、查看、签署、拒绝、作废等。每个事件都包含事件名称、描述、时间戳以及执行该操作的用户信息。信封的取消或拒绝原因通常作为特定事件（如“信封作废”或“收件人拒绝”）的描述一部分被记录下来。

2. 获取信封审计事件列表

要获取信封的审计事件，我们需要使用DocuSign eSign API提供的专门方法，而不是普通的getEnvelope。在PHP SDK中，这通常通过EnvelopesApi类的listAuditEvents方法来实现。

以下是一个PHP示例代码，展示如何配置DocuSign API客户端并调用listAuditEvents方法来获取指定信封的所有审计事件：

标签： php 正则表达式 app ai 环境变量 api调用