平台简介
新手指南
API协议
API文档
单点登录集成
小程序插件
APP SDK
常见问题
开放平台对接场景示例
开放平台API接口调用常见报错以及解决方法汇总
帮助中心 / 开放平台帮助文档 / 接口响应码说明
接口响应码说明
接口响应码说明

接口响应码说明

正式环境地址:

​ 云平台:https://cloud.qiyuesuo.com 开放平台:https://open.qiyuesuo.com

测试环境地址:

​ 云平台:https://cloud.qiyuesuo.cn 开放平台:https://open.qiyuesuo.cn

1.创建合同

1.1创建合同草稿

  1. 1101 [INVALID CONTRACT STATUS]

    合同状态无效。检查合同状态,已发起的合同不能再创建成草稿合同。

  2. 1102 [DUPLICATE SIGNATORY]

    存在重复的签署方。检查接口参数signatories,并去除重复的签署方。

  3. 1103 [ACTION REQUIRED]

    缺少action参数。根据接口提示,检查相应的签署方是否缺少action参数。签署方为公司时,签署action可以由参数传入,也可以使用业务分类中配置的签署流程。

  4. 1105 [ACTION OPERATORS REQUIRED]

    缺少操作人。签署方为公司时,其下的“审批”节点必须设置操作人。

  5. 1111 [OPERATOR REQUIRED]

    缺少经办人。检查签署流程中是否存在经办人环节,并在对应的签署方参数中增加receiver参数。

  6. 1113 [SIGNATORY REQUIRED]

    缺少签署方。接口参数中缺少"signatories"或者"signatories"为空时,提示该错误。

  7. 1201 [SEAL NOT FOUND]

    找不到印章。登陆云平台检查当前配置的印章ID是否填写有误。

  8. 1203 [INVALID SEAL STATUS]

    印章不是正常状态。登陆云平台检查当前配置的印章是否是正常状态。

  9. 1301[CATEGORY CONFIG NOT MATCH ]

    接口中配置的签署方与业务分类中预设方式配置的签署方顺序/数量不一致。登录云平台的业务分类模块下,找到对应的业务分类,检查签署方的数量和顺序是否和参数中配置的一致。

  10. 1401[DOCUMENT REQUIRED]

    缺少合同文档。当"send"参数设置为“true”时,意味着创建并发起合同,此时要求合同必须有合同文档,可通过接口添加合同文件后再发起合同,或者登陆云平台,在相应的业务分类中配置相应的文档即可。

  11. 1701[EMPLOYEE NOT FOUND]

    找不到员工。检查发起方的“receiver"或者“creator”参数配置的人员是否为该企业的员工。

  12. 1702[EMPLOYEE DISMISSED]

    员工已离职。检查发起方的“receiver"或者“creator”参数配置的人员是否已从该企业离职。

  13. 1705[EMPLOYEE NOT REGISTE]

    员工未注册。检查发起方的“receiver"或者“creator”参数配置的人员是否还未在平台注册,请先完成注册再发起合同。

  14. 1116[DOCUMENT PARAM LACK]

    发起方未将必填参数填写完。请根据接口返回的参数字段名称提示完成未填的参数配置。

1.2添加合同文档

  1. 1101 [INVALID CONTRACT STATUS]

    合同状态无效。检查合同状态,可登陆云平台或者通过“查询合同”接口检查合同状态是否为“草稿”,只能为“草稿”状态合同添加文档。

  2. 1403 [INVALID FILE]

    无效的合同文件。合同文件转换失败,可能是由于文件损坏或者文件类型错误。

1.3发起合同

  1. 1101 [INVALID CONTRACT STATUS]

    合同状态无效。检查合同状态,可登陆云平台或者通过“查询合同”接口检查合同状态是否为“草稿”,只能发起状态为“草稿”的合同。

  2. 1108 [KEYWORD NOT FOUND]

    未找到关键字。请检查文档中是否存在该关键字,注意与“keywordIndex”参数要配置正确。

  3. 1109 [SIGN PAGE BEYOND]

    签署页码超出文档页数。当参数中没有设置“keyword"和”keywordIndex“时,若设置的“page”数值大于实际页码,则返回该错误。

  4. 1203 [INVALID SEAL STATUS]

    无效的印章状态。可登陆云平台检查印章状态。

  5. 1116[DOCUMENT PARAM LACK]

    发起方未将必填参数填写完。请根据接口返回的参数字段名称提示完成未填的参数配置。

