获取签署页面链接

接口描述

发起签署时，开发者可指定签署方签署通知的方式（短信通知或邮件通知），签署人访问签署链接以进行相关操作；

当开发者需要在业务系统中访问签署链接或自行发送签署通知时，可通过此接口获取合同的签署/预览链接。

签署流程开启后，才可以获取到文件的签署链接。流程若未开启，请调用【开启签署流程】接口。

接口地址&请求方法

接口地址：https://{host}/v3/sign-flow/{signFlowId}/sign-url

请求方法：POST

请求头格式

具体请求头参数，请查看公共请求头格式。

请求参数

展开全部参数参数名称		参数类型	必选	参数位置	参数说明
signFlowId		string	是	path	签署流程ID
needLogin		boolean	否	body	是否需要登录打开链接（默认值 false） true - 需登录打开链接，false - 免登录
urlType		int32	否	body	链接类型（默认值 2） 1 - 预览链接（仅限查看，不能签署）， 2 - 签署链接
operator（点击“+”展开详情）		object	是	body	个人签署方（机构签署传经办人信息）当获取签署链接场景，需传入当前流程流转到的签署操作人信息。 psnAccount与psnId二选一传入（必须与发起签署时的账号保持一致）【注】大多数场景必传字段，如不传该参数，后台默认自动带入appId对应主体信息，获取平台方预览合同地址
	psnAccount	string	否	body	签署操作人账号标识（手机号/邮箱号）
	psnId	string	否	body	签署操作人账号ID（个人账号ID）
organization（点击“+”展开详情）		object	否	body	机构签署方一个流程中存在经办人代多个机构签署时，通过此参数分别获取对应机构的签署链接； orgId与orgName二选一传入（必须与发起签署时账号保持一致）
	orgId	string	否	body	机构账号ID
	orgName	string	否	body	机构名称
redirectConfig（点击“+”展开详情）		object	否	body	重定向配置项
	redirectUrl	string	否	body	签署完成后跳转页面（需符合 https /http 协议地址）
	redirectDelayTime	int32	否	body	操作完成重定向跳转延迟时间，单位秒（可选值0、3，默认值为 3）传0时，签署完成直接跳转重定向地址；传3时，展示签署完成结果页，倒计时3秒后，自动跳转重定向地址。【注】当redirectUrl不传的情况下，该字段无需传入，签署完成不跳转
clientType		string	否	body	指定客户端类型，当urlType为2（签署链接）时生效 H5 - 移动端适配 PC - PC端适配 ALL - 自动适配移动端或PC端（默认值）【注】参数值均为大写的英文
appScheme		string	否	body	AppScheme，用于唤起App。示例值：esign://demo/signBack

响应参数

展开全部参数参数名称		参数类型	必选	参数说明
code		int32	是	业务码，0表示成功，非0表示异常。
message		string	否	业务信息请根据 code 来判断错误情况，不应该依赖 message匹配，因为 message 可能会调整。
data（点击“+”展开详情）		object	否	业务数据
	shortUrl	string	否	签署短链接（有效期180天）
	url	string	否	签署长链接（永久有效）【注】支持自定义域名，微信小程序H5内嵌场景需要使用长链接

请求示例

POST https://openapi.esign.cn/v3/sign-flow/b2cb7**3cc54/sign-url
{
  "clientType": "ALL",
  "needLogin": true,
  "operator": {
    "psnAccount": "183****0101"
  },
  "urlType": 2
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "url": "https://h5.esign.cn/mesign/guide?context=HM***q&flowId=9d83******b114a15b19&organ=false&appId=511***&linkSource=1&bizType=1&tsign_source_type=SIGN_LINK_XUANYUAN&tsign_source_detail=1vGqUyZBm****QaNBCvlH3PBYvYbA7LZOWPUn%2B2y1znV8jGwtcB5ejKxXfw3OpJk58vs4esvzIrRwiKOp0AV5uPU36CTcFOly%2BOsLQLJSNkFOz6hxxel8ULfKYc6oJGUSCASG7FqUIeMDX1ansmdvnrEkGjnC4o61jG13SZ1lwSieimaLPesHRzaQVttcIeZLrUd%2FB2Mp%2B",
        "shortUrl": "https://t.esign.cn/SM***I"
    }
}

错误码

点击查看错误码

合同文件签署服务API

获取签署页面链接

接口描述

接口地址&请求方法

请求头格式

请求参数

响应参数

请求示例

响应示例

错误码