发送方如何隐藏字段?EnvelopeViews: createSender API相关咨询
DocuSign 发送方视图隐藏指定文件/标签的实现方案
一、隐藏「自定义文件」标签与标准分类下的指定文件
要实现这两个隐藏需求,核心是通过EnvelopeViews: createSender API的queryParameters配置特定参数,而非仅使用默认值:
- 隐藏「自定义文件」标签:在
queryParameters中设置hideDocumentMenuOptions为"custom",该参数会直接移除发送方视图中的「自定义文件」选项卡。 - 隐藏标准分类下的「公司」文件:添加
hideDocumentTypes参数并指定值为"company",即可过滤掉标准分类里的公司类文件。如果需要隐藏多个类型,用逗号分隔(比如"company,anotherType")。
二、正确配置EnvelopeViews: createSender API的参数
出现所有字段仍显示的问题,大多是因为没有正确传递queryParameters的自定义配置。以下是完整的API请求体示例(JSON格式):
{ "returnUrl": "https://your-domain.com/return", "authenticationMethod": "email", "queryParameters": { "hideDocumentMenuOptions": "custom", "hideDocumentTypes": "company", "defaultView": "send" } }
注意:
- 确保
queryParameters是请求体的直接子字段,而非嵌套在其他结构中。 - 如果使用SDK调用(如Python、Java),需对应设置
query_parameters属性的键值对,不要仅依赖默认构造函数的参数。
补充说明
如果需要更精细化的控制(比如仅对特定信封生效),可以在创建信封时通过envelopeDefinition的documents字段预先定义允许的文件类型,再结合sender view的参数配置,双重确保不需要的文件/标签被隐藏。
内容的提问来源于stack exchange,提问作者Itachi
相关产品推荐
相关产品推荐

