接口描述
向已发起的流程中添加抄送方的信息，以使未参与到签署流程中的个人或企业接收到已发起的签署相关信息。
“抄送方”的概念：
- 指不参与签署文件的机构或个人，可以进行查看签署流程中的签署文件以及附属材料等信息，当流程中的签署方全部完成签署，抄送方也会收到签署完成的通知。
接口注意事项：
- 自动完结的流程（autoFinish设置为true）不支持添加抄送方，否则将会报错：“自动归档流程开启后，不允许添加签署区”。
- 添加的抄送方不可与流程中已有的抄送方重复。
接口地址：https://{host}/v3/sign-flow/{signFlowId}/copiers
请求方法：POST
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明（请左右滑动查看完整描述） | ||
signFlowId | string | 是 | path | 签署流程ID（通过【基于文件发起签署】接口获取） | ||
copiers（点击“+”展开详情） | array | 是 | body | 添加的抄送方信息 | ||
copierOrgInfo | object | 否 | body | 抄送机构信息（orgId与orgName二选一传入）
| ||
orgId | string | 否 | body | 抄送机构账号ID | ||
orgName | string | 否 | body | 抄送机构账号标识（企业名称） | ||
copierPsnInfo | object | 否 | body | 抄送人信息（psnId与psnAccount二选一传入）
| ||
psnId | string | 否 | body | 抄送人账号ID | ||
psnAccount | string | 否 | body | 抄送人账号标识（手机号或邮箱） | ||
响应参数
参数名称 | 参数类型 | 必选 | 参数说明 |
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 |
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖 message匹配，因为 message 可能会调整。 |
data | object | 否 | 业务数据 |
请求示例
{
"copiers":[
{
"copierOrgInfo":{
"orgName":"这是个抄送通知企业的名称",
"orgId":""
},
"copierPsnInfo":{
"psnAccount":"153****7650",
"psnId":""
}
}
]
}响应示例
{
"code": 0,
"message": "成功",
"data": null
}
我要纠错