快速发起信封

POST /esignglobal/v1/envelope/createAndStart

接口描述

快捷发起信封，包含创建信封、添加待签署文件、添加签署人等功能。

支持自动开启：接口调用成功后，即成功创建并开启信封，此时信封自动开始流转。
支持自动结束：所有签署方完成签署后，信封自动结束。

请求参数

参数名称					类型	必填	说明
subject					string	true	信封主题示例：“Offer Letter”
remark					string	false	信封备注，长度限制1000字
signerSettings					object	false	允许签署人进行的操作
	allowTransfer				boolean	false	是否允许签署人将该信封转交给其他人签署，默认false true-允许信封中的签署人拥有信封转交他人的权力； false-不允许信封中的签署人拥有信封转交他人的权力；
expireAfterSeconds					long	false	信封过期时间，超过多少秒后信封过期过期范围：86,400秒（1天）~7,776,000秒（90天）
redirectUrl					string	false	需为有效的https地址
callBackUrl					string	false	回调地址（长度500），需符合 https 协议地址。
sendLaterAfterSeconds					long	false	支持用户延迟发送，以秒为单位支持时间范围：3600秒（1小时）~259200秒（30天）
CCInfos					array	false	抄送人信息集合
	userEmail				string	false	抄送人邮箱地址
	userName				string	false	抄送人姓名，用于签署页面与信封对外展示抄送人姓名。【注意】：不可含有以下9个特殊字符：/ \ : * " < > \| ？以及所有emoji表情
	customizeSettings				object	false	自定义配置
		notificationSettings			object	false	通知类自定义配置
			notificationLanguage		string	false	通知语言，默认为英语 en-US 英语 zh-CN 简体中文 zh-Hant 繁体中文 ja 日语
signFiles					array	true	签署文件信息集合，展示顺序为文件添加顺序。
	fileKey				string	true	签署文件fileKey，仅支持PDF格式
attachments					array	false	信封附件集合，展示顺序为文件添加顺序。
	fileKey				string	false	文件fileKey