2签署合同

2.1签署公章

  1. 1106 [INVALID STAMPER TYPE]

    无效的签章类型。检查"stampers"参数中的type属性,签署公章支持的签章类型如下: COMPANY(公章),TIMESTAMP(时间戳),ACROSS_PAGE(骑缝章)

  2. 1107 [NOT SIGN STEP]

    未轮到签署。未轮到公司签署公章或者没有签署公章节点。可登陆云平台查看合同的当前签署节点。

  3. 1109 [SIGN PAGE BEYOND]

    签署页码超出文档页数。检查"stampers"参数中的page属性是否超出了文档的总页数。

  4. 1201 [SEAL NOT FOUND]

    找不到印章。可登陆云平台,检查当前“sealId”是否配置正确。

2.2签署法人章

  1. 1106 [INVALID STAMPER TYPE]

    无效的签章类型。检查"stampers"参数中的type属性,签署法人章支持的签章类型如下:LP(法人章),TIMESTAMP(时间戳)。

  2. 1107 [NOT SIGN STEP]

    未轮到签署。未轮到公司签署法人章或者没有签署法人章节点。可登陆云平台查看合同的当前签署节点。

  3. 1109 [SIGN PAGE BEYOND]

    签署页码超出文档页数。检查"stampers"参数中的page属性是否超出了文档的总页数。

  4. 1201 [SEAL NOT FOUND]

    找不到法人章。请确保在契约锁已维护法人章。

2.3审批

  1. 1107 [NOT SIGN STEP]

    未轮到员工审批,或者没有员工审批节点。可登陆云平台查看合同的当前签署节点。

2.4签署页面

  1. 1110 [NO VIEW PERMISSION]

    没有查看权限。用户没有权限查看合同,请核对操作人的配置。

2.5 撤回/作废合同

  1. 1101 [INVALID CONTRACT STATUS]

    无效的合同状态。以下是支持的合同状态及对应操作:DRAFT(草稿):删除合同;FILLING(填参中),SIGNING(签署中):撤回合同;COMPLETE(已完成):发起作废、并签署发起方。

3合同页面

3.1签署页面

  1. 1110[NO VIEW PERMISSION]

    没有查看权限。请检查合同当前签署方是否与接口user参数一致。

3.2浏览页面

  1. 1401[DOCUMENT REQUIRED]

    合同不包含任何文件,不允许查看。合同为未添加合同文件的草稿状态时,不允许查看,请先添加合同文件后再浏览合同

3.3获取短链接

  1. 1101[INVALID CONTRACT STATUS]

    合同不能为草稿。草稿状态合同不允许获取短链接,请先发起合同再获取短链接。

4员工接口

4.1添加员工

  1. 1703 [EMPLOYEE NAME NOT MATCH]

    员工的姓名和实际姓名不匹配。员工在契约锁已认证时,传入的员工姓名必须与真实的员工姓名一致。

4.2更新员工

  1. 1701 [EMPLOYEE NOT FOUND]

    找不到员工。检查要更新的员工是否已加入企业,如果未加入,请先添加员工再进行更新操作。

  2. 1703 [EMPLOYEE NAME NOT MATCH]

    员工的姓名和实际姓名不匹配。员工在契约锁已认证时,传入的员工姓名必须与真实的员工姓名一致。

4.3移除员工

  1. 1701 [EMPLOYEE NOT FOUND]

    员工已被移除或者不存在。可登陆云平台,公司->组织与成员模块下,勾选"含离职",确认该员工是否已被移除或未在成员列表中。

5全局响应码

  1. 0 [SUCCESS]

    接口调用成功。

  2. 1001 [ERROR]

    服务器内部错误。

  3. 1002 [PERMISSION DENIED]

    没有接口调用权限。联系客服,开通相关接口的权限。

  4. 1005 [INVALID PARAM]

    无效的参数。根据接口返回信息提示,检查相应的参数,确认是否遗漏或者填写错误,并修正。

  5. 1601 [INSUFFICIENT BALANCE]

    余额不足。可以通过打款充值,或者联系管理员。