สอบถามรายละเอียดซองจดหมาย

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	ชุดข้อมูลผู้รับสำเนา
	userEmail			string	ที่อยู่อีเมลของผู้รับสำเนา
	userName			string	ชื่อผู้รับสำเนา
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	การตรวจสอบ OTP ทาง SMS
			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"
}