调用GET envelopes API时folder_ids参数传值报错问题咨询

问题原因 #

你传入的folder_ids参数值存在三处不符合API规则的问题：

• 拼写格式不匹配官方预设枚举值：Sent Items（带空格、大小写错误）、sent_items（多了下划线）都不是官方允许的固定值，官方规定的已发送文件夹对应参数值为全小写无下划线的sentitems
• 参数值额外包裹了单引号：API会将你传入的单引号识别为参数值的一部分，无法匹配到预设的合法值
• URL传参格式错误：直接拼接在URL中的参数值不需要加引号，&folder_ids='completed'的写法会导致整体参数值非法

官方返回的错误信息已经明确列出所有合法枚举值："message": "The request contained at least one invalid parameter. folder_ids must be a comma separated list of either valid folder Guids or 'awaiting_my_signature', 'completed', 'draft', 'drafts', 'expiring_soon', 'inbox', 'out_for_signature', 'recyclebin', 'sentitems' or 'waiting_for_others'."

修正方案 #

• 严格按照官方给出的枚举值拼写传入参数，大小写、符号完全一致，已发送文件夹请传入sentitems，已完成文件夹请传入completed
• URL传参时直接写值即可，不需要加任何引号，示例：folder_ids=sentitems、folder_ids=completed
• 如果需要同时查询多个文件夹，将多个合法值用英文逗号直接拼接，不需要加空格，示例：folder_ids=sentitems,completed
• 如果你要查询自定义文件夹，需要传入对应文件夹的有效GUID，不能使用自定义名称

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