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 (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 ng Paglagda (haba 500)
CCInfos			array	Koleksyon ng Impormasyon ng Kinokopyahan
	userEmail		string	Email Address ng Kinokopyahan
	userName		string	Pangalan ng tatanggap ng kopya
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 nilagdaang dokumento
	fileKey		string	fileKey ng nilagdaang dokumento
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	International Code ng Bansa/Rehiyon
		number	string	Numero ng Telepono ng Lumagda para Tumanggap ng Mensahe ng Paglagda
	signOrder		int	Pagkakasunod-sunod ng paglagda ng lumagda, ang pinakamababa ay 1.
	digitalSignature		boolean	Kung bubuksan ang digital signature, default ay false true-Bukas, false-Hindi Bukas
	accessCode		string	Password sa Pag-access ng Pahina ng Pagpirma
	signerStatus		int	Katayuan ng Lumagda 0-Naghihintay ng Pagpirma 1-Kasulukuyang Pinipirmahan 2-Napirmahan Na
	signDate		timestamp	Oras ng Pagpirma
	declinedReason		string	Dahilan ng Pagtanggi, ipinapakita kapag ang envelopeStatus ay Tinanggihan
canceledReason			string	Dahilan ng Pagkansela, ipinapakita kapag ang envelopeStatus ay Kinansela

Halimbawa ng Tugon

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "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"
}