開發者中心

新增副本收件人

POST /esignglobal/v1/envelope/recipients/addCCs

介面描述

為信封新增副本收件人。信封發起後,系統會自動通知副本收件人,副本收件人僅有檢視權限。

注意事項:

  1. 支援在信封狀態為草稿簽署中新增副本收件人。
  2. 副本收件人的顯示順序不影響信封的副本順序。
  3. 同一副本收件人(以電子郵件地址作為使用者唯一標識)不允許重複新增,如需更新簽署任務資訊,請重新新增對應的副本收件人。

請求參數

參數名稱

類型

是否必填

說明

envelopeId

string

true

信封 ID

CCInfos

array

true

抄送人資訊集合

 

userEmail

string

true

抄送人郵箱地址

 

userName

string

true

抄送人名稱,用於簽署頁面與流程對外展示抄送方姓名。

【注意】不可含有以下9個特殊字符:/ \ : * " < > | ?以及所有emoji表情

 

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

信封 ID

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