接口常见报错
接口调用报错如何处理?
您可以尝试按照接口返回的 message 的提示进行修改,或者记录下 requestId 并提供给对接人员进行处理。
接口调用返回签名错误?
请先检查 SecretId 和 SecretKey 是否正确。如果您未使用 SDK 进行接入,请参见腾讯云官方 开发指南 中的样例代码进行签名计算。
StartFlow(发起流程)接口报错,提示“文档不可用”?
在调用 CreateDocument 接口后,需要等待文档的异步合成,所以不能立即调用 StartFlow 接口;如果调用 StartFlow 报错,可以尝试等待后重试。
CreateDocument(创建电子文档)接口报错,提示“流程已关联文档”?
每个流程有且仅有一次能用于绑定文档,请重新使用 CreateFlow 接口创建新的流程。
接口调用时返回没有权限,该如何处理?
如接口调用时返回没有权限,此接口可能为白名单接口,需添加白名单权限。
同一份合同中的同一签署人不可同时以企业及个人身份签署
同一个自然人,不能同时作为个人和企业(经办人)两个签署方去签署。
解决方式:
- 方式一:合同只保留企业签署方(去掉个人签署方),并指定印章和签字两个签署控件;
- 方式二:如果除了此自然人外,合同还有其他签署方,可联系客户经理给开白处理。
如果合同涉及到本方企业自动签署,其经办人取的合同发起人(即自建应用是
Operator.UserId
,第三方应用是Agent.ProxyOperator.OpenId
),请确保此员工和个人签署方不是一个人。
其他公司自动签署功能暂未开放,请联系客户经理申请【他方自动签署权限】后使用
假设合同由A企业发起(即调接口使用的API密钥来自于A企业),签署方为另外一个企业(B企业),如果需要B企业自动签署,请参考:
本企业自动签印章无权限使用
- 请检查传入的印章是否存在并启用
- 请检查经办人是否有此印章权限。需要注意的是对于自动签署而言,经办人默认为发起人且不能更改。具体请参考以下:
- 自建应用:发起人为
Operator.UserId
。 - 第三方应用:发起人为
Agent.ProxyOperator.OpenId
。
合作方企业自动签印章未授权
自建应用: 假设合同由A企业发起(即调接口使用的API密钥来自于A企业),签署方为另外一个企业(B企业),如果需要B企业自动签署,则被称为合作方企业自动签,需要B企业授权操作。
情况1: 若采用B企业主动给A企业授权,请参考让合作方主动给我授权。
情况2: 若采用A企业邀请B企业给固定模板授权,请参考邀请合作方给我授权。
第三方应用: 假设合同由A企业发起(
Agent.ProxyOrganizationOpenId
为A子客的OpenId),签署方为另外一个子客(B企业),如果需要B企业自动签署,则被称为合作方企业自动签,需要B企业授权操作,请参考合作方企业自动签署。
- 比如B企业给A企业只授权了「公章」,但发起合同时传入了「财务专用章」的印章ID,那也会报此错误。
- 在自建应用情况2中,如果被授权的模板发生了变更,授权会失效,需要重新授权。
在此合同中不存在该签署人,请确认传入的签署人信息是否正确
请检查是否发起合同时指定了签署人身份证号,但获取H5签署链接时没有指定。如果签署人之前已经在电子签实名过,且绑定的手机号并非获取签署链接时传入的手机号,就会报此错误。
例如:比如发起合同时指定了张三,手机号133,身份证号abc。由于张三之前在电子签实名过,且绑定的手机号为188,则发起的这个合同就关联到了188手机号。再用133手机号去获取签署链接就会报错。
解决方式:
- 方式1:引导用户直接去小程序签署
- 方式2:获取签署链接时也传入身份证号
- 方式3:发起合同时不传身份证号,上例中张三会在签署过程中将绑定的手机号更换为133(需要注意的是换绑过程133手机号需要收验证码,请确保133为张三当前在用的手机号)
未在合同中找到您提供的签署人信息。请核对姓名、手机号等提供的信息是否正确
请检查是否发起合同时指定了签署人身份证号,但获取合同组签署链接时没有指定。如果签署人之前已经在电子签实名过,且绑定的手机号并非获取签署链接时传入的手机号,就会报此错误。
例如:比如发起合同时指定了张三,手机号133,身份证号abc。由于张三之前在电子签实名过,且绑定的手机号为188,则发起的这个合同就关联到了188手机号。再用133手机号去获取签署链接就会报错。
解决方式:
- 方式1:引导用户直接去小程序签署。
- 方式2:获取签署链接时也传入身份证号。
参数错误,指定的操作人不存在/不属于当前企业
操作人是指接口中的Operator.UserId
参数,请先确认UserId是否取的是企业员工的用户ID:
另外一个常见原因是,这里的用户ID传入了正式(测试)环境的企业员工,而接口请求到了测试(正式)环境。
联调环境地址:
环境 | 地址 | 说明 |
---|---|---|
文件服务的EndPoint | file.test.ess.tencent.cn | UploadFiles接口使用 |
通用接口请求EndPoint | ess.test.ess.tencent.cn | 除UploadFiles外其他接口使用 |
线上环境地址:
环境 | 地址 | 说明 |
---|---|---|
文件服务的EndPoint | file.ess.tencent.cn | UploadFiles接口使用 |
通用接口请求EndPoint | ess.tencentcloudapi.com | 除UploadFiles外其他接口使用 |
在这个PDF中没有搜索到[xxx],请确认这个字符串是否存在
用关键字定位控件时报此错误,可以借助Adobe Acrobat Reader等PDF阅读器查找是否有对应关键字。另外一个常见问题是在传参时指定了KeywordPage
,即限定了搜索页码,请确认是否是此原因造成。
控件的X(Y) 坐标超出了允许范围
请检查控件是否超过了PDF的最大宽度(595)或者最大高度(842),尤其需要注意,是否将PDF旋转了(宽842,高595)。
PDF文件损坏,请上传正确的PDF文件
出现这种情况是指传入的PDF文件结构不规范,电子签无法处理此类文件。可以用PDF阅读器(例如Adobe Acrobat Reader、福昕等)检查文件签名是否完整。比如以下文件已损坏:
您输入的内容含不允许的敏感词汇
如果是签署方姓名、企业名称,可以选择使用模板发起合同,使用签署方信息控件;
如果是其他的填写控件,可以联系电子签侧处理后再操作。
参数错误,签署人填写控件不支持[SIGN_SEAL]类型
请检查是否传参时将签署控件(SignComponents
)字段写成了填写控件(Components
)。
用户[xxx]未开启或已关闭自动签服务
在发起带有个人自动签功能的合同时,如果报此错误,并且已确认该签署人已经开通了个人自动签。请检查是否签署人开通自动签时的手机号,和发起合同时传入的手机号不一致。
发起方签署审核/节点签署审核不能同时使用
请检查代表签署审批的参数NeedSignReview是指定到哪个维度的:
- 如果指定的是合同维度的
NeedSignReview
参数,在调审批接口时无需传RecipientId
。 - 如果指定的是签署方维度的
ApproverNeedSignReview
,在调审批接口时必须传RecipientId
。
您当前正在使用【自建应用集成】功能,升级至【专业版】及以上版本后即可使用
如果是通过集团主代子的方式调用接口报此错误,请联系电子签客户经理开白处理。
签署人RecipientId不属于当前模版
在调用CreatePrepareFlow接口时报此错误,请确认是否模板发生了调整,模板的任意变化都可能导致RecipientId变更。
您上传的文件不是PDF格式,导致无法发起合同
通过文件发起合同时,仅支持PDF格式的文件。需要注意的是,如果通过创建文件转换任务接口对源文件格式进行了转换,还需要调查询转换任务状态接口去获取转换后的ResourceId
(PDF格式),用于合同发起。
缺少登录用户ID,请检查登录账号并重试
自建应用集成中,所有接口的Operator
字段都是必传,请检查是否少传了此参数。如果没有用电子签提供的SDK(不建议),请确保传入的所有字段为大写字母开头。