eSign.AIeSign.AI
개발자 센터

참조 추가

POST /esignglobal/v1/envelope/recipients/addCCs

인터페이스 설명

봉투에 참조자를 추가합니다. 봉투가 생성되면 시스템이 자동으로 참조자에게 알림을 보내며, 참조자는 조회 권한만 가집니다.

주의 사항:

  1. 봉투 상태가 다음일 때 지원됩니다:초안서명 진행 중참조자 추가
  2. 참조자의 표시 순서는 봉투의 참조 순서에 영향을 미치지 않습니다.
  3. 동일한 참조자(이메일 주소를 사용자 고유 식별자로 사용)는 중복으로 추가할 수 없으며, 서명 작업 정보를 업데이트해야 할 경우 해당 참조자를 다시 추가해야 합니다.

요청 파라미터

파라미터 이름

유형

필수 여부

설명

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

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