如何通过DocuSign API在发送文档时推送管理员通知至指定邮箱?
用DocuSign API实现指定邮箱接收候选人操作通知
嘿,这个需求我刚好经手过,其实不用复杂的额外开发,直接在创建信封的API请求里配置通知规则就行,DocuSign本身就支持这个功能。下面给你详细说怎么弄:
核心思路
你要的是当候选人查看、签署或拒绝文档时,把原本发给账户管理员的通知同步(或者替换)到指定邮箱。我们可以在创建信封的时候,给这个信封单独配置额外的管理员通知收件人,让DocuSign在触发对应事件时自动发邮件到你指定的地址。
具体操作步骤
1. 构造创建信封的API请求
调用创建信封的接口(POST /v2.1/accounts/{accountId}/envelopes)时,在请求体里加一个notification字段,专门用来配置额外通知。
2. 关键配置项拆解
additionalNotifications.recipients.email: 填你要接收通知的目标邮箱additionalNotifications.recipients.notificationType: 设为"Admin",告诉DocuSign这是管理员类型的通知收件人additionalNotifications.events: 列出你要触发通知的事件,比如:RecipientViewed:候选人打开查看文档时RecipientSigned:候选人完成签署时RecipientDeclined:候选人拒绝签署时
useAccountDefaultSettings: 设为false,表示用这个信封的自定义配置,不继承账户默认的通知规则
3. 现成的JSON请求示例
你可以直接参考这个结构来写代码:
{ "emailSubject": "请签署你的入职相关文档", "status": "sent", "recipients": { "signers": [ { "email": "candidate@yourcompany.com", "name": "候选人姓名", "recipientId": "1", "tabs": { // 这里放你的签署标签配置,比如签名框、日期栏之类的 } } ] }, "documents": [ { "documentId": "1", "name": "入职协议.pdf", "documentBase64": "这里填文档的base64编码内容" } ], "notification": { "additionalNotifications": [ { "recipients": { "email": "your-target-email@example.com", "name": "通知接收人名称", "notificationType": "Admin" }, "events": [ "RecipientViewed", "RecipientSigned", "RecipientDeclined" ], "useAccountDefaultSettings": false } ] } }
4. 几个要注意的点
- 确保你的API账号有账户管理员权限,不然可能没法配置这个通知规则
- 如果想保留原账户管理员的通知,不用改账户默认设置,只加这个额外收件人就行,两边都会收到邮件
- 事件列表可以灵活调整,比如还能加
EnvelopeCompleted(整个信封所有签署完成时)这类事件,根据你的需求来
备选方案:全局配置
如果你希望所有新创建的信封都自动把这类通知发到指定邮箱,也可以调用账户层面的API(PUT /v2.1/accounts/{accountId}/notification_settings)修改账户默认的通知收件人。不过这个是全局生效的,不如单个信封配置灵活,看你需求选就行。
内容的提问来源于stack exchange,提问作者Kannan
相关产品推荐
相关产品推荐

