POST /esignglobal/v1/envelope/recipients/addCCs
คำอธิบายอินเทอร์เฟซ
เพิ่มผู้รับสำเนาไปยังซองจดหมาย หลังจากเริ่มสร้างซอง ระบบจะแจ้งให้ผู้รับสำเนาทราบโดยอัตโนมัติ โดยผู้รับสำเนาจะมีสิทธิ์เพียงการดูเท่านั้น
ข้อควรระวัง:
รองรับการดำเนินการเมื่อสถานะซองเป็นแบบร่าง、กำลังลงนามเพิ่มผู้รับสำเนา
ลำดับการแสดงของผู้รับสำเนาไม่ส่งผลต่อลำดับการส่งสำเนาของซองจดหมาย
ไม่อนุญาตให้เพิ่มผู้รับสำเนาเดียวกัน (ใช้ที่อยู่อีเมลเป็นตัวระบุผู้ใช้ที่ไม่ซ้ำ) ซ้ำ หากต้องการอัปเดตข้อมูลงานลงนาม โปรดเพิ่มผู้รับสำเนาที่เกี่ยวข้องอีกครั้ง
พารามิเตอร์คำขอ
ชื่อพารามิเตอร์ | ประเภท | จำเป็นต้องกรอกหรือไม่ | คำอธิบาย |
envelopeId | string | true | ID ของซองจดหมาย |
CCInfos | array | true | ชุดข้อมูลผู้รับสำเนา |
| userEmail | string | true | ที่อยู่อีเมลของผู้รับสำเนา |
| userName | string | true | ชื่อของผู้รับสำเนา ใช้แสดงชื่อฝ่ายที่ได้รับสำเนาในหน้าลงนามและกระบวนการภายนอก 【ข้อควรระวัง】ห้ามมีอักขระพิเศษทั้ง 9 ตัวต่อไปนี้: / \ : * " < > | ? และอีมوجิต่างๆ ทั้งหมด |
| ccOrder | int | false | ตำแหน่งลำดับของผู้รับสำเนาในกระบวนการลงนาม โดยใช้ลำดับร่วมกับ signOrder ของผู้ลงนาม สามารถกำหนดค่าได้เฉพาะกับโหนดการลงนามที่ยังไม่เริ่มดำเนินการเท่านั้น; หากไม่ระบุ จะใช้ตรรกะการแจ้งเตือนการเพิ่มผู้รับสำเนาตามเดิม |
| customizeSettings | object | false | การกำหนดค่าแบบกำหนดเอง |
| | notificationSettings | object | false | การกำหนดค่าแบบกำหนดเองสำหรับประเภทการแจ้งเตือน |
| | | notificationLanguage | string | false | ภาษาของการแจ้งเตือน โดยจะดึงค่าจาก "การกำหนดค่าภาษาการแจ้งเตือนเริ่มต้น" เป็นค่าเริ่มต้น en-US อังกฤษ zh-CN ภาษาจีนตัวย่อ zh-Hant ภาษาจีนตัวเต็ม ja-JP ญี่ปุ่น es-MX สเปน pt-PT โปรตุเกส th-TH ไทย id-ID ภาษาอินโดนีเซีย vi-VN ภาษาเวียดนาม ms-MY ภาษามาเลย์ fil-PH ภาษาฟิลิปปินส์ de-DE ภาษาเยอรมัน fr-FR ภาษาฝรั่งเศส ru-RU ภาษารัสเซีย it-IT ภาษาอิตาลี ko-KR ภาษาเกาหลี |
พารามิเตอร์คำขอ
{
"envelopeId": "flow1234567890",
"CCInfos": [{
"userEmail": "buweiqiang@xxxx.com",
"userName": "WeiQiang",
"ccOrder": 2
},{
"userEmail": "tiandou@xxxx.com",
"userName": "dou",
"ccOrder": 3
}
}
พารามิเตอร์การตอบกลับ
ชื่อพารามิเตอร์ | ประเภท | คำอธิบาย |
envelopeId | string | รหัสซองจดหมาย |
CCInfos | array | ชุดข้อมูลผู้รับสำเนา |
| userEmail | string | ที่อยู่อีเมลของผู้รับสำเนา |
| userName | string | ชื่อของผู้รับสำเนา |
ตัวอย่างการตอบกลับ
{
"code": "0",
"message": "成功",
"data": {
"envelopeId": "flow1234567890",
"CCInfos": [{
"userEmail": "buweiqiang@xxxx.com",
"userName": "WeiQiang"
},{
"userEmail": "tiandou@xxxx.com",
"userName": "dou"
}]
}
}