信封完成数据格式

信封完成
{
    "event": "envelopeCompleted",
    "data": {
        "basicInfo": {
            "createdDatetime": 1496022233000,
            "envelopeId": "38d74550-8a71-42bf-ba05-d50b2e1f1606",
            "secureLevel": 1,
            "sender": {
                "name": "赵刚",
                "userId": 1834
            },
            "sentDatetime": 1496026190000,
            "status": 4,
            "statusDatetime": 1496030700000,
            "subject": "\"tagId: 工商信封tag\"",
            "title": "output1",
            "type": 1
        },
        "documents": [
            {
                    "contentType": "application/pdf",
                    "imageLocation": "/ws-rest/v1/documents/14787fb8-cb96-4c02-8772-2510f839f1ae/images",
                    "location": "/res/user/dd1506864f4a4dc3a2a01a19b3dbfec7/docs/pdf/converts/55c6674a-241c-4e63-9ea3-4f7d7b3b80f0.pdf",
                    "name": "output11.pdf",
                    "opsPageSignCount": 0,
                    "serialCode": "14787fb8-cb96-4c02-8772-2510f839f1ae",
                    "size": 656.03,
                    "time": 1496026183000,
                "href": "/ws-rest/v1/users/1834/envelopes/38d74550-8a71-42bf-ba05-d50b2e1f1606/documents/14787fb8-cb96-4c02-8772-2510f839f1ae?fields=ops_page_sign_count,to_pdf_original_location,serial_code,size,desc_info,name,location,image_location,to_pdf_location,id,time"
            },
            {
                    "contentType": "application/pdf",
                    "imageLocation": "/ws-rest/v1/documents/ac70f75f-097e-4ac0-baea-bcfd39be6c2b/images",
                    "location": "/res/user/dd1506864f4a4dc3a2a01a19b3dbfec7/docs/pdf/converts/55c5cfdf-e9e5-43e1-931d-81826204b420.pdf",
                    "name": "output1.pdf",
                    "opsPageSignCount": 0,
                    "serialCode": "ac70f75f-097e-4ac0-baea-bcfd39be6c2b",
                    "size": 588.48,
                    "time": 1496022256000,
                "href": "/ws-rest/v1/users/1834/envelopes/38d74550-8a71-42bf-ba05-d50b2e1f1606/documents/ac70f75f-097e-4ac0-baea-bcfd39be6c2b?fields=ops_page_sign_count,to_pdf_original_location,serial_code,size,desc_info,name,location,image_location,to_pdf_location,id,time",
                "tagId": "工商文档tag"
            }
        ],
        "recipients": [
            {
                "contact": "[email protected]",
                "extraInfo": {
                    "tagId": "工商签署人tag"
                },
                "name": "赵刚",
                "recipientId": 155704,
                "recipientType": 0,
                "sequence": 0,
                "state": 1,
                "userId": 1834
            },
            {
                "contact": "[email protected]",
                "extraInfo": {
                    "tagId": "工商签署人tag"
                },
                "name": "测试",
                "recipientId": 155705,
                "recipientType": 0,
                "sequence": 0,
                "state": 1,
                "userId": 1842
            }
        ],
        "recipientsHref": {
            "href": "/ws-rest/v1/users/1834/envelopes/38d74550-8a71-42bf-ba05-d50b2e1f1606/recipients",
            "method": "GET"
        }
    },
    "auditHref": {
        "href": "/ws-rest/v1/users/1834/envelopes/38d74550-8a71-42bf-ba05-d50b2e1f1606/audit",
        "method": "GET"
    },
    "documentsHref": {
        "href": "/ws-rest/v1/users/1834/envelopes/38d74550-8a71-42bf-ba05-d50b2e1f1606/documents",
        "method": "GET"
    },
    "envelopeHref": {
        "href": "/ws-rest/v1/users/1834/envelopes/38d74550-8a71-42bf-ba05-d50b2e1f1606",
        "method": "GET"
    },
    "formsHref": {
        "href": "/ws-rest/v1/users/1834/envelopes/38d74550-8a71-42bf-ba05-d50b2e1f1606/forms",
        "method": "GET"
    }
}
  • 响应字段说明
字段 是否必填 类型 位置 长度 说明
event 是 array BODY webhook定义的事件，详见webhook事件
data 是 Object BODY 信封启动数据结构
basicInfo 是 Object BODY 信封基本数据封装
createdDateTime 是 Long BODY 信封创建时间(Unix时间戳)
envelopeId 是 String BODY 信封唯一标识
secureLevel 是 int BODY 安全级别(1-一次性证书，2-商用证书，3-平台证书)
sender 是 Object BODY 发起者信息
userId 是 String BODY 信封发起者id
name 是 String BODY 信封发起者名
sentDateTime 是 Long BODY 信封创建时间（Unix时间戳）
status 是 int BODY 固定值 信封状态(0-草稿,1-已发送，2-已完成，3-拒签，4-撤销，5-超时，6-发起者逻辑删除)
statusDateTime 是 Long BODY 信封状态更改时间
title 是 String BODY 信封标题
subject 否 String BODY 信封主题
type 是 int BODY 固定值 信封类型(0:本人签,1:多人签，2：他人签)
documents 是 Object BODY 信封中文档资源
document 是 Object BODY 信封中文档
contentType 是 String BODY 文档类型
imageLocation 是 String BODY 文档图片资源链接
location 是 String BODY 文档位置资源链接
name 是 String BODY 文档名称
opsPageSignCount 是 int BODY 文档包含签名个数
serialCode 是 String BODY 文档标识
size 是 float BODY 文档大小
time 是 Long BODY 文档上传时间
href 是 String BODY 文档资源链接
tagId 否 String BODY 省工商文档标记
nextSigners 是 Obeject BODY 下一组签名者信息(如果不存在下则为空
recipients 是 Object BODY 接收者信息
state 是 int BODY 该接收者处理状态：0-待处理，1-已正常处理，2-拒绝处理，3-超时处理
userId 是 int BODY 接收者用户id
contact 是 String BODY 接收者联系方式(例如：邮箱、手机、、、)
sequence 是 int BODY 接收者签名顺序1~n:处理优先级(数字相同则表示同时处理)
name 是 String BODY 接收者用户名称
recipientId 是 int BODY 接收者id
recipientType 是 int BODY 接收者文档级别:0-仅签名，1-仅接收，2-签名并接收文档
extraInfo 是 Object BODY 接收者额外信息
tagId 否 String BODY 省工商签署者标记
totalFormCount 是 int BODY 需处理表单项个数
method 是 String BODY 请求方法
envelopeHref 是 String BODY 当前信封资源链接
documentsHref 是 String BODY 当前信封文档资源链接
recipientsHref 是 String BODY 当前信封接收者资源链接
formsHref 是 String BODY 当前表单资源链接
auditHref 是 String BODY 凭证资源链接
signHref 是 String BODY 签名者信息链接
documents 是 Object BODY 信封中文档对象

results matching ""

    No results matching ""