通过文件发起合同
POST
/open/contract/start
注意
1.
2.
3.
4.
| 错误码 | 错误信息 | 解决办法 |
|---|---|---|
| 500 | 服务繁忙,请重试. | 联系客服 |
| 400 | 参数错误. | 参数与接口文档进行核对 |
| oc_10011 | 用户未认证 | 进行认证 |
| oc_30005 | 上传文件格式不支持 | 更换支持发起合同以及附件格式的文件 |
| oc_30006 | 文件处理失败 | 重新发起，或联系客服 |
| oc_40001 | 签署截止时间不能超过12个月 | 检查参数 |
| oc_40002 | 签署截止时间不能小于当前时间 | 检查参数 |
| oc_40003 | 签署方不可重复 | 检查参数 |
| oc_40014 | 合同doc文件不能重复 | 检查参数 |
| oc_40016 | 签署位置不能重复 | 检查参数 |
| oc_40020 | 单页合同文件不能进行骑缝签章 | 检查参数 |
| oc_40027 | 同一签署方不能同时配置静默签和普通签署 | 检查参数 |
请求参数
Body 参数application/json
示例
{
"signFileType": "PDF",
"docs": [
{
"fileId": "1",
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"fileOrder": 1,
"fileName": "test_file1.docx"
}
],
"attachmentFiles": [
{
"fileCode": "FC_20241212164445yYmxlZvwHGQysio",
"fileOrder": 1
}
],
"signFlowInitiator": {
"accountId": "CORP_TEST_001"
},
"signers": [
{
"accountId": "PSN_TEST_001",
"seqNo": 1,
"signFields": [
{
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"signFieldStyle": 1,
"dateFormat": "YYYY-MM-DD",
"authorizeCode": "RkztvLleUICgRSe",
"signFieldPosition": {
"positionPage": 1,
"positionX": 280,
"positionY": 420
}
},
{
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"signFieldStyle": 1,
"dateFormat": "YYYY-MM-DD",
"authorizeCode": "RkztvLleUICgRSe",
"signFieldPosition": {
"positionPage": 1,
"positionX": 400,
"positionY": 300
}
}
],
"authConfig": {
"willingnessAuthModes": [
"CODE_SMS"
]
},
"noticeConfig": {
"noticeTypes": 0
}
},
{
"accountId": "PSN_TEST_002",
"seqNo": 2,
"signFields": [
{
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"signFieldStyle": 1,
"dateFormat": "YYYY-MM-DD",
"authorizeCode": "vLleUI7",
"signFieldPosition": {
"positionPage": 1,
"positionX": 600,
"positionY": 200
}
},
{
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"signFieldStyle": 1,
"dateFormat": "YYYY-MM-DD",
"authorizeCode": "vLleUI7",
"signFieldPosition": {
"positionPage": 1,
"positionX": 100,
"positionY": 500
}
}
],
"authConfig": {
"willingnessAuthModes": [
"CODE_SMS"
]
},
"noticeConfig": {
"noticeTypes": 0
}
},
{
"accountId": "PSN_TEST_003",
"seqNo": 1,
"signFields": [
{
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"signFieldStyle": 1,
"dateFormat": "YYYY-MM-DD",
"authorizeCode": "7",
"signFieldPosition": {
"positionPage": 1,
"positionX": 28,
"positionY": 42
}
},
{
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"signFieldStyle": 1,
"dateFormat": "YYYY-MM-DD",
"authorizeCode": "7",
"signFieldPosition": {
"positionPage": 1,
"positionX": 28,
"positionY": 42
}
}
],
"authConfig": {
"willingnessAuthModes": [
"CODE_SMS"
]
},
"noticeConfig": {
"noticeTypes": 0
}
}
],
"signFlowConfigs": {
"flowConfig": {
"contractName": "测试合同",
"businessCode": "241212171254RkztvLle",
"seqSigning": false,
"signDeadline": "2025-12-31"
},
"integrationConfig": {
"signRedirectConfig": {
"redirectUrl": "https://spanish-gray.net/",
"redirectDelayTime": 3
},
"evidenceConfig": [3]
}
}
}请求示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'api.pre-qiandun365.com/api/open/contract/start' \
--header 'Content-Type: application/json' \
--data-raw '{
"signFileType": "PDF",
"docs": [
{
"fileId": "1",
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"fileOrder": 1,
"fileName": "test_file1.docx"
}
],
"attachmentFiles": [
{
"fileCode": "FC_20241212164445yYmxlZvwHGQysio",
"fileOrder": 1
}
],
"signFlowInitiator": {
"accountId": "CORP_TEST_001"
},
"signers": [
{
"accountId": "PSN_TEST_001",
"seqNo": 1,
"signFields": [
{
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"signFieldStyle": 1,
"dateFormat": "YYYY-MM-DD",
"authorizeCode": "RkztvLleUICgRSe",
"signFieldPosition": {
"positionPage": 1,
"positionX": 280,
"positionY": 420
}
},
{
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"signFieldStyle": 1,
"dateFormat": "YYYY-MM-DD",
"authorizeCode": "RkztvLleUICgRSe",
"signFieldPosition": {
"positionPage": 1,
"positionX": 400,
"positionY": 300
}
}
],
"authConfig": {
"willingnessAuthModes": [
"CODE_SMS"
]
},
"noticeConfig": {
"noticeTypes": 0
}
},
{
"accountId": "PSN_TEST_002",
"seqNo": 2,
"signFields": [
{
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"signFieldStyle": 1,
"dateFormat": "YYYY-MM-DD",
"authorizeCode": "vLleUI7",
"signFieldPosition": {
"positionPage": 1,
"positionX": 600,
"positionY": 200
}
},
{
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"signFieldStyle": 1,
"dateFormat": "YYYY-MM-DD",
"authorizeCode": "vLleUI7",
"signFieldPosition": {
"positionPage": 1,
"positionX": 100,
"positionY": 500
}
}
],
"authConfig": {
"willingnessAuthModes": [
"CODE_SMS"
]
},
"noticeConfig": {
"noticeTypes": 0
}
},
{
"accountId": "PSN_TEST_003",
"seqNo": 1,
"signFields": [
{
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"signFieldStyle": 1,
"dateFormat": "YYYY-MM-DD",
"authorizeCode": "7",
"signFieldPosition": {
"positionPage": 1,
"positionX": 28,
"positionY": 42
}
},
{
"fileCode": "FC_20241212171254RkztvLleUICgRSe",
"signFieldStyle": 1,
"dateFormat": "YYYY-MM-DD",
"authorizeCode": "7",
"signFieldPosition": {
"positionPage": 1,
"positionX": 28,
"positionY": 42
}
}
],
"authConfig": {
"willingnessAuthModes": [
"CODE_SMS"
]
},
"noticeConfig": {
"noticeTypes": 0
}
}
],
"signFlowConfigs": {
"flowConfig": {
"contractName": "测试合同",
"businessCode": "241212171254RkztvLle",
"seqSigning": false,
"signDeadline": "2025-12-31"
},
"integrationConfig": {
"signRedirectConfig": {
"redirectUrl": "https://spanish-gray.net/",
"redirectDelayTime": 3
},
"evidenceConfig": [3]
}
}
}'返回响应
🟢200成功
application/json
Body
示例
{
"code": "string",
"msg": "string",
"result": {
"contractId": 0,
"businessCode": "string",
" signersInfos": [
{
"accountId": "string",
"seqNo": 0
}
]
},
"success": true,
"logKey": "string",
"ts": "string"
}修改于 2025-11-10 09:18:16