signerInfos					array	true	签署人信息集合
	businessId				string	false	开发者自定义业务编号，长度限制500
	deliveryMethods				string	false	通知方式，默认为auto auto-传入userEmail时发送邮件通知，传入phoneNumber时发送短信通知 none-不发送消息通知 email-发送邮件通知 sms-发送短信通知 WhatsApp-发送WhatsApp通知
	userEmail				string	true	签署人邮箱地址
	userName				string	true	签署人姓名，用于签署页面与信封对外展示签署人姓名。【注】不可含有以下9个特殊字符：/ \ : * " < > \| ？以及所有emoji表情
	phoneNumber				object	false	电话号码，默认为空当需要进行短信通知时为必填参数，countryCode与number都需要传入
		countryCode			string	false	国家地区的国际码，无需传入“+”
		number			string	false	无格式校验，仅限制长度最大为13位
	customizeSettings				object	false	自定义配置
		notificationSettings			object	false	通知类自定义配置
			customizeMessage		string	false	专属消息通知，字符限制200
			notificationLanguage		string	false	通知语言，默认为英语 en-US 英语 zh-CN 简体中文 zh-Hant 繁体中文 ja 日语
	signOrder				int	true	签署人签署顺序，最小为1。无序签可指定相同顺序值。
	anySigner				boolean	false	是否支持任一人签署，默认 false true-同一signOrder仅需其中一人签署 false-同一signOrder所有人均需签署
	authModes				string	false	校验方式，默认为noAuth noAuth-不验证 accessCode-使用签署口令验证 sms-SMS OTP 验证 idVerification-身份证件验证 emailAuth-邮箱OTP验证 digitalId-电子身份验证
	authConfig				object	false	验证方式设置
		accessCode			object	false	签署口令设置，当authModes=accessCode时必填
			accessCode		string	false	口令内容，不区分大小写，可以包含字母数字，长度限制45
			promptInfo		string	false	访问口令提示信息，不可以包含访问口令，长度限制30，当authModes=1时必填。
		sms			object	false	SMS OTP校验，当authModes=sms时必填
			countryCode		string	false	国家地区的国际码，无需传入“+”
			number		string	false	不做格式校验，仅限制长度最大为13位
		idVerification			object	false	身份证件验证设置，当authModes=idVerification时必填
			name		string	false	签署人身份证件上的姓名全称，最大长度100个字符
		emailAuth			object	false	邮箱OTP校验，当authModes=emailAuth时必填
			authEmail		string	false	签署人身份验证邮箱地址
		digitalId			array	false	电子身份验证，当authModes=digitalId时必填
			authApp		string	false	电子身份验证使用的APP singpass-使用Singpass进行身份认证
			idNumber		string	false	签署人待验证的身份证件号码
	digitalSignature				boolean	false	是否开启数字签名，默认false true-开启，false-不开启
	freeFormSign				boolean	false	签署人是否自由签章，默认值 false 补充说明：当选择freeFormSign为true时，针对sealInfos下的其他参数无需传入。如果同时传入，freeFormSign优先级高于sealInfos，sealInfos下的参数不会生效【注意】自由签章即不限制签名人可拖入的图章/签名数量和位置
	sealInfos				array	false	签署任务信息
		fileKey			string	true	签署文件fileKey
		signConfigs			array	false	控件位置信息，必须指定控件的位置信息才可以进行电子签名。
			fieldType		string	false	控件类型，默认为signature signature-签名控件 stamp-图章控件 approval-审批控件
			sizeRule		string	false	签署区尺寸展示方式 originalSize-根据签名/图章实际尺寸落章 targetSize-自定义签名/图章区宽高当sizeRule, height, width均为空时，按签名/图章实际尺寸落章；当sizeRule为空，height, width不为空时，按指定尺寸落章；当sizeRule不为空时，按指定的展示方式落章。
			height		int	false	签署控件高度，适用于fieldType为signature/stamp，单位为px，仅支持正整数传入，默认auto（即系统自动尺寸）；当fieldType=signature时，可设置范围为20-250px；当fieldType=stamp时，可设置范围为30-280px；
			width		int	false	签署控件宽度，适用于fieldType为signature/stamp，单位为px，仅支持正整数传入，默认auto（即系统自动尺寸）；当fieldType=signature时，可设置范围为20-250px；当fieldType=stamp时，可设置范围为30-280px；
			signatureOptions		string	false	签名控件选项。仅适用于fieldType为signature 可入参： template：模板签名 handDrawn：手绘签名 upload：本地上传签名图片可多选，用","分隔，默认全选
			movable		boolean	false	签署时允许移动位置，默认false false-不允许签署人调整自己的签署控件位置 true-允许签署人调整自己的签署控件位置
			allowedOptions		array	false	允许签署人审批的选项，适用于fieldType为approval。默认为["approve", "decline"] approve-同意 decline-拒绝
			pageNo		string	false	签署页码；连续页码用"-"连接，单独页码用","连接示例：1-3,6-10
			posX		float	false	x轴坐标【注意】若fieldType为signature，则坐标位置指签名区左下角；若fieldType为stamp，则坐标位置指盖章区中心点位置
			posY		float	false	y轴坐标【注意】若fieldType为signature，则坐标位置指签名区左下角；若fieldType为stamp，则坐标位置指盖章区中心点位置
		fillConfigs			array	false	填写控件信息
			fieldName		string	false	控件名称，字符数限制128
			required		boolean	false	是否必填，默认必填 true-必填 false-非必填
			fieldType		string	false	控件类型： 1-单行文本 15-勾选框
			textField		object	false	文本控件属性
				overflowType	int	false	只对text生效，默认1 1-自动缩小字号 2-限制输入
				minFontSize	float	false	只对text生效，只对overflowType=1生效，默认8 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
				width	int	false	控件宽度，默认160px
				font	int	false	只对text生效，字体，默认宋体 1-宋体 2-新宋体 4-黑体 5-楷体 6-Arial 7-Helvetica 9-Times New Roman 10-仿宋 11-Georgia 12-Monospace
				fontSize	float	false	只对text生效，字体大小，默认12 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
				textColor	string	false	只对text生效，十六进制颜色，默认黑色#000
				bold	boolean	false	只对text生效，字体是否加粗，默认false true-加粗 false-不加粗
				italic	boolean	false	只对text生效，是否斜体，默认false true-斜体 false-非斜体
				underline	boolean	false	只对text生效，字体是否添加下划线，默认false true-添加下划线 false-不添加下划线
				lineThrough	boolean	false	只对text生效，是否添加删除线，默认false true-添加删除线 false-不添加删除线
				horizontalAlignment	string	false	只对text生效，水平居中格式，默认left LEFT-靠左 CENTER-居中 RIGHT-靠右
			tickBoxField		object	false	勾选框属性
				tickOptions	array	false	只对tickBox生效，默认1 1-勾 2-叉
			posX		float	false	控件位置X横坐标
			posY		float	false	控件位置Y纵坐标
			pageNo		string	false	控件所在页码
		signDateConfigs			array	false	签署日期位置信息
			movable		boolean	false	签署时允许移动位置，默认false false-不允许签署人调整自己的签署控件位置 true-允许签署人调整自己的签署控件位置
			pageNo		string	false	签署页码；连续页码用"-"连接，单独页码用","连接，示例：1-3, 6-10；非连续则传入","进行分割。
			posX		float	false	x轴偏移量，页面左下角为坐标原点
			posY		float	false	y轴偏移量，页面左下角为坐标原点
			signDateFormat		string	false	签署日期格式，默认格式为yyyy-MM-dd 支持指定格式： yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MM dd yyyy dd MM yyyy

