进程信封中的Docu Sign Rest API发件人查看问题

时间:2014-06-13 10:41:08

标签: docusignapi

我们正尝试使用嵌入式签名在iframe中显示发件人视图。 如果信封有2个签名者,其中一个签名信封,我们希望向发件人显示信封的当前状态。

是否有任何API可用于向发件人显示当前信封状态。

2 个答案:

答案 0 :(得分:0)

一旦DocuSign信封正在进行中(意味着它已被发送且未处于草稿状态),您就无法生成发件人视图。发件人视图用于标记信封,如果信封已经发送,则不再允许标记。

因此,要回答您的问题,不能在已发送的信封上生成发件人视图,它只能生成签名此时的URL,您只能为设置了clientUserId属性的收件人生成签名URL。

有关嵌入式签名的更多信息:

https://www.docusign.com/developer-center/explore/features/embedding-docusign

答案 1 :(得分:0)

根据您添加到答案中的评论,检索信封所有收件人当前状态的最简单方法是 GET收件人 API调用:

GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{{envelopeId}}/recipients?include_tabs=false&include_extended=false

响应将包含每个收件人类型的收件人对象数组,每个收件人对象都有一个状态属性,指示收件人的当前状态。例如,这是对包含2个签名者的信封的响应 - 第一个包含已完成签名,第二个未包含(状态=已提交):

{
    "signers": [
        {
            "signInEachLocation": "false",
            "name": "Abby Adams",
            "email": "abby@outlook.com",
            "recipientId": "04cdba57-5383-4917-9081-e9dad16ba8a9",
            "recipientIdGuid": "04cdba57-5383-4917-9081-e9dad16ba8a9",
            "requireIdLookup": "false",
            "userId": "1860fbdc-96ee-4d14-8353-c0213cd2728f",
            "routingOrder": "1",
            "roleName": "Signer 1",
            "status": "completed",
            "signedDateTime": "2014-04-24T14:00:10.5800000Z",
            "deliveredDateTime": "2014-04-24T13:59:35.2330000Z",
            "templateLocked": "false",
            "templateRequired": "false"
        },
        {
            "signInEachLocation": "false",
            "name": "Adam Smith",
            "email": "adam@outlook.com",
            "recipientId": "fb3708f5-552f-410e-8029-9abbb5214196",
            "recipientIdGuid": "fb3708f5-552f-410e-8029-9abbb5214196",
            "requireIdLookup": "false",
            "userId": "ecd6f430-5c08-4a4c-876e-ba7ad95f13dc",
            "routingOrder": "2",
            "status": "delivered",
            "deliveredDateTime": "2014-04-24T14:00:28.1930000Z"
        }
    ],
    "agents": [],
    "editors": [],
    "intermediaries": [],
    "carbonCopies": [],
    "certifiedDeliveries": [],
    "inPersonSigners": [],
    "recipientCount": "2",
    "currentRoutingOrder": "2"
}

如果您需要更详细的审计跟踪信息,可以使用 GET审核事件 API调用:

GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{{envelopeId}}/audit_events

对此请求的响应将包含 auditEvent 对象的数组。每个 auditEvent 对象都由一个属性组成 - eventFields - 这是一个名称/值对的数组。

例如,以下回复显示Mary Smith创建了信封并发送了信封,然后John Doe查看了信封并拒绝了信封:

