求助：使用API V2.1通过复合模板创建信封并填充ListTabs值

问题详情 #

我尝试通过复合模板创建信封并填充ListTabs的选中值，但无论用哪种请求方式，下拉列表的选项都无法被选中。

已尝试的请求 #

请求1 #

端点：/restapi/v2.1/accounts/e52b70de-**************-dd90c61f9eac/envelopes

{
  "status": "sent",
  "compositeTemplates": [
    {
      "compositeTemplateId": "1",
      "serverTemplates": [
        {
          "templateId": "a975e66**********************68f3fb0d19",
          "sequence": "1"
        }
      ],
      "inlineTemplates": [
        {
          "sequence": "1",
          "recipients": {
            "signers": [
              {
                "email": "test@gmail.com",
                "name": "test user",
                "clientUserId": "15623477",
                "roleName": "Tester",
                "recipientId": "76987934",
                "tabs": {
                  "listTabs": [
                    {
                      "value": "ONE",
                      "tabLabel": "Dropdown",
                      "tabType": "list",
                      "documentId": "1"
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

请求2 #

{
 "status": "sent",
 "compositeTemplates": [
   {
     "compositeTemplateId": "1",
     "serverTemplates": [
       {
         "templateId": "a975e66**********************68f3fb0d19",
         "sequence": "1"
       }
     ],
     "inlineTemplates": [
       {
         "sequence": "1",
         "recipients": {
           "signers": [
             {
               "email": "test@gmail.com",
               "name": "test user",
               "clientUserId": "15623477",
               "roleName": "Tester",
               "recipientId": "76987934",
               "tabs": {
                 "listTabs": [
                   {
                     "tabId": "fd07f90c-e98c-4ee9-bcd8-8a46dcbace1f",
                     "value": "ONE"
                   }
                 ]
               }
             }
           ]
         }
       }
     ]
   }
 ]
}

模板中ListTabs的原始数据 #

通过/restapi/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs接口获取的ListTabs信息：

"listTabs": [
    {
      "listItems": [
        {
          "text": "ONE",
          "value": "ONE",
          "selected": "false"
        },
        {
          "text": "TWO",
          "value": "TWO",
          "selected": "false"
        }
      ],
      "value": "",
      "originalValue": "",
      "shared": "false",
      "required": "true",
      "locked": "false",
      "requireAll": "false",
      "tabLabel": "Dropdown",
      "font": "lucidaconsole",
      "fontColor": "black",
      "fontSize": "size9",
      "localePolicy": {},
      "documentId": "1",
      "recipientId": "76987934",
      "pageNumber": "1",
      "xPosition": "236",
      "yPosition": "229",
      "width": "78",
      "height": "0",
      "tabId": "fd07f90c-e98c-4ee9-bcd8-8a46dcbace1f",
      "templateLocked": "false",
      "templateRequired": "false",
      "tabType": "list"
    }
  ]

解决方案 #

在复合模板的inlineTemplate中设置ListTabs时，需确保同时指定tabId和value，并注意以下细节：

• tabId必须与模板中获取的ListTabs的tabId完全一致
• value要和模板中listItems里的value字段完全匹配（区分大小写）
• 无需重复指定tabLabel、documentId等冗余字段

修正后的请求示例：

{
  "status": "sent",
  "compositeTemplates": [
    {
      "compositeTemplateId": "1",
      "serverTemplates": [
        {
          "templateId": "a975e66**********************68f3fb0d19",
          "sequence": "1"
        }
      ],
      "inlineTemplates": [
        {
          "sequence": "1",
          "recipients": {
            "signers": [
              {
                "email": "test@gmail.com",
                "name": "test user",
                "clientUserId": "15623477",
                "roleName": "Tester",
                "recipientId": "76987934",
                "tabs": {
                  "listTabs": [
                    {
                      "tabId": "fd07f90c-e98c-4ee9-bcd8-8a46dcbace1f",
                      "value": "ONE"
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

若仍无效，可排查以下几点：

• 确认复合模板的sequence设置正确，确保inlineTemplate的序列能覆盖或合并serverTemplate的内容
• 检查签名者的recipientId与模板中的recipientId完全一致
• 查看API响应是否存在报错信息，排除请求语法错误

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