封筒の詳細を照会

GET /esignglobal/v1/envelope/envelopeDetail

インターフェースの説明

署名進捗、エンベロープステータスなど、エンベロープの詳細情報を照会します。

リクエストパラメータ

パラメータ名	タイプ	必須	説明
envelopeId	string	true	エンベロープID

リクエスト例

GET https://……/esignglobal/v1/envelope/envelopeDetail?envelopeId=flow1234567890

レスポンスパラメータ

パラメータ名				タイプ	説明
envelopeId				string	エンベロープID
envelopeStatus				int	エンベロープステータス 0-作成済み（下書き） 1-署名中 2-完了 3-期限切れ 4-署名拒否 5-取り消し
envelopeEndTime				timestamp	エンベロープ終了時間
envelopeCreateTime				timestamp	エンベロープ開始時間
subject				string	エンベロープの件名
remark				string	エンベロープの備考（長さ1000）
redirectUrl				string	署名完了後のリダイレクトアドレス（長さ500）
CCInfos				array	CC受信者情報コレクション
	userEmail			string	CC受信者のメールアドレス
	userName			string	CC受信者の名前
initiatorInfo				object	送信者情報コレクション
	userName			string	送信者名。デフォルトは、オープンアプリケーションAPPIDの所属作成者の名前です。
signFiles				array	署名ファイル情報コレクション
	fileKey			string	署名ファイルfileKey
attachments				array	エンベロープ添付ファイルコレクション
	fileKey			string	エンベロープ fileKey
signerInfos				array	署名者情報
	businessId			string	開発者がカスタマイズしたビジネス番号（長さ500）
	userName			string	署名者名
	userEmail			string	署名者のメールアドレス
	phoneNumber			object	署名者がSMSを受信するアドレス
		countryCode		string	国・地域の国際コード
		number		string	署名者が署名メッセージを受信する携帯電話番号
	signOrder			int	署名者の署名順序。最小値は1です。
	digitalSignature			boolean	デジタル署名を有効にするかどうか。デフォルトはfalse true-有効、false-無効
	authConfig			object	検証方法
		accessCode		object	アクセスパスワード
			accessCode	string	アクセスパスワード
			promptInfo	string	アクセスパスワードのヒント
		sms		object	SMS OTP検証
			countryCode	string	国・地域の国際コード
			number	string	本人確認用携帯電話番号
		idVerification		object	本人確認
			name	string	署名者の身分証明書に記載されている氏名
		emailAuth		object	メールOTP検証
			authEmail	string	署名者の本人確認用メールアドレス
		digitalId		object	電子本人確認
			authApp	string	電子本人確認に使用するアプリ
			idNumber	string	署名者の検証待ちの身分証明書番号
		whatsappAuth		object	WhatsApp OTP検証
			countryCode	string	国と地域の国際コード
			number	string	本人確認用携帯電話番号
	signerStatus			int	署名者のステータス 0 - 署名待ち 1 - 署名中 2 - 署名済み
	signDate			timestamp	署名時間
	declinedReason			string	拒否理由（envelopeStatusが拒否済みのときに表示）
canceledReason				string	取り消し理由（envelopeStatusが取り消し済みのときに表示）

レスポンスの例

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "authConfig": {
                    "accessCode": {
                        "accessCode": "1234567",
                        "promptInfo": "test"
                    }
                },
                "accessCode": null,
                "userEmail": "muyantest2@tsign.cn",
                "userName": "muyantest2222",
                "signDate": null,
                "signOrder": "1"
            },
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "accessCode": null,
                "userEmail": "muyan@tsign.cn",
                "userName": "muyant",
                "signDate": null,
                "signOrder": "1"
            }
        ],
        "envelopeExpireTime": 1724055000193,
        "signFiles": [
            {
                "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
            }
        ],
        "envelopeCreateTime": null,
        "redirectUrl": "https://www.baidu.com",
        "attachments": [

        ],
        "canceledReason": null,
        "subject": "api create envelope hxqibLJpBD",
        "envelopeEndTime": null,
        "remark": "api remark",
        "CCInfos": null,
        "initiatorInfo": {
            "userName": "muyantest2"
        },
        "expireTime": 1724055000193,
        "envelopeId": "4a97d269d48642bb8b9d4878cde843a3",
        "envelopeStatus": 0
    },
    "message": "success"
}