{
  "name": "ds",
  "display_name": "文档服务",
  "description": "",
  "domain": "other",
  "api_version": "2018-05-23",
  "endpoint": "ds.tencentcloudapi.com",
  "actions": [
    {
      "name": "CheckVcode",
      "description": "检测验证码接口。此接口用于企业电子合同平台通过给用户发送短信验证码，以短信授权方式签署合同。此接口配合发送验证码接口使用。 用户在企业电子合同平台输入收到的验证码后，由企业电子合同平台调用该接口向腾讯云提交确认受托签署合同验证码命令。验证码验证正确时，本次合同签署的授权成功。",
      "status": "online",
      "parameters": [
        {
          "name": "Module",
          "type": "string",
          "required": true,
          "description": "模块名VerifyCode"
        },
        {
          "name": "Operation",
          "type": "string",
          "required": true,
          "description": "操作名CheckVcode"
        },
        {
          "name": "AccountResId",
          "type": "string",
          "required": true,
          "description": "帐号ID"
        },
        {
          "name": "ContractResId",
          "type": "string",
          "required": true,
          "description": "合同ID"
        },
        {
          "name": "VerifyCode",
          "type": "string",
          "required": true,
          "description": "验证码"
        }
      ],
      "required": [
        "Module",
        "Operation",
        "AccountResId",
        "ContractResId",
        "VerifyCode"
      ]
    },
    {
      "name": "CreateContractByUpload",
      "description": "此接口适用于：客户平台通过上传PDF文件作为合同，以备未来进行签署。接口返回任务号，可调用DescribeTaskStatus接口查看任务执行结果。",
      "status": "online",
      "parameters": [
        {
          "name": "Module",
          "type": "string",
          "required": true,
          "description": "模块名ContractMng"
        },
        {
          "name": "Operation",
          "type": "string",
          "required": true,
          "description": "操作名CreateContractByUpload"
        },
        {
          "name": "SignInfos",
          "type": "array",
          "required": true,
          "description": "签署人信息",
          "item_type": "object",
          "children": [
            {
              "name": "AccountResId",
              "type": "string",
              "required": true,
              "description": "账户ID"
            },
            {
              "name": "AuthorizationTime",
              "type": "string",
              "required": false,
              "description": "授权时间（上传合同可不传该参数）"
            },
            {
              "name": "Location",
              "type": "string",
              "required": false,
              "description": "授权IP地址（上传合同可不传该参数）"
            },
            {
              "name": "SealId",
              "type": "string",
              "required": false,
              "description": "签章ID"
            },
            {
              "name": "ImageData",
              "type": "string",
              "required": false,
              "description": "签名图片，优先级比SealId高"
            },
            {
              "name": "CertType",
              "type": "integer",
              "required": false,
              "description": "默认值：1 表示RSA证书， 2 表示国密证书， 参数不传时默认为1"
            },
            {
              "name": "SignLocation",
              "type": "string",
              "required": false,
              "description": "签名域的标签值"
            }
          ]
        },
        {
          "name": "ContractFile",
          "type": "string",
          "required": true,
          "description": "合同上传链接地址"
        },
        {
          "name": "ContractName",
          "type": "string",
          "required": true,
          "description": "合同名称"
        },
        {
          "name": "Remarks",
          "type": "string",
          "required": false,
          "description": "备注"
        },
        {
          "name": "Initiator",
          "type": "string",
          "required": false,
          "description": "合同发起方腾讯云帐号ID（由平台自动填写）"
        },
        {
          "name": "ExpireTime",
          "type": "string",
          "required": false,
          "description": "合同长时间未签署的过期时间"
        }
      ],
      "required": [
        "Module",
        "Operation",
        "SignInfos",
        "ContractFile",
        "ContractName"
      ]
    },
    {
      "name": "CreateEnterpriseAccount",
      "description": "为企业电子合同平台的最终企业用户进行开户。在企业电子合同平台进行操作的企业用户，企业电子合同平台向腾讯云发送企业用户的信息，提交开户命令。腾讯云接到请求后，自动为企业电子合同平台的企业用户生成一张数字证书。",
      "status": "online",
      "parameters": [
        {
          "name": "Module",
          "type": "string",
          "required": true,
          "description": "模块名AccountMng"
        },
        {
          "name": "Operation",
          "type": "string",
          "required": true,
          "description": "操作名CreateEnterpriseAccount"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "企业用户名称"
        },
        {
          "name": "IdentType",
          "type": "integer",
          "required": true,
          "description": "企业用户证件类型，8代表营业执照，详情请见常见问题"
        },
        {
          "name": "IdentNo",
          "type": "string",
          "required": true,
          "description": "企业用户营业执照号码"
        },
        {
          "name": "MobilePhone",
          "type": "string",
          "required": true,
          "description": "企业联系人手机号"
        },
        {
          "name": "TransactorName",
          "type": "string",
          "required": true,
          "description": "经办人姓名"
        },
        {
          "name": "TransactorIdentType",
          "type": "integer",
          "required": true,
          "description": "经办人证件类型，0代表身份证"
        },
        {
          "name": "TransactorIdentNo",
          "type": "string",
          "required": true,
          "description": "经办人证件号码"
        },
        {
          "name": "TransactorPhone",
          "type": "string",
          "required": true,
          "description": "经办人手机号"
        },
        {
          "name": "Email",
          "type": "string",
          "required": false,
          "description": "企业联系人邮箱"
        }
      ],
      "required": [
        "Module",
        "Operation",
        "Name",
        "IdentType",
        "IdentNo",
        "MobilePhone",
        "TransactorName",
        "TransactorIdentType",
        "TransactorIdentNo",
        "TransactorPhone"
      ]
    },
    {
      "name": "CreatePersonalAccount",
      "description": "为企业电子合同平台的最终个人用户进行开户。在企业电子合同平台进行操作的个人用户，企业电子合同平台向腾讯云发送个人用户的信息，提交开户命令。腾讯云接到请求后，自动为企业电子合同平台的个人用户生成一张数字证书。",
      "status": "online",
      "parameters": [
        {
          "name": "Module",
          "type": "string",
          "required": true,
          "description": "模块名AccountMng"
        },
        {
          "name": "Operation",
          "type": "string",
          "required": true,
          "description": "操作名CreatePersonalAccount"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "个人用户姓名"
        },
        {
          "name": "IdentType",
          "type": "integer",
          "required": true,
          "description": "个人用户证件类型，0代表身份证，详情请见常见问题"
        },
        {
          "name": "IdentNo",
          "type": "string",
          "required": true,
          "description": "个人用户证件号码"
        },
        {
          "name": "MobilePhone",
          "type": "string",
          "required": true,
          "description": "个人用户手机号"
        }
      ],
      "required": [
        "Module",
        "Operation",
        "Name",
        "IdentType",
        "IdentNo",
        "MobilePhone"
      ]
    },
    {
      "name": "CreateSeal",
      "description": "此接口用于客户电子合同平台增加某用户的印章图片。客户平台可以调用此接口增加某用户的印章图片。",
      "status": "online",
      "parameters": [
        {
          "name": "Module",
          "type": "string",
          "required": true,
          "description": "模块名SealMng"
        },
        {
          "name": "Operation",
          "type": "string",
          "required": true,
          "description": "操作名CreateSeal"
        },
        {
          "name": "AccountResId",
          "type": "string",
          "required": true,
          "description": "帐号ID"
        },
        {
          "name": "ImgUrl",
          "type": "string",
          "required": true,
          "description": "签章链接，图片必须为png格式"
        },
        {
          "name": "ImgData",
          "type": "string",
          "required": false,
          "description": "图片数据，base64编码"
        }
      ],
      "required": [
        "Module",
        "Operation",
        "AccountResId",
        "ImgUrl"
      ]
    },
    {
      "name": "DeleteAccount",
      "description": "删除企业电子合同平台的最终用户。调用该接口后，腾讯云将删除该用户账号。删除账号后，已经签名的合同不受影响。",
      "status": "online",
      "parameters": [
        {
          "name": "Module",
          "type": "string",
          "required": true,
          "description": "模块名AccountMng"
        },
        {
          "name": "Operation",
          "type": "string",
          "required": true,
          "description": "操作名DeleteAccount"
        },
        {
          "name": "AccountList",
          "type": "array",
          "required": true,
          "description": "帐号ID列表",
          "item_type": "string"
        }
      ],
      "required": [
        "Module",
        "Operation",
        "AccountList"
      ]
    },
    {
      "name": "DeleteSeal",
      "description": "删除印章接口，删除指定账号的某个印章",
      "status": "online",
      "parameters": [
        {
          "name": "Module",
          "type": "string",
          "required": true,
          "description": "模块名SealMng"
        },
        {
          "name": "Operation",
          "type": "string",
          "required": true,
          "description": "操作名DeleteSeal"
        },
        {
          "name": "AccountResId",
          "type": "string",
          "required": true,
          "description": "帐号ID"
        },
        {
          "name": "SealResId",
          "type": "string",
          "required": true,
          "description": "签章ID"
        }
      ],
      "required": [
        "Module",
        "Operation",
        "AccountResId",
        "SealResId"
      ]
    },
    {
      "name": "DescribeTaskStatus",
      "description": "接口使用于：客户平台可使用该接口查询任务执行状态或者执行结果",
      "status": "online",
      "parameters": [
        {
          "name": "Module",
          "type": "string",
          "required": true,
          "description": "模块名CommonMng"
        },
        {
          "name": "Operation",
          "type": "string",
          "required": true,
          "description": "操作名DescribeTaskStatus"
        },
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "任务ID"
        }
      ],
      "required": [
        "Module",
        "Operation",
        "TaskId"
      ]
    },
    {
      "name": "DownloadContract",
      "description": "下载合同接口。调用该接口可以下载签署中和签署完成的合同。接口返回任务号，可调用DescribeTaskStatus接口查看任务执行结果。",
      "status": "online",
      "parameters": [
        {
          "name": "Module",
          "type": "string",
          "required": true,
          "description": "模块名ContractMng"
        },
        {
          "name": "Operation",
          "type": "string",
          "required": true,
          "description": "操作名DownloadContract"
        },
        {
          "name": "ContractResId",
          "type": "string",
          "required": true,
          "description": "合同ID"
        }
      ],
      "required": [
        "Module",
        "Operation",
        "ContractResId"
      ]
    },
    {
      "name": "SendVcode",
      "description": "发送验证码接口。此接口用于：企业电子合同平台需要腾讯云发送验证码对其用户进行验证时调用，腾讯云将向其用户联系手机(企业电子合同平台为用户开户时通过接口传入)发送验证码，以验证码授权方式签署合同。用户验证工作由企业电子合同平台自身完成。",
      "status": "online",
      "parameters": [
        {
          "name": "Module",
          "type": "string",
          "required": true,
          "description": "模块名VerifyCode"
        },
        {
          "name": "Operation",
          "type": "string",
          "required": true,
          "description": "操作名SendVcode"
        },
        {
          "name": "ContractResId",
          "type": "string",
          "required": true,
          "description": "合同ID"
        },
        {
          "name": "AccountResId",
          "type": "string",
          "required": true,
          "description": "帐号ID"
        }
      ],
      "required": [
        "Module",
        "Operation",
        "ContractResId",
        "AccountResId"
      ]
    },
    {
      "name": "SignContractByCoordinate",
      "description": "此接口适用于：客户平台在创建好合同后，由合同签署方对创建的合同内容进行确认，无误后再进行签署。客户平台使用该接口提供详细的PDF文档签名坐标进行签署。",
      "status": "online",
      "parameters": [
        {
          "name": "Module",
          "type": "string",
          "required": true,
          "description": "模块名ContractMng"
        },
        {
          "name": "Operation",
          "type": "string",
          "required": true,
          "description": "操作名SignContractByCoordinate"
        },
        {
          "name": "ContractResId",
          "type": "string",
          "required": true,
          "description": "合同ID"
        },
        {
          "name": "AccountResId",
          "type": "string",
          "required": true,
          "description": "帐户ID"
        },
        {
          "name": "SignLocations",
          "type": "array",
          "required": true,
          "description": "签署坐标，坐标原点在文件左下角，坐标单位为磅，坐标不得超过合同文件边界",
          "item_type": "object",
          "children": [
            {
              "name": "SignOnPage",
              "type": "string",
              "required": true,
              "description": "签名域页数"
            },
            {
              "name": "SignLocationLBX",
              "type": "string",
              "required": true,
              "description": "签名域左下角X轴坐标轴"
            },
            {
              "name": "SignLocationLBY",
              "type": "string",
              "required": true,
              "description": "签名域左下角Y轴坐标轴"
            },
            {
              "name": "SignLocationRUX",
              "type": "string",
              "required": true,
              "description": "签名域右上角X轴坐标轴"
            },
            {
              "name": "SignLocationRUY",
              "type": "string",
              "required": true,
              "description": "签名域右上角Y轴坐标轴"
            }
          ]
        },
        {
          "name": "AuthorizationTime",
          "type": "string",
          "required": false,
          "description": "授权时间（由平台自动填充）"
        },
        {
          "name": "Position",
          "type": "string",
          "required": false,
          "description": "授权IP地址（由平台自动填充）"
        },
        {
          "name": "SealResId",
          "type": "string",
          "required": false,
          "description": "签章ID"
        },
        {
          "name": "CertType",
          "type": "integer",
          "required": false,
          "description": "选用证书类型：1 表示RSA证书， 2 表示国密证书， 参数不传时默认为1"
        },
        {
          "name": "ImageData",
          "type": "string",
          "required": false,
          "description": "签名图片，base64编码"
        }
      ],
      "required": [
        "Module",
        "Operation",
        "ContractResId",
        "AccountResId",
        "SignLocations"
      ]
    },
    {
      "name": "SignContractByKeyword",
      "description": "此接口适用于：客户平台在创建好合同后，由合同签署方对创建的合同内容进行确认，无误后再进行签署。客户平台使用该接口对PDF合同文档按照关键字和坐标进行签署。",
      "status": "online",
      "parameters": [
        {
          "name": "Module",
          "type": "string",
          "required": true,
          "description": "模块名ContractMng"
        },
        {
          "name": "Operation",
          "type": "string",
          "required": true,
          "description": "操作名SignContractByKeyword"
        },
        {
          "name": "ContractResId",
          "type": "string",
          "required": true,
          "description": "合同ID"
        },
        {
          "name": "AccountResId",
          "type": "string",
          "required": true,
          "description": "账户ID"
        },
        {
          "name": "SignKeyword",
          "type": "object",
          "required": true,
          "description": "签署关键字，偏移坐标原点为关键字中心",
          "children": [
            {
              "name": "Keyword",
              "type": "string",
              "required": true,
              "description": "关键字"
            },
            {
              "name": "OffsetCoordX",
              "type": "string",
              "required": true,
              "description": "X轴偏移坐标"
            },
            {
              "name": "OffsetCoordY",
              "type": "string",
              "required": true,
              "description": "Y轴偏移坐标"
            },
            {
              "name": "ImageWidth",
              "type": "string",
              "required": true,
              "description": "签章图片宽度"
            },
            {
              "name": "ImageHeight",
              "type": "string",
              "required": true,
              "description": "签章图片高度"
            }
          ]
        },
        {
          "name": "AuthorizationTime",
          "type": "string",
          "required": false,
          "description": "授权时间（由平台自动填充）"
        },
        {
          "name": "Position",
          "type": "string",
          "required": false,
          "description": "授权IP地址（由平台自动填充）"
        },
        {
          "name": "SealResId",
          "type": "string",
          "required": false,
          "description": "签章ID"
        },
        {
          "name": "CertType",
          "type": "integer",
          "required": false,
          "description": "选用证书类型：1 表示RSA证书， 2 表示国密证书， 参数不传时默认为1"
        },
        {
          "name": "ImageData",
          "type": "string",
          "required": false,
          "description": "签名图片，base64编码"
        }
      ],
      "required": [
        "Module",
        "Operation",
        "ContractResId",
        "AccountResId",
        "SignKeyword"
      ]
    }
  ]
}