クイックエンベロープの作成

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時間）〜259,200秒（30日）
autoFinish					boolean	false	封筒が自動的に終了するかどうかを制御。デフォルトは true true- 封筒が自動的に終了 false- 封筒が手動で終了
CCInfos					array	false	CC情報コレクション
	userEmail				string	false	CCのメールアドレス
	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 スペイン語 pt-PT ポルトガル語 th-TH タイ語 id-ID インドネシア語 vi-VN ベトナム語 ms-MY マレー語 fil-PH フィリピン語 de-DE ドイツ語 fr-FR フランス語 ru-RU ロシア語 it-IT イタリア語 ko-KR 韓国語
signFiles					array	true	署名対象ファイル情報のコレクション。表示順序はファイルの追加順です。
	fileKey				string	true	署名対象ファイルのfileKey。PDF形式のみサポート
	documentFields				array	false	コントロールのリスト（ファイル単位）。署名者に紐付かないファイル単位のコントロールを指定されたファイルに追加するために使用します。
		fieldType			string	false	コントロールタイプ。eMeterai を指定するとインドネシアの印紙税コントロールを示します。
		pageNo			string	false	コントロールが配置されるページ番号。インドネシアの印紙税コントロールでは単一ページの指定のみ可能で、個別のページ番号を入力する必要があります。1-3 や 1,3 などの連続または非連続の複数ページ形式はサポートされていません。
		posX			float	false	X軸オフセット量。座標原点はページの左下隅です。座標範囲は他のコントロールの座標範囲と一致します。
		posY			float	false	Y軸オフセット量。座標原点はページの左下隅です。座標範囲は他のコントロールの座標範囲と一致します。
attachments					array	false	封筒添付ファイルの集合。表示順序はファイル追加順です。
	fileKey				string	false	ファイルfileKey
