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

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-ไม่เปิด
	accessCode		string	รหัสผ่านการเข้าถึงหน้าลงนาม
	signerStatus		int	สถานะผู้ลงนาม 0-รอลงนาม 1-กำลังลงนาม 2-ลงนามแล้ว
	signDate		timestamp	เวลาลงนาม
	declinedReason		string	เหตุผลการปฏิเสธการลงนาม แสดงเมื่อ envelopeStatus เป็น ปฏิเสธการลงนาม
canceledReason			string	เหตุผลการยกเลิก แสดงเมื่อ envelopeStatus เป็น ยกเลิก

ตัวอย่างการตอบสนอง

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