创建信封发送视图

POST /esignglobal/v1/envelopes/views/sender

接口描述

通过信封id来创建一个信封发送者视图,开发者可通过该接口获取到的页面将发送视图集成在自己的第三方应用

  1. 通过本视图获取的发起签署页面发起的签署流程,发起方以oauth中Access Token解析到的用户信息填充
  2. 在调用本接口前需要先通过创建签署流程接口创建一个状态为草稿的信封
  3. 创建签署流程id后,允许通过添加签署文件、添加签署方等接口对信封进行设置
  4. 本视图生成的发起页面,支持iframe和webview嵌入,页面语言默认为英文
  5. 调用本接口不支持包含签署人静默签的签署流程

请求参数

参数名称

类型

是否必填

说明

envelopeId

string

true

签署流程ID,仅允许传入0-已创建(草稿)的签署流程ID

returnUrl

string

true

签署流程发送完成后的重定向地址(长度2048),需符合 https /http 协议地址

settingsobjectfalse发送页面自定义设置
 startingPagestringfalse发送视图的起始页面,默认preparePage。
preparePage -基础信息设置页面
taggingPage-签署控件设置页面
 submitActionstringfalse提交,默认send
save-保存,页面显示save保存按钮,隐藏send相关按钮;
send-发送,页面显示send now、send、send later按钮,隐藏save按钮;
 showBackButtonbooleanfalse是否展示Tagging Page的Back按钮,默认true。
true-展示
false-不展示

请求示例

{
    "envelopeId":"75a12f86018040d58e4ba06d6bc9028d",
    "returnUrl":"ggg.fengli.com"
}

响应参数

参数名称

类型

说明

url

string

发起信封页面地址

响应示例

{
    "code": "0",
    "data": {
        "url": "https://app-test-as1.esignglobal-inc.com/document/refine-info?envelopeId=75a12f86018040d58e4ba06d6bc9028d&tcode=...&dc=as1"
    },
    "message": "success"
}

 

接口描述
请求参数
请求示例
响应参数
响应示例