开发者中心

添加抄送人

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