在一个API调用中获取docusign信封状态和收件人

Question

我正在使用docusign api，并且在查询字符串参数方面遇到了一些麻烦。基本上，我试图在单个呼叫中获取信封的收件人信息以及信封的状态。

我可以通过以下api调用分别获取每个信息，并且它们都可以工作

1。）信封端点（具有一个带有整体信封状态的状态字段，例如“已签名”，“已无效”，“已拒绝”等）： https://na2.docusign.net/restapi/v2/accounts/:accountId/envelopes/:docusignEnvelopeId/

2。）信封/收件人端点（具有有关收件人的信息） https://na2.docusign.net/restapi/v2/accounts/:accountId/envelopes/:docusignEnvelopeId/recipients

但是，我试图查看是否可以在一个API调用中全部获取这些信息。根据此处关于通用信封端点的文档，我认为我应该能够使用查询参数 https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/get#request 。

在“ include Optional Query Parameters”（包含可选查询参数）部分下，有一个“ include”（包含）参数，该参数表示我可以从第一个端点获取收件人。 “指定要返回的有关信封的其他信息。输入逗号分隔的列表，例如制表符，收件人。有效值为...”

我一直在尝试使用这个include参数修改第一个端点，使其看起来像这样……

https://na2.docusign.net/restapi/v2/accounts/:accountId/envelopes/:docusignEnvelopeId?include=recipients

但是我也无法让收件人出现。想知道我是在错误地输入参数还是不再可用。任何帮助将不胜感激！

谢谢:)

Answer 1

include参数是在eSignature API的v2.1中添加的，因此它们在v2中不起作用。将您的URL更改为https://na2.docusign.net/restapi/v2.1/accounts/:accountId/envelopes/:docusignEnvelopeId?include=recipients会返回收件人信息。