使用DocuSign API添加补充文档遇View Tab问题求助

错误原因分析 #

你遇到的错误The view tab is not allowed on a document with display inline，核心原因是你关联View Tab的文档实际display属性仍被识别为inline，即便你认为已设置为modal。需确认该属性是否正确配置在目标补充文档（即documentId: "1"的文档）上。

View Tab 核心用法 #

View Tab 用于让接收者查看指定的补充文档，它有个硬性要求：必须关联到display属性设为modal的补充文档，不能用于默认inline显示的主文档。

正确配置步骤 #

1. 正确定义补充文档 #

在documents数组中，为目标补充文档设置display: "modal"，示例如下：

"documents": [
  {
    "documentId": "1",
    "name": "补充文档.pdf",
    "fileExtension": "pdf",
    "documentBase64": "你的文档Base64编码内容",
    "display": "modal" // 必须设置该属性，且仅针对补充文档
  }
]

2. 修正View Tab配置 #

你的代码中多余的xPosition和yPosition字段是不必要的（因为文档以弹窗形式展示，无需页面定位），删除后即可避免冲突。修正后的标签配置：

"tabs": {
  "viewTabs": [
    {
      "recipientId": "1",
      "tabLabel": "exampleViewTab",
      "documentId": "1",
      "pageNumber": "1"
    }
  ]
}

3. 接收者与标签关联 #

将View Tab配置嵌套到对应接收者的tabs字段中，确保recipientId与接收者ID完全匹配：

"signers": [
  {
    "email": "recipient@example.com",
    "name": "接收者姓名",
    "recipientId": "1",
    "tabs": {
      "viewTabs": [
        {
          "tabLabel": "exampleViewTab",
          "documentId": "1",
          "pageNumber": "1"
        }
      ]
    }
  }
]

关键注意事项 #

• View Tab 仅支持modal类型的补充文档，主文档（默认inline）无法使用该标签
• 无需设置页面定位坐标（x/yPosition），弹窗展示的文档不需要这些参数
• 务必保证documentId在文档定义和标签配置中完全一致

内容的提问来源于stack exchange，提问作者Anushka Mestry