标准签


全量替换签署联系人

<p><strong>简要描述:</strong> </p> <ul> <li>全量替换签署联系人接口</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>http://ip:port/service/rest/v1/signflow/refreshReceivers</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST application/json</li> </ul> <p><strong>请求参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">flowId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>签署流程Id</td> </tr> <tr> <td style="text-align: left;">receivers</td> <td style="text-align: left;">否</td> <td style="text-align: left;">List</td> <td>参与人列表</td> </tr> <tr> <td style="text-align: left;">source</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>请求来源, 例如:’dingding’ , ’esign’ , ’esign_h5’ , ’alipay’</td> </tr> </tbody> </table> <p>参与人信息</p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">account</td> <td style="text-align: left;">String</td> <td>手机号或邮箱</td> </tr> <tr> <td style="text-align: left;">nickname</td> <td style="text-align: left;">String</td> <td>姓名</td> </tr> <tr> <td style="text-align: left;">participantType</td> <td style="text-align: left;">int</td> <td>参与人类型,0-需签署,1-仅抄送</td> </tr> <tr> <td style="text-align: left;">signOrder</td> <td style="text-align: left;">int</td> <td>签署顺序</td> </tr> </tbody> </table> <p><strong>请求示例</strong></p> <pre><code> http://ip:port/service/rest/v1/signflow/addReceiver { &amp;quot;flowId&amp;quot;:&amp;quot;7619c2a2-bd21-4e05-a57a-09f69712fb3b&amp;quot;, &amp;quot;source&amp;quot;:&amp;quot;esign&amp;quot;, &amp;quot;receivers&amp;quot;:[{ &amp;quot;account&amp;quot;:&amp;quot;15158133594&amp;quot;, &amp;quot;participantType&amp;quot;:&amp;quot;1&amp;quot;, &amp;quot;signOrder&amp;quot;:&amp;quot;2&amp;quot; },{ &amp;quot;account&amp;quot;:&amp;quot;15869154156&amp;quot;, &amp;quot;participantType&amp;quot;:&amp;quot;0&amp;quot;, &amp;quot;signOrder&amp;quot;:&amp;quot;1&amp;quot; }] }</code></pre> <p><strong>返回参数</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">String</td> <td>签署流程参与人Id</td> </tr> <tr> <td style="text-align: left;">receiverType</td> <td style="text-align: left;">int</td> <td>参与人账号类型,1-accountUid, 2-手机号或邮箱</td> </tr> <tr> <td style="text-align: left;">receiverId</td> <td style="text-align: left;">String</td> <td>签署流程名称/文档名称</td> </tr> <tr> <td style="text-align: left;">participantType</td> <td style="text-align: left;">int</td> <td>参与类型,0-需签署 1-仅抄送</td> </tr> <tr> <td style="text-align: left;">account</td> <td style="text-align: left;">String</td> <td>参与人账号,手机号或邮箱</td> </tr> <tr> <td style="text-align: left;">nickname</td> <td style="text-align: left;">String</td> <td>参与人姓名</td> </tr> <tr> <td style="text-align: left;">isSafe</td> <td style="text-align: left;">Boolean</td> <td>参与人账号是否安全</td> </tr> <tr> <td style="text-align: left;">isSigned</td> <td style="text-align: left;">int</td> <td>参与人是否已签,0-未签,1-已签,2-拒签</td> </tr> <tr> <td style="text-align: left;">signOrder</td> <td style="text-align: left;">int</td> <td>参与人签署顺序</td> </tr> <tr> <td style="text-align: left;">isApplication</td> <td style="text-align: left;">int</td> <td>是否转签或用印申请产生的数据</td> </tr> <tr> <td style="text-align: left;">transferReceiver</td> <td style="text-align: left;">Receiver</td> <td>转签人信息</td> </tr> </tbody> </table> <p><strong>返回示例</strong></p> <pre><code>{ &amp;quot;success&amp;quot;: true, &amp;quot;msg&amp;quot;: &amp;quot;成功&amp;quot;, &amp;quot;total&amp;quot;: null, &amp;quot;errCode&amp;quot;: 0, &amp;quot;errShow&amp;quot;: false, &amp;quot;data&amp;quot;: [ { &amp;quot;id&amp;quot;: &amp;quot;860753d4-adc5-43fb-ab8f-c1b6c3a6a050&amp;quot;, &amp;quot;receiverType&amp;quot;: 1, &amp;quot;receiverId&amp;quot;: &amp;quot;62FD06682B3E459CA001D59FCDDE4B34&amp;quot;, &amp;quot;account&amp;quot;: &amp;quot;test42@timevale.com&amp;quot;, &amp;quot;nickname&amp;quot;: &amp;quot;精神面貌好&amp;quot;, &amp;quot;isSafe&amp;quot;: false, &amp;quot;ddUserId&amp;quot;: null, &amp;quot;participantType&amp;quot;: 0, &amp;quot;isSigned&amp;quot;: 0, &amp;quot;signOrder&amp;quot;: 1, &amp;quot;isApplication&amp;quot;: 0, &amp;quot;transferReceiver&amp;quot;: null }, { &amp;quot;id&amp;quot;: &amp;quot;3fcf37c3-d494-419b-a470-132e8df9f6a0&amp;quot;, &amp;quot;receiverType&amp;quot;: 1, &amp;quot;receiverId&amp;quot;: &amp;quot;942B054820E94283967F38B98C3899FA&amp;quot;, &amp;quot;account&amp;quot;: &amp;quot;15869154156&amp;quot;, &amp;quot;nickname&amp;quot;: &amp;quot;李苏婵&amp;quot;, &amp;quot;isSafe&amp;quot;: false, &amp;quot;ddUserId&amp;quot;: null, &amp;quot;participantType&amp;quot;: 0, &amp;quot;isSigned&amp;quot;: 0, &amp;quot;signOrder&amp;quot;: 2, &amp;quot;isApplication&amp;quot;: 0, &amp;quot;transferReceiver&amp;quot;: null } ] }</code></pre> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML