签署服务-签署页面

请求参数

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

Body 参数application/json

contractId

string

合同ID

可选

合同ID和业务ID不能同时为空

bizId

string

业务ID

可选

合同ID和业务ID不能同时为空

tenantName

string

子公司名称

可选

若使用业务ID获取签署页面，且合同是以子公司身份创建的，则需要传递该值，用于确定合同主体

pageType

enum<string>

可选

签署页面：SIGN，文件打印页面：PRINT，直接签署页面（H5）：DIRECT_SIGN，默认为签署页面仅支持PC端的操作：PRINT

枚举值:

SIGNPRINTDIRECT_SIGN

user

object (UserRequest)

操作人

必需

pageType为APPOINT和FILL_PARAMETERS时，为草稿创建人，若合同为草稿，则可不传该字段

contact

string

联系方式

必需

contactType

enum<string>

联系类型

必需

MOBILE（手机号），EMAIL（邮箱），EMPLOYEEID（员工ID），NUMBER（员工编号），BIZID（用户在对接方系统的唯一标识）

枚举值:

MOBILEEMAILEMPLOYEEIDNUMBERBIZID

name

string

姓名

可选

callbackPage

string

跳转页面

可选

hideReturnButton

boolean

是否隐藏返回按钮

可选

默认false允许显示返回按钮

hideRecallButton

boolean

是否隐藏撤回按钮

可选

默认false允许显示撤回按钮；注：当参数user不具备该按钮使用权限时，按钮隐藏

hideRejectButton

boolean

是否隐藏退回按钮

可选

默认true隐藏退回按钮；注：当参数user不具备该按钮使用权限时，按钮隐藏

hideEndButton

boolean

是否隐藏结束签署按钮

可选

默认false允许显示结束签署按钮；注：当参数user不具备该按钮使用权限时，按钮隐藏

hideStateButton

boolean

是否隐藏签署状态按钮

可选

默认false允许显示签署状态按钮

allowPasswordSign

boolean

是否允许在签署页面使用密码签署

可选

默认为false；为true时，用户首次在签署页面使用验证码签署成功后，后续30分钟内在同一客户端该用户可使用密码在签署页面进行合同签署（后续该参数也需要为true），30分钟内签署成功可使用密码签署的时间按照最后一次签署成功时刻重置30分钟

lang

string

指定页面语言

可选

cn（中文）、en（英文）；默认为接口中传的user在契约锁设置的语言

pageStyle

object

页面风格

可选

themeColor

string

自定义页面主题色

可选

RGB颜色(16进制)，默认取业务系统令牌配置的主题色

示例

{
  "contractId": 2918470566249767000,
  "bizId": null,
  "user": {
    "contact": "15021504325",
    "contactType": "MOBILE"
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/contract/pageurl' \
--header 'x-qys-open-accesstoken: {{x-qys-open-accesstoken}}' \
--header 'x-qys-open-timestamp: {{x-qys-open-timestamp}}' \
--header 'x-qys-open-nonce: {{x-qys-open-nonce}}' \
--header 'x-qys-open-signature: {{x-qys-open-signature}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contractId": 2918470566249766948,
    "bizId": null,
  
    "user": {
        "contact": "15021504325",
        "contactType": "MOBILE"
    }
}'

返回响应

🟢200成功

application/json

Body

result

object

必需

pageUrl

string

必需

code

integer

必需

message

string

必需

示例

{
  "result": {
    "pageUrl": "https://cloudapi.qiyuesuo.me/contract/share/3053174206079459711?openPageToken=60e74568-3618-411f-8a4f-949971b05e5b"
  },
  "code": 0,
  "message": "SUCCESS"
}