封筒を作成

POST /esignglobal/v1/envelope/create

インターフェースの説明

下書き状態の封筒を作成します。

リクエストパラメータ

パラメータ名		タイプ	必須項目	説明
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	署名完了後のリダイレクト先アドレス（長さ2048）。有効なhttpアドレスである必要があります
callBackUrl		string	false	コールバックアドレス（長さ500）。https /http プロトコルアドレスに準拠する必要があります

リクエスト例

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

レスポンスパラメータ

パラメータ名

タイプ

説明

envelopeId

string

エンベロープ ID

envelopeStatus

int

エンベロープの状態

0 - 作成済み（下書き）

1 - 署名中

2 - 完了

3-期限切れ

5-取り消し済み

レスポンスの例

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}