signerInfos					array	true	署名者情報コレクション
	businessId				string	false	開発者がカスタムする業務番号、長さ制限500
	roleTypes				array	false	署名者の操作方式、デフォルト値は `["sign", "fill"]` fill-入力 sign-署名
	deliveryMethods				string	false	通知方法、デフォルトはauto auto-userEmailを指定するとメール通知を送信し、phoneNumberを指定するとSMS通知を送信します none-メッセージ通知を送信しない email-メール通知を送信する sms-SMS通知を送信する WhatsApp-WhatsApp通知を送信する
	userEmail				string	false	署名者のメールアドレス
	userName				string	true	署名者の氏名。署名ページおよび封筒の外部表示に使用されます。【注】以下の9つの特殊文字を含めることはできません：/ \ : * " < > \| ？およびすべての絵文字
	minimumReadingDuration				int	false	ページ強制読了カウントダウン時間を設定します。デフォルト値は0（単位：秒、最大値999） 0または未指定の場合は無効化され、読了カウントダウンは不要です
	readToEndRequired				boolean	false	最後まで読む必要があるかどうかを示します。デフォルトはfalse； trueの場合有効、falseまたは未指定の場合は無効
	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-JP 日本語 es-MX スペイン語 pt-PT ポルトガル語 th-TH タイ語 id-ID インドネシア語 vi-VN ベトナム語 ms-MY マレー語 fil-PH フィリピン語 de-DE ドイツ語 fr-FR フランス語 ru-RU ロシア語 it-IT イタリア語 ko-KR 韓国語
	signOrder				int	true	署名者の署名順序。最小値は1です。非順序署名では、同じ順序値を指定できます。
	anySigner				boolean	false	任意の署名者が署名できるかどうか、デフォルトは false true- 同一の signOrder では、その中の1人の署名が必要 false- 同一の signOrder では、すべての署名者による署名が必要
	authModes				string	false	検証方法、デフォルトは noAuth noAuth- 検証なし accessCode- 署名パスワードによる検証 sms- SMS OTP 検証 idVerification- 身分証明書による検証 emailAuth- メールアドレス OTP 検証 digitalId- 電子IDによる検証 whatsappAuth- WhatsApp OTP 検証
	authConfig				object	false	検証方法の設定
		accessCode			object	false	署名パスワードの設定、authModes= の場合accessCode必須
			accessCode		string	false	パスワードの内容。大文字と小文字は区別されず、英数字を含むことができ、長さは最大45文字まで
			promptInfo		string	false	アクセスパスワードのプロンプトメッセージ。アクセスパスワードを含めることはできず、長さは30文字以内です。authModes= の場合必須です。accessCodeの場合必須です。
		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	電子ID認証。authModes=digitalId の場合必須です。
			authApp		string	false	電子ID認証に使用されるアプリ singpass- Singpassを使用して本人確認を行う iamsmart-i AM Smartを使用した認証
			idNumber		string	false	署名者の検証待ちの身分証明書番号 authApp=singpassの場合、入力ルールは：大文字アルファベット＋7桁または8桁の数字＋大文字アルファベット authApp=iamsmartの場合、入力ルールは： 1. シーケンスの先頭として、大文字アルファベット1文字（A-Z）または2文字（AA-ZZ）； 2. その後に6桁の数字； 3. 最後にチェックサム。数字（0-9）またはアルファベット（A-Z）のいずれか。例：A888888(A)
		whatsappAuth			object	false	WhatsApp OTP認証。authModes=whatsappAuthの場合必須
			countryCode		string	false	国・地域の国際コード。「+」は不要
			number		string	false	フォーマット検証は行わず、最大長を13桁に制限のみ
	digitalSignature				boolean	false	デジタル署名の有効化フラグ。デフォルトはfalse true-有効、false-無効
	freeFormSign				boolean	false	署名者が自由印影を使用するかどうか。デフォルト値はfalse 補足説明： freeFormSignをtrueに設定した場合、sealInfos内の他のパラメータは指定する必要はありません。両方を同時に指定した場合、freeFormSignの優先度が高く、sealInfos内のパラメータは無効になります。【注意】自由形式の署名とは、署名者がドラッグして配置できる印章/署名の数と位置に制限がないことを意味します。
	sealInfos				array	false	署名タスク情報
		fileKey			string	true	署名対象ファイルのfileKey
		signConfigs			array	false	コントロールの位置情報。電子署名を行うには、必ずコントロールの位置情報を指定する必要があります。
			fieldType		string	false	コントロールの種類。デフォルトはsignatureです。 signature-署名用コントロール stamp-印鑑用コントロール approval-承認用コントロール
			required		boolean	false	必須かどうか。デフォルトは必須です。 true-必須 false-任意
			signFieldStyle		string	false	署名コントロールへの印鑑押下方法。デフォルトはnormalSealです。 normalSeal-通常印影 pagingSeal-重なり印影重なり印影の設定は、署名コントロールと図章コントロールのみでサポートされます。
			pagingSealMode		string	false	重なり印影が押されるページ範囲。デフォルトはallです。 all-全ページ番号 assignedPages-指定ページ番号 even-偶数ページ odd-奇数ページ signFieldStyle=pagingSeal の場合のみ指定可能です。
			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 pagingSealMode=assignedPagesの場合、騎縫印（ページ跨ぎ印）を押すページ範囲を指定します。騎縫印は2ページ以上のファイルにのみ使用できます。
			posX		float	false	X座標【注意】fieldTypeがsignatureの場合、座標位置は署名エリアを指します左下隅； fieldTypeがstampの場合、座標位置は捺印エリアを指します中心点位置 2026年2月3日より、fieldTypeがsignatureまたはstampの場合、座標位置は捺印エリアの中心点を指します。重なりスタンプは0を渡すことができ、nullは渡せません。コントロールはファイルの右端に固定されます。
			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-単一行テキスト 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 MMM dd,yyyy dd MMM 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	署名情報
	recipientId	string	署名者ID
	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"
}