DsClient (tencentcloud-sdk-java 3.0.117 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.ds.v20180523.DsClient

public class DsClient
extends AbstractClient

字段概要
- 从类继承的字段 com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

构造器概要

构造器
构造器和说明

DsClient(Credential credential, String region)

DsClient(Credential credential, String region, ClientProfile profile)

构造器
构造器和说明
`DsClient(Credential credential, String region)`
`DsClient(Credential credential, String region, ClientProfile profile)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CheckVcodeResponse`	`CheckVcode(CheckVcodeRequest req)` 检测验证码接口。
`CreateContractByUploadResponse`	`CreateContractByUpload(CreateContractByUploadRequest req)` 此接口适用于：客户平台通过上传PDF文件作为合同，以备未来进行签署。
`CreateEnterpriseAccountResponse`	`CreateEnterpriseAccount(CreateEnterpriseAccountRequest req)` 为企业电子合同平台的最终企业用户进行开户。
`CreatePersonalAccountResponse`	`CreatePersonalAccount(CreatePersonalAccountRequest req)` 为企业电子合同平台的最终个人用户进行开户。
`CreateSealResponse`	`CreateSeal(CreateSealRequest req)` 此接口用于客户电子合同平台增加某用户的印章图片。
`DeleteAccountResponse`	`DeleteAccount(DeleteAccountRequest req)` 删除企业电子合同平台的最终用户。
`DeleteSealResponse`	`DeleteSeal(DeleteSealRequest req)` 删除印章接口，删除指定账号的某个印章
`DescribeTaskStatusResponse`	`DescribeTaskStatus(DescribeTaskStatusRequest req)` 接口使用于：客户平台可使用该接口查询任务执行状态或者执行结果
`DownloadContractResponse`	`DownloadContract(DownloadContractRequest req)` 下载合同接口。
`SendVcodeResponse`	`SendVcode(SendVcodeRequest req)` 发送验证码接口。
`SignContractByCoordinateResponse`	`SignContractByCoordinate(SignContractByCoordinateRequest req)` 此接口适用于：客户平台在创建好合同后，由合同签署方对创建的合同内容进行确认，无误后再进行签署。
`SignContractByKeywordResponse`	`SignContractByKeyword(SignContractByKeywordRequest req)` 此接口适用于：客户平台在创建好合同后，由合同签署方对创建的合同内容进行确认，无误后再进行签署。

从类继承的方法 com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - DsClient
```
public DsClient(Credential credential,
                String region)
```
  - DsClient
```
public DsClient(Credential credential,
                String region,
                ClientProfile profile)
```
- 方法详细资料
  - CheckVcode
```
public CheckVcodeResponse CheckVcode(CheckVcodeRequest req)
                              throws TencentCloudSDKException
```
    检测验证码接口。此接口用于企业电子合同平台通过给用户发送短信验证码，以短信授权方式签署合同。此接口配合发送验证码接口使用。用户在企业电子合同平台输入收到的验证码后，由企业电子合同平台调用该接口向腾讯云提交确认受托签署合同验证码命令。验证码验证正确时，本次合同签署的授权成功。
    
    参数:
    
    req - CheckVcodeRequest
    
    返回:
    
    CheckVcodeResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateContractByUpload
```
public CreateContractByUploadResponse CreateContractByUpload(CreateContractByUploadRequest req)
                                                      throws TencentCloudSDKException
```
    此接口适用于：客户平台通过上传PDF文件作为合同，以备未来进行签署。接口返回任务号，可调用DescribeTaskStatus接口查看任务执行结果。
    
    参数:
    
    req - CreateContractByUploadRequest
    
    返回:
    
    CreateContractByUploadResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateEnterpriseAccount
```
public CreateEnterpriseAccountResponse CreateEnterpriseAccount(CreateEnterpriseAccountRequest req)
                                                        throws TencentCloudSDKException
```
    为企业电子合同平台的最终企业用户进行开户。在企业电子合同平台进行操作的企业用户，企业电子合同平台向腾讯云发送企业用户的信息，提交开户命令。腾讯云接到请求后，自动为企业电子合同平台的企业用户生成一张数字证书。
    
    参数:
    
    req - CreateEnterpriseAccountRequest
    
    返回:
    
    CreateEnterpriseAccountResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreatePersonalAccount
```
public CreatePersonalAccountResponse CreatePersonalAccount(CreatePersonalAccountRequest req)
                                                    throws TencentCloudSDKException
```
    为企业电子合同平台的最终个人用户进行开户。在企业电子合同平台进行操作的个人用户，企业电子合同平台向腾讯云发送个人用户的信息，提交开户命令。腾讯云接到请求后，自动为企业电子合同平台的个人用户生成一张数字证书。
    
    参数:
    
    req - CreatePersonalAccountRequest
    
    返回:
    
    CreatePersonalAccountResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateSeal
```
public CreateSealResponse CreateSeal(CreateSealRequest req)
                              throws TencentCloudSDKException
```
    此接口用于客户电子合同平台增加某用户的印章图片。客户平台可以调用此接口增加某用户的印章图片。
    
    参数:
    
    req - CreateSealRequest
    
    返回:
    
    CreateSealResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteAccount
```
public DeleteAccountResponse DeleteAccount(DeleteAccountRequest req)
                                    throws TencentCloudSDKException
```
    删除企业电子合同平台的最终用户。调用该接口后，腾讯云将删除该用户账号。删除账号后，已经签名的合同不受影响。
    
    参数:
    
    req - DeleteAccountRequest
    
    返回:
    
    DeleteAccountResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteSeal
```
public DeleteSealResponse DeleteSeal(DeleteSealRequest req)
                              throws TencentCloudSDKException
```
    删除印章接口，删除指定账号的某个印章
    
    参数:
    
    req - DeleteSealRequest
    
    返回:
    
    DeleteSealResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeTaskStatus
```
public DescribeTaskStatusResponse DescribeTaskStatus(DescribeTaskStatusRequest req)
                                              throws TencentCloudSDKException
```
    接口使用于：客户平台可使用该接口查询任务执行状态或者执行结果
    
    参数:
    
    req - DescribeTaskStatusRequest
    
    返回:
    
    DescribeTaskStatusResponse
    
    抛出:
    
    TencentCloudSDKException
  - DownloadContract
```
public DownloadContractResponse DownloadContract(DownloadContractRequest req)
                                          throws TencentCloudSDKException
```
    下载合同接口。调用该接口可以下载签署中和签署完成的合同。接口返回任务号，可调用DescribeTaskStatus接口查看任务执行结果。
    
    参数:
    
    req - DownloadContractRequest
    
    返回:
    
    DownloadContractResponse
    
    抛出:
    
    TencentCloudSDKException
  - SendVcode
```
public SendVcodeResponse SendVcode(SendVcodeRequest req)
                            throws TencentCloudSDKException
```
    发送验证码接口。此接口用于：企业电子合同平台需要腾讯云发送验证码对其用户进行验证时调用，腾讯云将向其用户联系手机(企业电子合同平台为用户开户时通过接口传入)发送验证码，以验证码授权方式签署合同。用户验证工作由企业电子合同平台自身完成。
    
    参数:
    
    req - SendVcodeRequest
    
    返回:
    
    SendVcodeResponse
    
    抛出:
    
    TencentCloudSDKException
  - SignContractByCoordinate
```
public SignContractByCoordinateResponse SignContractByCoordinate(SignContractByCoordinateRequest req)
                                                          throws TencentCloudSDKException
```
    此接口适用于：客户平台在创建好合同后，由合同签署方对创建的合同内容进行确认，无误后再进行签署。客户平台使用该接口提供详细的PDF文档签名坐标进行签署。
    
    参数:
    
    req - SignContractByCoordinateRequest
    
    返回:
    
    SignContractByCoordinateResponse
    
    抛出:
    
    TencentCloudSDKException
  - SignContractByKeyword
```
public SignContractByKeywordResponse SignContractByKeyword(SignContractByKeywordRequest req)
                                                    throws TencentCloudSDKException
```
    此接口适用于：客户平台在创建好合同后，由合同签署方对创建的合同内容进行确认，无误后再进行签署。客户平台使用该接口对PDF合同文档按照关键字和坐标进行签署。
    
    参数:
    
    req - SignContractByKeywordRequest
    
    返回:
    
    SignContractByKeywordResponse
    
    抛出:
    
    TencentCloudSDKException

类 DsClient

字段概要

从类继承的字段 com.tencentcloudapi.common.AbstractClient

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractClient

从类继承的方法 java.lang.Object

构造器详细资料

DsClient

DsClient

方法详细资料

CheckVcode

CreateContractByUpload

CreateEnterpriseAccount

CreatePersonalAccount

CreateSeal

DeleteAccount

DeleteSeal

DescribeTaskStatus

DownloadContract

SendVcode

SignContractByCoordinate

SignContractByKeyword