能否通过一次API调用获取信封全部属性？C# DocuSign API咨询

我之前对接DocuSign API时也遇到过一模一样的情况——默认调用GetEnvelope只会返回基础字段，像InitialSendDate这种常用属性是默认包含的，但CustomFields、Recipients这类属于非核心属性，需要显式指定才会返回，这是DocuSign为了优化响应性能做的设计。

方法一：显式指定要包含的属性（推荐按需获取） #

在C# SDK里，你可以通过GetEnvelopeOptions类的Include参数来指定需要额外获取的属性，参数值是逗号分隔的字段名：

// 初始化EnvelopesApi实例（假设你已经完成了认证和实例化）
var envelopesApi = new EnvelopesApi();
var accountId = "你的账户ID";
var envelopeId = "目标信封ID";

// 创建选项并指定要包含的属性
var getEnvelopeOptions = new EnvelopesApi.GetEnvelopeOptions();
// 按需添加需要的字段，比如同时获取custom_fields和recipients
getEnvelopeOptions.Include = "custom_fields,recipients";

// 调用API时传入选项
var envelope = envelopesApi.GetEnvelope(accountId, envelopeId, getEnvelopeOptions);

支持的常用字段值包括：

• recipients：返回所有收件人信息
• custom_fields：返回信封级自定义字段
• documents：返回信封关联的文档
• tabs：返回收件人的签名字段
• 如果确实需要所有属性，可以用"all"，但不建议，因为会大幅增加响应体积和请求耗时

方法二：使用专门的API单独获取（更高效） #

如果你只需要Recipients或CustomFields其中一类数据，直接调用对应的专用API会更高效，不用拉取整个信封对象：

获取收件人信息

var recipients = envelopesApi.ListRecipients(accountId, envelopeId);

获取自定义字段信息

var customFields = envelopesApi.ListCustomFields(accountId, envelopeId);

注意事项 #

• 确保你使用的DocuSign C# SDK是最新版本，旧版本的参数名可能有差异（比如早期版本可能用IncludeRecipients这类单独的布尔参数）
• 按需获取属性比用"all"更能提升接口性能，尤其是处理大量信封的时候

内容的提问来源于stack exchange，提问作者EnterTheCode