Docusign中的deliverymethod传真创建并发送API - 演示环境

时间:2014-01-24 14:43:05

标签: docusignapi

您好试图使用DocuSign createsendEnvelope API为收件人提供传送方式传真和传真号码。但是,在演示环境中,API需要收件人电子邮件,并始终发送电子邮件。该文件未传真至提供的号码。任何人都可以确认是否禁用了传真选项的演示环境吗?

提前致谢!

1 个答案:

答案 0 :(得分:1)

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

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": "johnsemail@outlook.com",
            "faxNumber": "2069347947",
            "recipientId": "1",
            "routingOrder": "1",
            "deliveryMethod": "Fax",
        }]
   },
   "documents": [
        {
            "name": "TestFile.pdf",
            "documentId": "1",
            "fileExtension": "pdf",
            "documentBase64" : "DOCUMENT_BYTES"
        }
    ]
}

不幸的是,我收到以下错误以响应请求(即使我指定的传真号码是有效的传真号码):

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

为了进一步排除故障,我尝试了一些反向工程,试图确定DocuSign希望您为传真收件人设置的属性。

首先,使用DocuSign Web控制台,我创建/发送了一个新的信封,其中包含一个收件人,其中交付方式=传真。以下是此envlope的DocuSign Web控制台的状态窗格的屏幕截图(在我发送之后): status pane

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

{
    "signers": [
        {
            "signInEachLocation": "false",
            "name": "John Doe",
            "email": "johnsemail@outlook.com",
            "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​​)。)

与此同时,如果您使用DocuSign SOAP API是一个选项,您可以尝试该路由,因为看起来“传真输出”功能最初是为SOAP API设计并在SOAP API中实现的(所以我会期待它在那里工作,虽然我没有亲自测试过。)