クイック封筒の開始

POST /esignglobal/v1/envelope/createAndStart

インターフェースの説明

封筒の作成、署名待ちファイルの追加、署名者の追加などの機能を含む、封筒を迅速に開始します。

自動開始をサポート：インターフェースの呼び出しが成功すると、封筒が正常に作成および開始され、この時点で封筒は自動的に流れ始めます。
自動終了をサポート：すべての署名者が署名を完了すると、封筒は自動的に終了します。

リクエストパラメータ

パラメータ名					タイプ	必須	説明
subject					string	true	封筒の件名例：「Offer Letter」
remark					string	false	封筒の備考，長さ制限1000字
signerSettings					object	false	署名者が実行できる操作
	allowTransfer				boolean	false	署名者がこの封筒を他の人に署名のために転送することを許可するかどうか、デフォルトはfalse true-封筒内の署名者が封筒を他の人に転送する権限を持つことを許可します。 false-封筒内の署名者が封筒を他の人に転送する権限を持つことを許可しません。
	allowModifyName				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	CCの氏名。署名ページと封筒にCCの氏名を表示するために使用されます。【注意】：次の9つの特殊文字（/ \ : * " < > \| ？）およびすべての絵文字を含めることはできません。
	customizeSettings				object	false	カスタム構成
		notificationSettings			object	false	通知タイプのカスタム構成
			notificationLanguage		string	false	通知言語。デフォルトは英語です。 en-US 英語 zh-CN 中国語（簡体字） zh-Hant 中国語（繁体字） ja-JP 日本語 ES-MX スペイン語
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を渡すとSMS通知を送信 none-メッセージ通知を送信しない email-メール通知を送信 sms-SMS通知を送信 WhatsApp-WhatsApp通知を送信
	userEmail				string	true	署名者のメールアドレス
	userName				string	true	署名者の名前。署名ページと封筒に署名者の名前を表示するために使用されます。【注】次の9つの特殊文字（/ \ : * " < > \| ？）およびすべてのemoji絵文字を含めることはできません
	phoneNumber				object	false	電話番号、デフォルトは空 SMS通知が必要な場合は必須パラメータです。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 日本語 ES-MX スペイン語
	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-電子ID検証
	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の場合、座標位置は捺印エリアを指します中心点位置 2026年2月3日より、fieldTypeがsignatureまたはstampの場合、その座標位置は捺印エリアの中心点を指します。
			posY		float	false	y軸座標【注意】fieldTypeがsignatureの場合、座標位置は署名エリアを指します左下； fieldTypeがstampの場合、座標位置は捺印エリアを指します中心点位置 2026年2月3日以降、fieldTypeがsignatureまたはstampの場合、その座標位置は捺印エリアの中心点の位置を指します。
		fillConfigs			array	false	コントロール情報の入力
			fieldName		string	false	コントロール名、文字数制限128
			required		boolean	false	必須項目かどうか、デフォルトは必須 true-必須 false-必須ではない
			fieldType		string	false	コントロールタイプ： 1-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のみに有効、16進数カラー、デフォルトは黒#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	CC受信者情報コレクション
	userEmail	string	CC受信者のメールアドレス
	userName	string	CC受信者の名前
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"
}