大家签公有云-OpenAPI
  1. 信封
大家签公有云-OpenAPI
  • 概述
    • 概述
  • 接口
    • 授权
      • 获取授权
    • 文件上传
      • 上传文件
    • 信封
      • 发起签署任务
        POST
      • 获取待签署链接
        POST
      • 查询签署任务详情
        GET
      • 撤销信封
        POST
      • 下载签署文件
        GET
      • 下载验证报告
        GET
    • 印章
      • 查询印章列表
      • 查询印章图片
    • 签署
      • 静默签署
    • 验签
      • 签名验证
    • 快捷
      • 快捷签署
    • 模板
      • 基于模板创建文件
      • 查询当前企业所有模板
      • 查询模板预设表单信息
  • 更新日志
    • 版本更新日志
  1. 信封

发起签署任务

POST
/open/envelope/create

请求参数

Header 参数

Body 参数application/json

示例
{
    "basicInfo": {
        "title": "string",
        "remark": "string",
        "seqType": 0,
        "expireDatetime": "string",
        "redirectUrl": "string"
    },
    "participantList": [
        {
            "participantRefId": "string",
            "name": "string",
            "userType": 0,
            "mobile": "string",
            "idType": 0,
            "idNo": "string",
            "enterpriseName": "string",
            "creditCode": "string",
            "assignedSeq": 0,
            "allowAddForms": true,
            "signMode": 0,
            "willingAuth": 0,
            "callbackUrl": "string",
            "notifyType": 0
        }
    ],
    "contentList": [
        {
            "fileTId": "string",
            "attachment": true
        }
    ],
    "formList": [
        {
            "participantRefId": "string",
            "fileTId": "string",
            "formType": 0,
            "sealType": 0,
            "position": {
                "type": 0,
                "coordinatePosition": {
                    "llx": 0,
                    "lly": 0,
                    "urx": 0,
                    "ury": 0,
                    "unit": 0,
                    "pages": "string"
                },
                "apSealPosition": {
                    "direction": 0,
                    "offset": 0,
                    "pages": "string"
                },
                "keywordPosition": {
                    "keyword": "string",
                    "pages": "string",
                    "index": "string",
                    "width": 0,
                    "height": 0,
                    "baseline": 0,
                    "offsetX": 0,
                    "offsetY": 0
                }
            },
            "dateFormField": {
                "format": 0,
                "fontSize": 0
            }
        }
    ]
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/open/envelope/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "basicInfo": {
        "title": "string",
        "remark": "string",
        "seqType": 0,
        "expireDatetime": "string",
        "redirectUrl": "string"
    },
    "participantList": [
        {
            "participantRefId": "string",
            "name": "string",
            "userType": 0,
            "mobile": "string",
            "idType": 0,
            "idNo": "string",
            "enterpriseName": "string",
            "creditCode": "string",
            "assignedSeq": 0,
            "allowAddForms": true,
            "signMode": 0,
            "willingAuth": 0,
            "callbackUrl": "string",
            "notifyType": 0
        }
    ],
    "contentList": [
        {
            "fileTId": "string",
            "attachment": true
        }
    ],
    "formList": [
        {
            "participantRefId": "string",
            "fileTId": "string",
            "formType": 0,
            "sealType": 0,
            "position": {
                "type": 0,
                "coordinatePosition": {
                    "llx": 0,
                    "lly": 0,
                    "urx": 0,
                    "ury": 0,
                    "unit": 0,
                    "pages": "string"
                },
                "apSealPosition": {
                    "direction": 0,
                    "offset": 0,
                    "pages": "string"
                },
                "keywordPosition": {
                    "keyword": "string",
                    "pages": "string",
                    "index": "string",
                    "width": 0,
                    "height": 0,
                    "baseline": 0,
                    "offsetX": 0,
                    "offsetY": 0
                }
            },
            "dateFormField": {
                "format": 0,
                "fontSize": 0
            }
        }
    ]
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 0,
    "message": "string",
    "body": {
        "envelopeTId": "string"
    }
}
修改于 2025-03-31 01:19:55
上一页
上传文件
下一页
获取待签署链接
Built with