대량전송 계약 시작

계약 대량 전송을 시작합니다.
대량 계약시 서명 순서는 서식을 작성 할 때 설정한 단계에 따라 고객, 담당자가 문서를 받을 순서가 결정됩니다. (1단계만 설정 시 고객에게만 전달) 담장자는 생성자로 고정되며 고객정보는 unset_player_list 에 들어간 값으로 결정됩니다. unset_player_list에 들어있는 모든 고객에게 계약이 발전송니다.
참조자는 서식에 등록되어있는 계정을 따라가며 따로 설정하지않습니다.
2단계C 의 경우 담당자 항목이 없기때문에 고객 B의 정보를 추가로 기입해야하기때문에 Body에 customer_list파라미터를 추가 기입하여 설정 해 주셔야합니다.
2단계C의 경우 고객 ( unset_player_list ) → 고객 B ( customer_list )

API 주소 정보

Url

Type

Code

https://docs.esignon.net/JEDOC/Common.do

POST

1410Q

Request

Parameters

Headers

Parameter Name

DataType

Required

Description

Content-Type

String

Required

application/json

Authorization

String

Required

esignon ${발급받은토큰}

Body

Body - Header Parameter

Parameter Name

DataType

Required

Description

request_code

String

Required

"1410Q"(API 고유 코드)

request_msg

String

Optional

"Work Flow Bulk Sending를 시작합니다."

session_id

String

Required

"thread_023"

version

String

Required

"9.9.99"

Body - Body Parameter

Parameter Name

DataType

Required

Description

comp_id

String

Required

회사 ID / companyId

biz_id

String

Required

"0"

memb_email

String

Required

생성자 이메일

workflow_name

String

Required

unset_player_list.workflow_name 이름을

설정하지 않을경우 기본으로 지정되는 문서

workflow_lib_id

String

Required

서식을 생성하면 생성되는 lid_id 서식ID와는 다른값입니다.

(서식목록조회에서 확인가능합니다.)

unset_player_list

Data

Required

서명하는 고객의 정보를 입력

unset_player_list.memb_id_type

String

Required

"EMail" or "Mobile"

unset_player_list.email

String

Required

memb_id_type 에 따라

이메일 or 전화번호

unset_player_list.name

String

Required

계약 진행자 이름

unset_player_list.language

String

Optional

"ko-KR","en-US","ja-JP"

unset_player_list.workflow_name

String

Optional

문서명 ( 계약서 이름 )

unset_player_list.enable_mobile_cert

String

Required

휴대폰 인증 기능 "true or false"

unset_player_list.mobile_number

String

Required

본인인증에 사용할 번호 / - 없이

unset_player_list.enable_password_cert

String

Required

비밀번호 인증 기능 "true or false"

unset_player_list.password_hint

String

Required

비밀번호 힌트

unset_player_list.password

String

Required

비밀번호

unset_player_list.field_list

Data

Required

미리 설정할 값이 있을경우 입력

여러개 설정가능.

unset_player_list.field_list.doc_id

String

Required

서식 ID

unset_player_list.field_list.field_name

String

Required

서식 필드 이름

unset_player_list.field_list.field_value

String

Required

서식 필드

comment

String

Required

전달할 메세

enable_legal_agreement

String

Required

"false"

customer_list

Data

Optional

서식의 설정이 2단계 C일 경우에 설정

고객 B의 정보

customer_list.memb_id_type

String

Required

"EMail" or "Mobile"

customer_list.email

String

Required

memb_id_type 에 따라

이메일 or 전화번호

customer_list.name

String

Required

계약 진행자 이름

customer_list.language

String

Optional

"ko-KR","en-US","ja-JP"

customer_list.enable_mobile_cert

String

Required

휴대폰 인증 기능 "true or false"

customer_list.mobile_number

String

Required

본인인증에 사용할 번호 / - 없이

customer_list.enable_password_cert

String

Required

비밀번호 인증 기능 "true or false"

customer_list.password_hint

String

Required

비밀번호 힌트

customer_list.password

String

Required

비밀번호

요청 Body 예시)

{
  "header": {
    "request_code": "1410Q",
    "api_name": "Work Flow Bulk Sending를 시작합니다.",
    "session_id": "",
    "version" : "9.9.99"
  },
  "body": {
    "comp_id": "{회사 ID}",
    "biz_id": "0",
    "memb_email": "{ 사용자 이메일 }",
    "workflow_lib_id": "{ 서식의 lib_id }",
    "workflow_name": "",
    "unset_player_list": [{
        "memb_id_type" : "{ EMail or Mobile }",
        "email": "{ memb_id_type 에 따라 번호나 이메일 }",
        "name" : "{ 받는 사람 이름 }",
        "language": "{ko-KR or ja-JP or en-US}",
        "workflow_name" : "{서식 이름}",
        "enable_mobile_cert" : "{ 휴대폰 본인인증 여부 true or false }",
        "mobile_number" : "{ 본인 인증에 사용할 전화번호 }",
        "enable_password_cert":"{true or false}",
	      "password_hint":"{계약자가 볼 비밀번호 힌트}",  		
	      "password":"{설정할 문서 비밀번호}",
        "field_list": [{
      				"doc_id": "{ 서식 ID }",
      				"field_name": "{ 서식 필드명 }",
      				"field_value": "{ 서식 필드 값 }"
			  }]
      }],
    	"customer_list": [{
        "memb_id_type": "{ 2단계 C 서식 사용시에만 기입해주세요 }",
			  "email": "",
			  "name": "",
			  "language": "",
        "enable_mobile_cert":"",
        "mobile_number":"",
        "enable_password_cert":"",
        "password_hint":"",  		
        "password":""
		}],
    "comment": "",
    "enable_legal_agreement":"false"
  }
}

Response

Code

Description

Reference

200

성공

형식이 잘못 된 경우 result_msg 참조

400

연결 실패

Result_msg

Code

Description

Reference

성공

-1

실패

수신 메세지의 Body 정보가 잘못된 형태여서 파싱하지 못했습니다.

실패

해당 Work Flow Library가 존재하지 않습니다.

실패

실패하였습니다.

실패

허용된 저장 용량이 초과되었습니다

실패

가능한 문서 수를 초과합니다.

실패

이용기간이 만료되었습니다.

실패

작성자 설정이 올바르지 않습니다.

응답 Body 예시)

}
	"body":{
		"workflow_list":[{
			"workflow_id": "{문서ID}",
			"unset_player_email": "{서명자 이메일 or 전화번호}",
			"unset_player_name": "{서명자 이름}",
			"result": "OK",
			"description": "",
			"workflow_name": "{서식 이름}",
			"token": "{인증 토큰 코드}",
			"lang": "ko-KR",
			"reg_date": "{회사 결제 갱신일}"}],
			"comp_id": "{회사 ID}",
			"biz_id": "0",
			"memb_email": "{생성자 이메일}",
			"workflow_lib_id": "{서식 lib_id}"
			},
	"header":{
		"session_id": "thread_023",
		"response_code": "1410A",
		"result_code": "00",
		"result_msg": "Work Flow bulk Sending이 시작됩니다.",
		"version": "9.9.99"
	}
}

Previous비대면 계약 - ExportAPI 설명 Next조회

Last updated 3 years ago