在docusign中创建和发送API的Deliverymethod传真-演示环境 [英] Deliverymethod fax in docusign create and send API - demo environment

问题描述

您好：尝试对发送方式为FAX和传真号码的收件人使用DocuSign createdendEnvelope API。但是，在演示环境中，API需要接收收件人的电子邮件，并且总是发送电子邮件。该文档未传真到提供的号码。谁能确认演示环境是否禁用了传真选项？

Hi Trying to use the DocuSign createsendEnvelope API for a recipient with delivery method FAX and fax number. However in the demo environment the API needs a recipients email and always send out the email. The document is not faxed to the number provided. Can any one confirm if the demo environment is disabled for faxing options?

预先感谢！

推荐答案

DocuSign SOAP API中的传真输出功能的发行说明描述了如何使用SOAP API通过传真发送（ http://www.docusign.com/sites/default/files/DocuSignReleaseNotes-Jun-1-2012-Final。 pdf ）。我尝试应用相同的理由通过REST API通过传真发送信封-这是我的创建信封请求：

The release notes for the "Fax Out" feature in the DocuSign SOAP API describe how to send via fax with the SOAP API (http://www.docusign.com/sites/default/files/DocuSignReleaseNotes-Jun-1-2012-Final.pdf). I tried to apply the same rational to send an envelope via fax with the REST API -- here's my "Create Envelope" request:

POST https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes

{
  "emailSubject": "Please sign this",
  "emailBlurb": "Please sign...thanks!",
  "status": "sent",
  "enableWetSign": "true",
  "recipients": {
      "signers": [
        {
            "name": "John Doe",
            "email": "[e-mail]",
            "faxNumber": "2069347947",
            "recipientId": "1",
            "routingOrder": "1",
            "deliveryMethod": "Fax",
        }]
   },
   "documents": [
        {
            "name": "TestFile.pdf",
            "documentId": "1",
            "fileExtension": "pdf",
            "documentBase64" : "DOCUMENT_BYTES"
        }
    ]
}

不幸的是，响应请求，我收到以下错误消息（即使我指定的传真号码是有效的传真号码）：

Unfortunately, I receive the following error in response to the request (even though the fax number I specified is a valid fax number):

{
    "errorCode": "INVALID_FAXNUMBER",
    "message": "Fax Number is invalid."
}

为了进一步解决问题，我尝试了一些反向工程以尝试确定DocuSign希望您为传真收件人设置哪些属性。

To troubleshoot further, I tried a little reverse-engineering in an attempt to determine what properties DocuSign expects you to set for a Fax recipient.

首先，我使用DocuSign Web控制台创建/发送了一个带有单个收件人的新信封，其中发送方式为传真。这是DocuSign Web控制台中此信封的状态窗格的屏幕截图（在我发送后立即发送）：

First, using the DocuSign web console, I created/sent a new Envelope with a single recipient where the delivery method = fax. Here's a screenshot of the Status pane from the DocuSign web console for this envlope (immediately after I sent it):

接下来，我使用REST API执行了获取收件人请求（ GET https：// {{env }}。docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{{envId}}/收件人），目的是检查收件人对象在响应中确定需要为传真收件人设置哪些属性。这是我收到的回复：

Next, I used the REST API to execute a "Get Recipients" request (GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{{envId}}/recipients) -- with the goal of examining the recipient object in the response to determine which properties need to be set for a Fax recipient. Here's the response I received:

{
    "signers": [
        {
            "signInEachLocation": "false",
            "name": "John Doe",
            "email": "[e-mail]",
            "recipientId": "1",
            "recipientIdGuid": "977e571d-6613-492c-8a75-9c207d46c03c",
            "requireIdLookup": "false",
            "userId": "03c8a856-c0ae-41bf-943d-ac6e92db66a8",
            "routingOrder": "1",
            "status": "sent"
        }
    ],
    "agents": [],
    "editors": [],
    "intermediaries": [],
    "carbonCopies": [],
    "certifiedDeliveries": [],
    "inPersonSigners": [],
    "recipientCount": "1",
    "currentRoutingOrder": "1"
}

有趣的是，

API响应中没有提及 deliveryMethod，也没有提及为收件人指定的传真号码。这使我相信，也许REST API目前不完全支持传真传递方法。 （如果支持，那么也许具有DocuSign的人可以在这里发出提示，并说明如何通过传真（使用API​​）发送。）

Interestingly, the API response contains no mention of "deliveryMethod", and no mention of the fax number that was specified for the recipient. This would lead me to believe that perhaps the "fax" delivery method isn't fully supported via the REST API at this time. (If it is supported, then perhaps someone with DocuSign can chime in here and explain how to send via fax (with the API).)

同时，如果使用DocuSign SOAP API是为您提供的一个选项，您可以尝试一下该路线，因为​​传真输出功能最初是为SOAP API设计并实现的（因此，我希望它可以在其中使用，尽管我还没有。

In the meantime, if using the DocuSign SOAP API is an option for you, you might try that route, as it appears that the "Fax Out" feature was initially designed for and implemented in the SOAP API (so I'd expect it to work there, although I haven't personally tested it).

这篇关于在docusign中创建和发送API的Deliverymethod传真-演示环境的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！