Hanapin ang Detalye ng Sobre

GET /esignglobal/v1/envelope/envelopeDetail

Paglalarawan ng Interface

Hanapin ang detalyadong impormasyon ng sobre, kabilang ang progreso ng pagpirma, estado ng sobre, atbp.

Mga Parameter ng Kahilingan

Pangalan ng Parameter	Uri	Kinakailangan	Paglalarawan
envelopeId	string	true	Envelope ID

Halimbawa ng Kahilingan

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

Mga Parameter ng Tugon

Pangalan ng Parameter				Uri	Paglalarawan
envelopeId				string	Envelope ID
envelopeStatus				int	Estado ng Sobre 0-Nilikha na (draft) 1-Nilalagdaan 2-Tapos na 3-Nag-expire na 4-Tinanggihan 5-Kinansela
envelopeEndTime				timestamp	Oras ng Pagtatapos ng Sobre
envelopeCreateTime				timestamp	Oras ng Pagsisimula ng Sobre
subject				string	Paksa ng Sobre
remark				string	Mga Tala sa Sobre (haba 1000)
redirectUrl				string	Direksyon ng Pag-redirect Pagkatapos Lagdaan (haba 500)
CCInfos				array	Koleksyon ng Impormasyon ng Kinokopyahan
	userEmail			string	Email Address ng Kinokopyahan
	userName			string	Pangalan ng Kinokopyahan
initiatorInfo				object	Koleksyon ng Impormasyon ng Nagpadala
	userName			string	Pangalan ng nagpadala, ang default ay ang pangalan ng lumikha ng APPID ng bukas na aplikasyon
signFiles				array	Koleksyon ng impormasyon ng dokumentong nilagdaan
	fileKey			string	fileKey ng dokumentong nilagdaan
attachments				array	Koleksyon ng mga attachment ng sobre
	fileKey			string	fileKey ng sobre
signerInfos				array	Impormasyon ng lumagda
	businessId			string	Custom na numero ng negosyo ng developer, (haba 500)
	userName			string	Pangalan ng lumagda
	userEmail			string	Email address ng lumagda
	phoneNumber			object	SMS address ng tatanggap ng lumagda
		countryCode		string	Internasyonal na code ng bansa/rehiyon
		number		string	Numero ng mobile phone ng lumagda na tatanggap ng mensahe ng paglagda
	signOrder			int	Pagkakasunud-sunod ng paglagda ng lumagda, ang pinakamaliit ay 1.
	digitalSignature			boolean	Kung bubuksan ang digital signature, ang default ay false true-bukas, false-hindi bukas
	authConfig			object	Paraan ng Pagpapatunay
		accessCode		object	Access Password
			accessCode	string	Access Password
			promptInfo	string	Impormasyon sa Paalala ng Access Password
		sms		object	SMS OTP Verification
			countryCode	string	Pandaigdigang code ng bansa/rehiyon
			number	string	Numero ng Mobile Phone para sa Pagpapatunay ng Pagkakakilanlan
		idVerification		object	Pagpapatunay ng Pagkakakilanlan
			name	string	Buong pangalan sa ID ng lumagda
		emailAuth		object	Email OTP Verification
			authEmail	string	Email address ng lumagda para sa pagpapatunay ng pagkakakilanlan
		digitalId		object	Electronic ID Verification
			authApp	string	APP na ginagamit para sa Electronic ID Verification
			idNumber	string	Numero ng ID ng lumagda na naghihintay ng pagpapatunay
		whatsappAuth		object	WhatsApp OTP Verification
			countryCode	string	Pandaigdigang code ng bansa/rehiyon
			number	string	Numero ng telepono para sa pagpapatunay ng pagkakakilanlan
	signerStatus			int	Katayuan ng lumagda 0-Naghihintay lagdaan 1-Nilalagdaan 2-Nalagdaan na
	signDate			timestamp	Oras ng paglagda
	declinedReason			string	Dahilan ng pagtanggi, ipinapakita kapag ang envelopeStatus ay tinanggihan
canceledReason				string	Dahilan ng pagbawi, ipinapakita kapag ang envelopeStatus ay binawi

Halimbawa ng tugon

{
    "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"
}