如何使用DocuSign Python SDK给未签署用户发送信封提醒？

要给未签署的用户发送特定信封的提醒，你可以通过DocuSign Python SDK的EnvelopesApi.create_reminder方法实现，以下是具体步骤和代码示例：

核心步骤 #

1. 准备必要参数：DocuSign账户ID、目标信封ID、收件人ID（或目标收件人邮箱）、有效的API访问令牌
2. 初始化EnvelopesApi客户端（与创建信封时的配置一致）
3. 构建ReminderRequest对象，配置提醒内容和目标收件人
4. 调用create_reminder方法触发提醒发送

代码示例 #

1. 导入依赖模块 #

from docusign_esign import ApiClient, EnvelopesApi, ReminderRequest
from docusign_esign.client.api_exception import ApiException

2. 手动触发即时提醒 #

# 初始化API客户端（替换为你的实际配置）
api_client = ApiClient()
api_client.host = "https://demo.docusign.net/restapi"  # 生产环境替换为 https://www.docusign.net/restapi
api_client.set_default_header("Authorization", "Bearer YOUR_ACCESS_TOKEN")

envelopes_api = EnvelopesApi(api_client)

# 构建提醒请求参数
reminder_request = ReminderRequest(
    reminder_enabled="true",
    recipient_id="YOUR_RECIPIENT_ID",  # 替换为目标收件人的ID
    reminder_email_subject="请尽快完成文档签署",
    reminder_email_body="您好，您有一份待签署的文档已超过两周未处理，请登录DocuSign完成签署操作。",
    reminder_delay="0"  # 设置为0表示立即发送提醒
)

try:
    # 发送提醒
    response = envelopes_api.create_reminder(
        account_id="YOUR_ACCOUNT_ID",
        envelope_id="TARGET_ENVELOPE_ID",
        reminder_request=reminder_request
    )
    print(f"提醒发送成功，响应状态: {response.status}")
except ApiException as e:
    print(f"发送提醒失败: {e.body}")

3. 获取收件人ID（如果未知） #

如果不知道目标收件人的ID，可以通过查询信封的收件人列表获取：

# 查询信封的收件人信息
recipients = envelopes_api.list_recipients(
    account_id="YOUR_ACCOUNT_ID",
    envelope_id="TARGET_ENVELOPE_ID"
)
# 遍历找到目标用户的ID
for recipient in recipients.signers:
    if recipient.email == "TARGET_RECIPIENT_EMAIL":
        print(f"收件人ID: {recipient.recipient_id}")

可选：创建信封时设置自动提醒规则 #

如果希望系统自动在信封创建两周后发送提醒，可在创建信封时配置自动规则：

from docusign_esign import EnvelopeDefinition, Reminders

# 构建自动提醒规则
reminders = Reminders(
    reminder_enabled="true",
    reminder_delay="14",  # 信封创建后14天发送第一次提醒
    reminder_frequency="7"  # 之后每隔7天发送一次提醒（可选）
)

# 构建信封定义时添加提醒配置
envelope_definition = EnvelopeDefinition(
    # 你的信封其他配置（文档、收件人等）
    reminders=reminders
)

# 后续创建信封的代码保持不变

注意事项 #

• 确保API访问令牌具有信封管理权限（信封创建者默认拥有该权限）
• 沙箱环境与生产环境的API域名不同，注意区分
• 若通过邮箱定位收件人，可在ReminderRequest中用email参数替代recipient_id，但使用recipient_id更精准

内容的提问来源于stack exchange，提问作者pratik chilate