Xử lý chứng từ hàng loạt
Ngày cập nhật: 29 tháng 09, 2026
Người cập nhật: VNPT eContract's team
Mục đích
Hàm thực hiện xử lý các quy trình thuộc lô được tạo bởi API Tạo lô chứng từ xử lý hàng loạt. API hỗ trợ ký, phê duyệt, từ chối và xử lý các lượt liền kề bằng giá trị đã cấu hình.
cẩn thận
Hàm xử lý chứng từ hàng loạt yêu cầu batchProcessId từ API Tạo lô chứng từ xử lý hàng loạt.
- Request URL:
/api/documents/batch-process - HTTP method:
POST - HTTP content-type:
application/json - Authorize:
Bearer token - Parameter:
| Key | Type | Bắt buộc | Mô tả |
|---|---|---|---|
batchProcessId | string | Có | ID lô xử lý từ data.id trả về bởi API Tạo lô xử lý. |
reason | string | Không | Lý do xử lý, ký, phê duyệt hoặc từ chối. |
reject | boolean | Không | true là từ chối chứng từ; false là xử lý bình thường. |
otp | string | Không | OTP khi chính sách yêu cầu. Lần đầu truyền null; lần xác nhận truyền OTP nhận qua Email/SMS. |
signatureDisplayMode | int | Không | Chế độ hiển thị: 1 chỉ văn bản, 2 văn bản và hình ảnh, 3 chỉ hình ảnh. |
signatureImage | string | Không | Hình ảnh chữ ký dạng Base64/Data URI. |
signingPage | int | Không | Trang ký. Truyền null để dùng trang đã cấu hình của từng lượt xử lý. |
signingPosition | string | Không | Tọa độ ký dạng llx,lly,urx,ury. Truyền null để dùng tọa độ đã cấu hình. |
signatureText | string | Không | Nội dung hiển thị chữ ký. |
fontSize | int | Không | Cỡ chữ ký. |
showReason | boolean | Không | Có hiển thị lý do xử lý trên chữ ký hay không. |
confirmTermsConditions | boolean | Không | Xác nhận điều khoản pháp lý trước khi xử lý. |
processAllAdjacentProcesses | boolean | Không | true để xử lý toàn bộ lượt liền kề bằng giá trị đã cấu hình. |
thông tin
Chỉ batchProcessId luôn bắt buộc theo thiết kế request. Các trường còn lại bắt buộc có điều kiện tùy quyền xử lý, phương thức ký, chính sách OTP và cấu hình hệ thống.
Mẫu request lần 1 (json)
{
"batchProcessId": "673c0f4f-8744-4cf7-1061-08dc9a457201",
"reason": "Sign this valid documents",
"reject": false,
"otp": null,
"signatureDisplayMode": 3,
"signatureImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAD…",
"signingPage": null,
"signingPosition": null,
"signatureText": "Nguyen Van A",
"fontSize": 12,
"showReason": false,
"confirmTermsConditions": true,
"processAllAdjacentProcesses": true
}
Mẫu response body lần 1
{
"data": {
"isBatchProcess": false,
"isSingleProcess": false,
"isProcessedByWorkerService": false,
"batchProcessId": "673c0f4f-8744-4cf7-1061-08dc9a457201",
"documentId": "00000000-0000-0000-0000-000000000000",
"documentIds": [],
"accessPermission": 2,
"signMethod": 2,
"signatureDisplayMode": 2,
"batchProcessStatus": 0,
"signingPage": 0,
"signatureText": "Ký hàng loạt chứng từ",
"reason": "Đồng ý với nội dung trình ký",
"confirmReason": "Đồng ý với nội dung trình ký",
"showReason": false,
"fontSize": 0,
"receiveOtpMethod": 2,
"receiveOtpPhone": "09123XXXXX",
"receiveOtpEmail": "example@email.com",
"requireOtpConfirmation": true,
"vnptCaPluginAdvancedSign": false,
"drawSigns": [],
"documentMessages": [],
"histories": [],
"digitalSignatures": [],
"processes": [],
"documents": [],
"sharedUsers": [],
"sharedDepartments": [],
"sharedUserGroups": [],
"sharedUserIds": [],
"sharedDepartmentIds": [],
"sharedUserGroupIds": [],
"signatureVerifications": [],
"confirmTermsConditions": false,
"documentIndex": 1,
"fillingItems": [],
"isFillPreview": false,
"isSmartCaLoginRequired": false,
"isBusinessSmartCaAccount": false,
"smartCaCerts": []
},
"success": true,
"code": 100,
"messages": [
"Send confirmation otp success"
]
}
Mẫu request lần 2 (json) (Sau khi có thông tin mã OTP nhận được từ Email/SMS)
{
"batchProcessId": "673c0f4f-8744-4cf7-1061-08dc9a457201",
"reason": "Sign this valid documents",
"reject": false,
"otp": "089278",
"signatureDisplayMode": 3,
"signatureImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAD…",
"signingPage": null,
"signingPosition": null,
"signatureText": "Nguyen Van A",
"fontSize": 12,
"showReason": false,
"confirmTermsConditions": true
}
Mẫu response body lần 2
{
"success": true,
"code": 0,
"messages": [
"Sign batch document success"
]
}