发起签署任务 - 大家签公有云-OpenAPI

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

EnvelopeCreationReqVO :EnvelopeCreationReqVO

basicInfo

object

必需

基本信息 ,EnvelopeBasicCreationInfoVO

title

string

信封标题

必需

remark

string

备注信息

可选

seqType

number

必需

参与者签署节点顺序类型：,0-无序签署；1-有序签署。

expireDatetime

string

必需

信封到期时间：,格式"yyyy-MM-ddHH:mm:ss"。

redirectUrl

string

可选

参与者签署成功后，页面跳转地址

participantList

array [object {14}]

必需

参与者信息 ,ParticipantCreationInfoVO

participantRefId

string

参与者引用Id

必需

name

string

可选

参与者个人（或经办人）姓名

userType

number

必需

参与者用户类型;,0-个人用户；1-企业成员(经办人)2-企业(企业主体名称-应用名称)。

mobile

string

可选

参与者个人（或经办人）手机号

idType

number

可选

证件类型: 0 身份证

idNo

string

可选

证件号，证件号不为空时证件类型必填

enterpriseName

string

可选

企业名称（参与者用户类型为企业成员、企业时，必填）

creditCode

string

可选

企业统一社会信用代码（参与者用户类型为企业成员、企业时，必填）

assignedSeq

number

可选

参与者签署顺序（有序签署时，必填）

allowAddForms

boolean

可选

是否允许参与者在签署时追加表单：,true-允许；false-不允许。,备注：如果参与者没有预设表单，该字段暂值将被忽略。,默认值：true。

signMode

number

可选

参与者签署处理模式：,0-正常模式（即从门户进行签署）；,1-静默签署。,备注：静默签署时，该字段值将被忽略,应用签署值为1-静默签署。,,默认值：0。

willingAuth

number

可选

签署意愿认证方式：
1 - 签署密码意愿认证；
2 - 短信验证码意愿认证；
3 - 签署密码或短信验证码意愿认证；
4 - 人脸意愿认证；
5 - 签署密码或人脸意愿认证；
6 - 短信或人脸意愿认证；
7 - 短信或签署密码或人脸意愿认证；
默认：本企业支持的所有意愿认证方式；

callbackUrl

string

可选

参与者签署成功后，回调通知地址

notifyType

number

可选

签署通知类型：,0-无通知；,1-简单短信通知；,2-附带签署链接的短信通知。,默认值：0。

contentList

array [object {2}]

必需

信封内容信息 ,ContentCreationInfoVO

fileTId

string

内容文件Id

必需

attachment

boolean

可选

是否为附件:,true-附件（辅助材料）；false-签署文档。,默认值：true。

formList

array [object {6}]

可选

表单信息 ,FormCreationInfoVO

participantRefId

string

参与者引用Id

必需

fileTId

string

表单域所在文件Id

必需

formType

number

必需

表单域类型：0-个人签名；1-印章；2-骑缝章; 3-日期。备注：应用签署必须使用印章签署

sealType

number

可选

当前参与者(企业用户)可使用的印章类型，可选值：
101 - 法定名称章（公章）；
102 - 财务专用章；
103 - 发票专用章；
104 - 法定代表人章；
105 - 合同专用章；
106 - 其它

position

object

必需

表单域位置 ,PositionVO

dateFormField

object

可选

日期表单域，fromType为3时必传

示例

{
    "basicInfo": {
        "title": "string",
        "remark": "string",
        "seqType": 0,
        "expireDatetime": "string",
        "redirectUrl": "string"
    },
    "participantList": [
        {
            "participantRefId": "string",
            "name": "string",
            "userType": 0,
            "mobile": "string",
            "idType": 0,
            "idNo": "string",
            "enterpriseName": "string",
            "creditCode": "string",
            "assignedSeq": 0,
            "allowAddForms": true,
            "signMode": 0,
            "willingAuth": 0,
            "callbackUrl": "string",
            "notifyType": 0
        }
    ],
    "contentList": [
        {
            "fileTId": "string",
            "attachment": true
        }
    ],
    "formList": [
        {
            "participantRefId": "string",
            "fileTId": "string",
            "formType": 0,
            "sealType": 0,
            "position": {
                "type": 0,
                "coordinatePosition": {
                    "llx": 0,
                    "lly": 0,
                    "urx": 0,
                    "ury": 0,
                    "unit": 0,
                    "pages": "string"
                },
                "apSealPosition": {
                    "direction": 0,
                    "offset": 0,
                    "pages": "string"
                },
                "keywordPosition": {
                    "keyword": "string",
                    "pages": "string",
                    "index": "string",
                    "width": 0,
                    "height": 0,
                    "baseline": 0,
                    "offsetX": 0,
                    "offsetY": 0
                }
            },
            "dateFormField": {
                "format": 0,
                "fontSize": 0
            }
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/open/envelope/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "basicInfo": {
        "title": "string",
        "remark": "string",
        "seqType": 0,
        "expireDatetime": "string",
        "redirectUrl": "string"
    },
    "participantList": [
        {
            "participantRefId": "string",
            "name": "string",
            "userType": 0,
            "mobile": "string",
            "idType": 0,
            "idNo": "string",
            "enterpriseName": "string",
            "creditCode": "string",
            "assignedSeq": 0,
            "allowAddForms": true,
            "signMode": 0,
            "willingAuth": 0,
            "callbackUrl": "string",
            "notifyType": 0
        }
    ],
    "contentList": [
        {
            "fileTId": "string",
            "attachment": true
        }
    ],
    "formList": [
        {
            "participantRefId": "string",
            "fileTId": "string",
            "formType": 0,
            "sealType": 0,
            "position": {
                "type": 0,
                "coordinatePosition": {
                    "llx": 0,
                    "lly": 0,
                    "urx": 0,
                    "ury": 0,
                    "unit": 0,
                    "pages": "string"
                },
                "apSealPosition": {
                    "direction": 0,
                    "offset": 0,
                    "pages": "string"
                },
                "keywordPosition": {
                    "keyword": "string",
                    "pages": "string",
                    "index": "string",
                    "width": 0,
                    "height": 0,
                    "baseline": 0,
                    "offsetX": 0,
                    "offsetY": 0
                }
            },
            "dateFormField": {
                "format": 0,
                "fontSize": 0
            }
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

Response<EnvelopeCreationRespVO> :Response

code

number

状态码200成功

可选

message

string

信息描述

可选

body

object

可选

内容 ,EnvelopeCreationRespVO

envelopeTId

string

信封Id

可选

示例

{
    "code": 0,
    "message": "string",
    "body": {
        "envelopeTId": "string"
    }
}