{
    "auditEvents": [
        {
            "eventFields": [
                {
                    "name": "logTime",
                    "value": "2014-05-23T03:07:52.7741974Z"
                },
                {
                    "name": "Source",
                    "value": "api"
                },
                {
                    "name": "UserName",
                    "value": "Mary Smith"
                },
                {
                    "name": "UserId",
                    "value": "bc266e97-83a6-472c-XXXX-ebad10e4cc6a"
                },
                {
                    "name": "Action",
                    "value": "Registered"
                },
                {
                    "name": "Message",
                    "value": "The envelope was created by Mary Smith"
                },
                {
                    "name": "EnvelopeStatus",
                    "value": "created"
                },
                {
                    "name": "ClientIPAddress",
                    "value": "XX.XX.XX.XXX"
                },
                {
                    "name": "Information",
                    "value": ""
                },
                {
                    "name": "GeoLocation",
                    "value": ""
                },
                {
                    "name": "Language",
                    "value": "english (us)"
                }
            ]
        },
        {
            "eventFields": [
                {
                    "name": "logTime",
                    "value": "2014-05-23T03:07:53.6321919Z"
                },
                {
                    "name": "Source",
                    "value": "api"
                },
                {
                    "name": "UserName",
                    "value": "Mary Smith"
                },
                {
                    "name": "UserId",
                    "value": "bc266e97-83a6-472c-a25b-ebad10e4cc6a"
                },
                {
                    "name": "Action",
                    "value": "Sent Invitations"
                },
                {
                    "name": "Message",
                    "value": "Mary Smith sent an invitation to John Doe [john@outlook.com]"
                },
                {
                    "name": "EnvelopeStatus",
                    "value": "sent"
                },
                {
                    "name": "ClientIPAddress",
                    "value": "XX.XX.XX.XXX"
                },
                {
                    "name": "Information",
                    "value": "John Doe [john@outlook.com]"
                },
                {
                    "name": "GeoLocation",
                    "value": ""
                },
                {
                    "name": "Language",
                    "value": "english (us)"
                }
            ]
        },
        {
            "eventFields": [
                {
                    "name": "logTime",
                    "value": "2014-05-23T03:12:17.9412976Z"
                },
                {
                    "name": "Source",
                    "value": "web"
                },
                {
                    "name": "UserName",
                    "value": "John Doe"
                },
                {
                    "name": "UserId",
                    "value": "03c8a856-c0ae-41bf-943d-ac6e92db66a8"
                },
                {
                    "name": "Action",
                    "value": "Viewed"
                },
                {
                    "name": "Message",
                    "value": "John Doe viewed the envelope [documents:(Mutual NDA with anchors.pdf)]"
                },
                {
                    "name": "EnvelopeStatus",
                    "value": "sent"
                },
                {
                    "name": "ClientIPAddress",
                    "value": "XX.XX.XX.XXX"
                },
                {
                    "name": "Information",
                    "value": "John Doe viewed the envelope [documents:(Mutual NDA with anchors.pdf)]"
                },
                {
                    "name": "GeoLocation",
                    "value": ""
                },
                {
                    "name": "Language",
                    "value": "english (us)"
                }
            ]
        },
        {
            "eventFields": [
                {
                    "name": "logTime",
                    "value": "2014-05-23T03:12:30.3432181Z"
                },
                {
                    "name": "Source",
                    "value": "web"
                },
                {
                    "name": "UserName",
                    "value": "John Doe"
                },
                {
                    "name": "UserId",
                    "value": "03c8a856-c0ae-41bf-943d-ac6e92db66a8"
                },
                {
                    "name": "Action",
                    "value": "Declined"
                },
                {
                    "name": "Message",
                    "value": "John Doe declined the envelope [Reason: I changed my mind.]"
                },
                {
                    "name": "EnvelopeStatus",
                    "value": "declined"
                },
                {
                    "name": "ClientIPAddress",
                    "value": "XX.XX.XX.XXX"
                },
                {
                    "name": "Information",
                    "value": "Reason: I changed my mind."
                },
                {
                    "name": "GeoLocation",
                    "value": ""
                },
                {
                    "name": "Language",
                    "value": "english (us)"
                }
            ]
        }
    ]
}

DocuSign REST API指南(https://10226ec94e53f4ca538f-0035e62ac0d194a46695a3b225d72cc8.ssl.cf2.rackcdn.com/rest-api-guide-v2.pdf)包含有关两个API调用的信息。

---更新---

您可以使用“ GET Envelope Documents ”API请求随时检索信封的文档(即,无论签名者/信封状态如何):

GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{{envelopeId}}/documents/combined

响应将包含一个字节流,表示PDF格式的Envelope文档的内容 - 然后您的应用程序可以简单地将该字节流写入浏览器以显示文档。有关此操作的详细信息,请参见“REST API指南”的第177页。

关于自定义“嵌入式发件人视图”的问题 - 无法通过API自定义发件人视图 - 即,'嵌入式发件人将始终能够执行他们能够执行的所有操作如果直接通过DocuSign Web控制台发送。