请求示例

{
    "subject": "员工入职合约",
    "remark": "这是描述",
    "expireAfterSeconds": 86400,
    "redirectUrl": "https://app-sml.esignglobal.com/home/main/esign/contract/list/inbox",
    "signFiles": [
      {
        "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
      },
      {
        "fileKey": "$c7567683-2fc1-47a5-82c1-570d4839afd8$3119805980"
      }
    ],
    "signerInfos": [
      {
        "userEmail": "sender_user@tsign.cn",
        "userName": "sender_user_name",
        "phoneNumber": {
        	"countryCode": "86",
        	"number": "158****9242"
        }
        "signOrder": 1,
        "authModes": "sms",
        "authConfig": {
            "sms": {
                "countryCode": "86",
                "number": "158****9242"
            }
        },
        "sealInfos": [
        {
            "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c",
            "signConfigs": [
              {
                "fieldType": "stamp",
                "pageNo": "1,3-5",
                "posX": 100.22222,
                "posY": 100.11111
              }
              "fillConfigs": [
              {
                "fieldId": "df0dd777bc774a2ba3fec4d108de242d",
                "fieldKey": "必填单行文本自动缩小字号最小字号Arial",
                "pageNo": "1",
                "posX": "88.70021",
                "posY": 745.409,
                "fieldType": "1",
                "required": true,
                "textField": {
                    "overflowType": "1",
                    "minFontSize": 8,
                    "font": "6",
                    "fontSize": "12",
                    "textColor": "#54ACD2",
                    "bold": false,
                    "italic": true,
                    "lineThrough": false,
                    "horizontalAlignment": "RIGHT"
                }
              },
              {
                  "fieldId": "888b899853544c49bd819d9f6d1e52cf",
                  "fieldKey": "必填勾选控件不限制选中样式不显示边框",
                  "pageNo": "3",
                  "posX": 451.77127,
                  "posY": 429.07626,
                  "fieldType": "15",
                  "required": true,
                  "tickBoxField": {
                      "tickOptions": [1,2],
                      "showBorder": false
                  }
                }
              ]
            ],
            "signDateConfigs":[
              {
                "pageNo":"1",
                "posX": 100.22,
                "posY": 100,
                "signDateFormat": "dd MMM yyyy"
              }
            ]
        }
      ]
    }
  ]
}

响应参数

参数名称		类型	说明
envelopeId		string	信封 ID
CCInfos		array	抄送人信息集合
	userEmail	string	抄送人邮箱地址
	userName	string	抄送人姓名
signFiles		array	签署文件信息集合
	fileKey	string	签署文件fileKey
attachments		array	信封附件集合
	fileKey	string	文件fileKey
signerInfos		array	签署信息
	businessId	string	开发者自定义业务编号，长度限制500
	userEmail	string	签署人邮箱地址
	userName	string	签署人姓名
	signUrl	string	签署链接地址
	signOrder	int	签署人签署顺序，最小为1
	accessCode	string	签署页访问口令

响应示例

{
  "code": "0",
    "data": {
    "signerInfos": [
      {
        "accessCode": "123456",
        "userEmail": "sender_user@tsign.cn",
        "signUrl": "http://app-test.esignglobal-inc.com/home/main/sign/start/base/dosign?envelopeId=4cd738a60225445f9d5f3afec468a639&signature=eyJhbGciOiJIUzI1NiIsInppcCI6IkRFRiJ9.eNqqVkrOzytJrShRsqpWSs0rS83JL0gNSSzO9kxRslJKtjC1MDKxTDVIMzA0SU4xSTIwNjAxSDRNTTVKMTIxTFOqrQUAAAD__w.YMBA5X9O8Ylk7x2rma-s1WxGwo2cjqy-O9CCQopzw88&tenantToken=AA0DDgQ0Y2Q3MzhhNjAyMjU0NDVmOWQ1ZjNhZmVjNDY4YTYzuQ4GNGNkNzM4YTYwMjI1NDQ1ZjlkNWYzYWZlYzQ2OGE2M7kOCjRjZDczOGE2MDIyNTQ0NWY5ZDVmM2FmZWM0NjhhNjO5AIBjNDIwMzg1ZDMyYzU0MGE4YTk1ZTE3ZTNkZmZjMDNm4g%3D%3D",
        "userName": "sender_user_name",
        "signOrder": "1"
      }
    ],
      "signFiles": [
      {
        "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
      },
      {
        "fileKey": "$c7567683-2fc1-47a5-82c1-570d4839afd8$3119805980"
      }
    ],
      "envelopeId": "4cd738a60225445f9d5f3afec468a639"
  },
  "message": "success"
}