v20210526

package
v1.0.586 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 2, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// CAM签名/鉴权错误。
	AUTHFAILURE = "AuthFailure"

	// 操作失败。
	FAILEDOPERATION = "FailedOperation"

	// 签署人未达到合法年龄。
	FAILEDOPERATION_AGENOTACHIEVENORMALLEGAL = "FailedOperation.AgeNotAchieveNormalLegal"

	// 鉴权失败。
	FAILEDOPERATION_AUTHFAIL = "FailedOperation.AuthFail"

	// 存在同名印章。
	FAILEDOPERATION_EXISTSAMESEALNAME = "FailedOperation.ExistSameSealName"

	// 合同数目超出。
	FAILEDOPERATION_FLOWNUMEXCEED = "FailedOperation.FlowNumExceed"

	// 已授权。
	FAILEDOPERATION_HASAUTHORIZED = "FailedOperation.HasAuthorized"

	// 当前合同状态无法进行签署审批。
	FAILEDOPERATION_NOTAVAILABLESIGNREVIEW = "FailedOperation.NotAvailableSignReview"

	// 发起签署存在填写控件。
	FAILEDOPERATION_QRCODECREATORSIGNCOMPONENTS = "FailedOperation.QrCodeCreatorSignComponents"

	// 模板签署人不存在。
	FAILEDOPERATION_QRCODESIGNUSERS = "FailedOperation.QrCodeSignUsers"

	// 签署二维码模板信息有误,请检查参数后重试。
	FAILEDOPERATION_QRCODETEMPLATEID = "FailedOperation.QrCodeTemplateId"

	// 员工已实名。
	FAILEDOPERATION_STAFFALREADYVERIFY = "FailedOperation.StaffAlreadyVerify"

	// 内部错误。
	INTERNALERROR = "InternalError"

	// 其他API错误。
	INTERNALERROR_API = "InternalError.Api"

	// 数据库错误。
	INTERNALERROR_DB = "InternalError.Db"

	// 数据库连接出错。
	INTERNALERROR_DBCONNECTION = "InternalError.DbConnection"

	// 数据库新增记录出错。
	INTERNALERROR_DBINSERT = "InternalError.DbInsert"

	// 数据库读取失败。
	INTERNALERROR_DBREAD = "InternalError.DbRead"

	// 数据库更新记录出错。
	INTERNALERROR_DBUPDATE = "InternalError.DbUpdate"

	// 解密错误。
	INTERNALERROR_DECRYPTION = "InternalError.Decryption"

	// 依赖的其他api出错。
	INTERNALERROR_DEPENDSAPI = "InternalError.DependsApi"

	// 加密错误。
	INTERNALERROR_ENCRYPTION = "InternalError.Encryption"

	// 生成唯一ID错误。
	INTERNALERROR_GENERATEID = "InternalError.GenerateId"

	// Pdf合成错误。
	INTERNALERROR_PDF = "InternalError.Pdf"

	// 上传印章失败。
	INTERNALERROR_SEALUPLOAD = "InternalError.SealUpload"

	// 序列化错误。
	INTERNALERROR_SERIALIZE = "InternalError.Serialize"

	// 系统错误。
	INTERNALERROR_SYSTEM = "InternalError.System"

	// 第三方错误。
	INTERNALERROR_THIRDPARTY = "InternalError.ThirdParty"

	// 参数错误。
	INVALIDPARAMETER = "InvalidParameter"

	// 应用号不存在。
	INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"

	// 参数错误,不合法的签署人类型,请修改后重试。
	INVALIDPARAMETER_APPROVERTYPE = "InvalidParameter.ApproverType"

	// 重复添加签署人。
	INVALIDPARAMETER_BIZAPPROVERALREADYEXISTS = "InvalidParameter.BizApproverAlreadyExists"

	// 营业执照格式不合法。
	INVALIDPARAMETER_BUSINESSLICENSE = "InvalidParameter.BusinessLicense"

	// 撤销理由填写格式错误。
	INVALIDPARAMETER_CANCELREASON = "InvalidParameter.CancelReason"

	// 证件类型错误。
	INVALIDPARAMETER_CARDTYPE = "InvalidParameter.CardType"

	// 参数错误,控件内容无效。
	INVALIDPARAMETER_COMPONENTVALUE = "InvalidParameter.ComponentValue"

	// 查询内容参数有误。
	INVALIDPARAMETER_CONTENTTYPE = "InvalidParameter.ContentType"

	// 参数错误,无效的自定义页卡模板,仅支持{合同名称}{发起方姓名}{发起方企业}{签署方N姓名}{签署方N企业},请修改后重试。
	INVALIDPARAMETER_CUSTOMSHOWMAP = "InvalidParameter.CustomShowMap"

	// 参数错误,UserData长度非法,请修改后重试。
	INVALIDPARAMETER_CUSTOMERDATA = "InvalidParameter.CustomerData"

	// 数据不存在。
	INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"

	// 参数错误,不合法的日期,请检查后重试。
	INVALIDPARAMETER_DATE = "InvalidParameter.Date"

	// 员工ID不正确。
	INVALIDPARAMETER_DEPARTUSERID = "InvalidParameter.DepartUserId"

	// 重复提交任务。
	INVALIDPARAMETER_DUPTASK = "InvalidParameter.DupTask"

	// 参数为空。
	INVALIDPARAMETER_EMPTYPARAMS = "InvalidParameter.EmptyParams"

	// 不合法的EndPoint,请检查修改后重试。
	INVALIDPARAMETER_ENDPOINT = "InvalidParameter.EndPoint"

	// 文件类型不合法。
	INVALIDPARAMETER_FILETYPE = "InvalidParameter.FileType"

	// 参数错误,不合法的备选签署人数量,请检查后重试。
	INVALIDPARAMETER_FLOWAPPROVERINFOS = "InvalidParameter.FlowApproverInfos"

	// 参数错误,参与者数量不能为空且不能超过数量限制,请修改后重试。
	INVALIDPARAMETER_FLOWAPPROVERS = "InvalidParameter.FlowApprovers"

	// 参数错误,不合法的签署流程回调链接,请修改后重试。
	INVALIDPARAMETER_FLOWCALLBACKURL = "InvalidParameter.FlowCallbackUrl"

	// 参数错误,不合法的签署流程截止日期,请修改后重试。
	INVALIDPARAMETER_FLOWDEADLINE = "InvalidParameter.FlowDeadLine"

	// 参数错误,不合法的签署流程描述,请修改后重试。
	INVALIDPARAMETER_FLOWDESCRIPTION = "InvalidParameter.FlowDescription"

	// 参数错误,目前仅支持单个文件发起,请修改后重试。
	INVALIDPARAMETER_FLOWFILEIDS = "InvalidParameter.FlowFileIds"

	// 参数错误,合同id列表长度非法,请检查后重试。
	INVALIDPARAMETER_FLOWIDS = "InvalidParameter.FlowIds"

	// 参数错误,FlowInfos非法,请修改后重试。
	INVALIDPARAMETER_FLOWINFOS = "InvalidParameter.FlowInfos"

	// 参数错误,不合法的签署流程名称,请修改后重试。
	INVALIDPARAMETER_FLOWNAME = "InvalidParameter.FlowName"

	// 参数错误,不合法的FlowType,请修改后重试。
	INVALIDPARAMETER_FLOWTYPE = "InvalidParameter.FlowType"

	// 参数错误,不受支持的GenerateType,请检查后重试。
	INVALIDPARAMETER_GENERATETYPE = "InvalidParameter.GenerateType"

	// 图片不正确。
	INVALIDPARAMETER_IMAGE = "InvalidParameter.Image"

	// 印章名称长度超出。
	INVALIDPARAMETER_LIMITSEALNAME = "InvalidParameter.LimitSealName"

	// 菜单栏状态非法。
	INVALIDPARAMETER_MENUSTATUS = "InvalidParameter.MenuStatus"

	// 缺少必填参数的值。
	INVALIDPARAMETER_MISSINGREQUIREDPARAMETERVALUE = "InvalidParameter.MissingRequiredParameterValue"

	// 手机号码不正确。
	INVALIDPARAMETER_MOBILE = "InvalidParameter.Mobile"

	// 姓名不符合要求。
	INVALIDPARAMETER_NAME = "InvalidParameter.Name"

	// 不支持的手机号。
	INVALIDPARAMETER_NONSUPPORTMOBILE = "InvalidParameter.NonsupportMobile"

	// OpenId不合法。
	INVALIDPARAMETER_OPENID = "InvalidParameter.OpenId"

	// OrganizationId不合法。
	INVALIDPARAMETER_ORGANIZATIONID = "InvalidParameter.OrganizationId"

	// 企业名称不合法。
	INVALIDPARAMETER_ORGANIZATIONNAME = "InvalidParameter.OrganizationName"

	// 参数错误。
	INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"

	// 文件内容敏感信息。
	INVALIDPARAMETER_SENSITIVEFILECONTENT = "InvalidParameter.SensitiveFileContent"

	// 参数错误,不合法的签署控件类型,请修改后重试。
	INVALIDPARAMETER_SIGNCOMPONENTTYPE = "InvalidParameter.SignComponentType"

	// 状态异常。
	INVALIDPARAMETER_STATUS = "InvalidParameter.Status"

	// 参数错误,不合法的签署顺序,请检查后重试。
	INVALIDPARAMETER_UNORDERED = "InvalidParameter.Unordered"

	// 参数错误,不支持的控件类型,请检查后重试。
	INVALIDPARAMETER_UNSUPPORTEDCOMPONENTTYPE = "InvalidParameter.UnsupportedComponentType"

	// 参数取值错误。
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// 超过配额限制。
	LIMITEXCEEDED = "LimitExceeded"

	// 超出调用次数限制。
	LIMITEXCEEDED_CALLTIMES = "LimitExceeded.CallTimes"

	// 超出流程创建数量限制。
	LIMITEXCEEDED_CREATEFLOWNUM = "LimitExceeded.CreateFlowNum"

	// 文件大小限制。
	LIMITEXCEEDED_FILESIZE = "LimitExceeded.FileSize"

	// 合同id数超出限制。
	LIMITEXCEEDED_FLOWIDS = "LimitExceeded.FlowIds"

	// 超出流程数量限制。
	LIMITEXCEEDED_FLOWINFOS = "LimitExceeded.FlowInfos"

	// 经办人数据超出。
	LIMITEXCEEDED_PROXYORGANIZATIONOPERATOR = "LimitExceeded.ProxyOrganizationOperator"

	// 缺少参数错误。
	MISSINGPARAMETER = "MissingParameter"

	// 合作企业激活信息不存在。
	MISSINGPARAMETER_COMPANYACTIVEINFO = "MissingParameter.CompanyActiveInfo"

	// 缺少时间参数,请检查后重试。
	MISSINGPARAMETER_DATE = "MissingParameter.Date"

	// 缺少流程id,请检查后重试。
	MISSINGPARAMETER_FLOWID = "MissingParameter.FlowId"

	// 缺少流程id,请检查后重试。
	MISSINGPARAMETER_FLOWIDS = "MissingParameter.FlowIds"

	// 请传入需要查询的合同或合同组的ID。
	MISSINGPARAMETER_FLOWIDSORFLOWGROUPID = "MissingParameter.FlowIdsOrFlowGroupId"

	// 未指定流程合同信息。
	MISSINGPARAMETER_FLOWINFO = "MissingParameter.FlowInfo"

	// 缺少控件名称参数,请检查后重试。
	MISSINGPARAMETER_MISSCOMPONENTNAME = "MissingParameter.MissComponentName"

	// 企业OpenId不存在。
	MISSINGPARAMETER_ORGOPENID = "MissingParameter.OrgOpenId"

	// 企业信息为空。
	MISSINGPARAMETER_ORGANIZATIONID = "MissingParameter.OrganizationId"

	// ProxyOperatorOpenId不存在。
	MISSINGPARAMETER_PROXYOPERATOROPENID = "MissingParameter.ProxyOperatorOpenId"

	// 印章ID为空。
	MISSINGPARAMETER_SEALID = "MissingParameter.SealId"

	// 印章图片为空。
	MISSINGPARAMETER_SEALIMAGE = "MissingParameter.SealImage"

	// 印章名称为空。
	MISSINGPARAMETER_SEALNAME = "MissingParameter.SealName"

	// 签署人缺少签署控件。
	MISSINGPARAMETER_SIGNCOMPONENTS = "MissingParameter.SignComponents"

	// 缺少模板参数。
	MISSINGPARAMETER_TEMPLATES = "MissingParameter.Templates"

	// OpenId不存在。
	MISSINGPARAMETER_USEROPENID = "MissingParameter.UserOpenId"

	// 操作被拒绝。
	OPERATIONDENIED = "OperationDenied"

	// 不支持的可见性标识。
	OPERATIONDENIED_AUTHTAG = "OperationDenied.AuthTag"

	// 应用号已被禁止。
	OPERATIONDENIED_BANNEDAPPLICATION = "OperationDenied.BannedApplication"

	// 文件发起静默签未开通白名单。
	OPERATIONDENIED_BYFILESSERVERSIGNFORBID = "OperationDenied.ByFilesServerSignForbid"

	// 只支持下载单个。
	OPERATIONDENIED_DOWNLOADMORETHANONE = "OperationDenied.DownLoadMoreThanOne"

	// 无资源访问权限。
	OPERATIONDENIED_ERRNORESOURCEACCESS = "OperationDenied.ErrNoResourceAccess"

	// 文件已删除。
	OPERATIONDENIED_FILEDELETED = "OperationDenied.FileDeleted"

	// 流程已终止。
	OPERATIONDENIED_FLOWHASTERMINATED = "OperationDenied.FlowHasTerminated"

	// 签署流程状态不正确,请检查后重试。
	OPERATIONDENIED_FLOWSTATUSFORBID = "OperationDenied.FlowStatusForbid"

	// 禁止操作。
	OPERATIONDENIED_FORBID = "OperationDenied.Forbid"

	// 签署人未达到合法年龄。
	OPERATIONDENIED_INVALIDAPPROVERAGE = "OperationDenied.InvalidApproverAge"

	// 没有API权限。
	OPERATIONDENIED_NOAPIAUTH = "OperationDenied.NoApiAuth"

	// 无权操作合同。
	OPERATIONDENIED_NOFLOWPERMISSION = "OperationDenied.NoFlowPermission"

	// 未通过个人实名。
	OPERATIONDENIED_NOIDENTITYVERIFY = "OperationDenied.NoIdentityVerify"

	// 流程配额不足。
	OPERATIONDENIED_NOQUOTA = "OperationDenied.NoQuota"

	// 不属于企业超管或者法人。
	OPERATIONDENIED_NOTBELONGSUPERADMINORLEGALPERSON = "OperationDenied.NotBelongSuperAdminOrLegalPerson"

	// 操作类型不支持。
	OPERATIONDENIED_OPERATETYPE = "OperationDenied.OperateType"

	// 操作者权限不足。
	OPERATIONDENIED_OPERATORHASNOPERMISSION = "OperationDenied.OperatorHasNoPermission"

	// 超出查询上限。
	OPERATIONDENIED_OUTQUERYLIMIT = "OperationDenied.OutQueryLimit"

	// 当前企业员工没有开通境外签署能力。
	OPERATIONDENIED_OVERSEAABILITYNOTOPEN = "OperationDenied.OverseaAbilityNotOpen"

	// 出证计费额度不足。
	OPERATIONDENIED_PROVENOQUOTA = "OperationDenied.ProveNoQuota"

	// 用户不归属于当前企业,无法操作,请检查后重试。
	OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"

	// 未开通功能白名单,请联系客服处理。
	OPERATIONDENIED_WHITELISTFORBID = "OperationDenied.WhiteListForbid"

	// 资源不存在。
	RESOURCENOTFOUND = "ResourceNotFound"

	// 应用号不存在。
	RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"

	// 应用授权记录未找到。
	RESOURCENOTFOUND_APPLICATIONAUTH = "ResourceNotFound.ApplicationAuth"

	// ApplicationId不存在。
	RESOURCENOTFOUND_APPLICATIONID = "ResourceNotFound.ApplicationId"

	// 文件不存在。
	RESOURCENOTFOUND_FILE = "ResourceNotFound.File"

	// 未找到对应流程。
	RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"

	// 签署流程的签署人不存在,请检查后重试。
	RESOURCENOTFOUND_FLOWAPPROVER = "ResourceNotFound.FlowApprover"

	// 签署人信息不存在,请检查后重试。
	RESOURCENOTFOUND_FLOWAPPROVERS = "ResourceNotFound.FlowApprovers"

	// 合同组不存在。
	RESOURCENOTFOUND_FLOWGROUP = "ResourceNotFound.FlowGroup"

	// 机构不存在。
	RESOURCENOTFOUND_ORGANIZATION = "ResourceNotFound.Organization"

	// 资源不存在。
	RESOURCENOTFOUND_RESOURCE = "ResourceNotFound.Resource"

	// 印章不存在,请检查后重试。
	RESOURCENOTFOUND_SEAL = "ResourceNotFound.Seal"

	// 合作企业不存在。
	RESOURCENOTFOUND_TEAMWORKORGANIZATION = "ResourceNotFound.TeamWorkOrganization"

	// 模板不存在。
	RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"

	// Url不存在。
	RESOURCENOTFOUND_URL = "ResourceNotFound.URL"

	// 用户信息不存在。
	RESOURCENOTFOUND_USER = "ResourceNotFound.User"

	// 实名用户信息不存在。
	RESOURCENOTFOUND_VERIFYUSER = "ResourceNotFound.VerifyUser"

	// 资源不可用。
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// 未授权操作。
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// 请升级到对应版本后即可使用该接口。
	UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

	// 未授权下载权限。
	UNAUTHORIZEDOPERATION_UNAUTHORIZEDOPERATIONDOWNLOAD = "UnauthorizedOperation.UnauthorizedOperationDownload"

	// 企业没有被授权。
	UNAUTHORIZEDOPERATION_UNAUTHORIZEDOPERATIONORGANIZATION = "UnauthorizedOperation.UnauthorizedOperationOrganization"

	// 未知参数错误。
	UNKNOWNPARAMETER = "UnknownParameter"

	// 操作不支持。
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
View Source
const APIVersion = "2021-05-26"

Variables

This section is empty.

Functions

This section is empty.

Types

type Agent

type Agent struct {
	// 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
	AppId *string `json:"AppId,omitempty" name:"AppId"`

	// 渠道平台自定义,对于渠道子客企业的唯一标识。一个渠道子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要渠道平台保存),最大64位字符串
	ProxyOrganizationOpenId *string `json:"ProxyOrganizationOpenId,omitempty" name:"ProxyOrganizationOpenId"`

	// 渠道子客企业中的员工/经办人,通过渠道平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
	ProxyOperator *UserInfo `json:"ProxyOperator,omitempty" name:"ProxyOperator"`

	// 在子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
	ProxyAppId *string `json:"ProxyAppId,omitempty" name:"ProxyAppId"`

	// 内部参数,暂未开放使用
	ProxyOrganizationId *string `json:"ProxyOrganizationId,omitempty" name:"ProxyOrganizationId"`
}

type ApproverOption added in v1.0.522

type ApproverOption struct {
	// 是否隐藏一键签署 false-不隐藏,默认 true-隐藏
	HideOneKeySign *bool `json:"HideOneKeySign,omitempty" name:"HideOneKeySign"`
}

type ApproverRestriction added in v1.0.458

type ApproverRestriction struct {
	// 指定签署人名字
	Name *string `json:"Name,omitempty" name:"Name"`

	// 指定签署人手机号
	Mobile *string `json:"Mobile,omitempty" name:"Mobile"`

	// 指定签署人证件类型
	IdCardType *string `json:"IdCardType,omitempty" name:"IdCardType"`

	// 指定签署人证件号码
	IdCardNumber *string `json:"IdCardNumber,omitempty" name:"IdCardNumber"`
}

type AuthFailMessage added in v1.0.317

type AuthFailMessage struct {
	// 合作企业Id
	ProxyOrganizationOpenId *string `json:"ProxyOrganizationOpenId,omitempty" name:"ProxyOrganizationOpenId"`

	// 出错信息
	Message *string `json:"Message,omitempty" name:"Message"`
}

type AuthorizedUser added in v1.0.532

type AuthorizedUser struct {
	// 用户openid
	OpenId *string `json:"OpenId,omitempty" name:"OpenId"`
}

type CcInfo added in v1.0.318

type CcInfo struct {
	// 被抄送人手机号,大陆11位手机号
	Mobile *string `json:"Mobile,omitempty" name:"Mobile"`
}

type ChannelBatchCancelFlowsRequest added in v1.0.494

type ChannelBatchCancelFlowsRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署流程Id数组,最多100个,超过100不处理
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 撤销理由
	CancelMessage *string `json:"CancelMessage,omitempty" name:"CancelMessage"`

	// 撤销理由自定义格式;选项:
	// 0 默认格式
	// 1 只保留身份信息:展示为【发起方】
	// 2 保留身份信息+企业名称:展示为【发起方xxx公司】
	// 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
	CancelMessageFormat *int64 `json:"CancelMessageFormat,omitempty" name:"CancelMessageFormat"`

	// 操作人信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewChannelBatchCancelFlowsRequest added in v1.0.494

func NewChannelBatchCancelFlowsRequest() (request *ChannelBatchCancelFlowsRequest)

func (*ChannelBatchCancelFlowsRequest) FromJsonString added in v1.0.494

func (r *ChannelBatchCancelFlowsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelBatchCancelFlowsRequest) ToJsonString added in v1.0.494

func (r *ChannelBatchCancelFlowsRequest) ToJsonString() string

type ChannelBatchCancelFlowsRequestParams added in v1.0.494

type ChannelBatchCancelFlowsRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署流程Id数组,最多100个,超过100不处理
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 撤销理由
	CancelMessage *string `json:"CancelMessage,omitempty" name:"CancelMessage"`

	// 撤销理由自定义格式;选项:
	// 0 默认格式
	// 1 只保留身份信息:展示为【发起方】
	// 2 保留身份信息+企业名称:展示为【发起方xxx公司】
	// 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
	CancelMessageFormat *int64 `json:"CancelMessageFormat,omitempty" name:"CancelMessageFormat"`

	// 操作人信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type ChannelBatchCancelFlowsResponse added in v1.0.494

type ChannelBatchCancelFlowsResponse struct {
	*tchttp.BaseResponse
	Response *ChannelBatchCancelFlowsResponseParams `json:"Response"`
}

func NewChannelBatchCancelFlowsResponse added in v1.0.494

func NewChannelBatchCancelFlowsResponse() (response *ChannelBatchCancelFlowsResponse)

func (*ChannelBatchCancelFlowsResponse) FromJsonString added in v1.0.494

func (r *ChannelBatchCancelFlowsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelBatchCancelFlowsResponse) ToJsonString added in v1.0.494

func (r *ChannelBatchCancelFlowsResponse) ToJsonString() string

type ChannelBatchCancelFlowsResponseParams added in v1.0.494

type ChannelBatchCancelFlowsResponseParams struct {
	// 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为“”,失败则对应失败消息
	FailMessages []*string `json:"FailMessages,omitempty" name:"FailMessages"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelCancelFlowRequest added in v1.0.521

type ChannelCancelFlowRequest struct {
	*tchttp.BaseRequest

	// 签署流程编号
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 撤回原因,最大不超过200字符
	CancelMessage *string `json:"CancelMessage,omitempty" name:"CancelMessage"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 撤销理由自定义格式;选项:
	// 0 默认格式
	// 1 只保留身份信息:展示为【发起方】
	// 2 保留身份信息+企业名称:展示为【发起方xxx公司】
	// 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
	CancelMessageFormat *int64 `json:"CancelMessageFormat,omitempty" name:"CancelMessageFormat"`
}

func NewChannelCancelFlowRequest added in v1.0.521

func NewChannelCancelFlowRequest() (request *ChannelCancelFlowRequest)

func (*ChannelCancelFlowRequest) FromJsonString added in v1.0.521

func (r *ChannelCancelFlowRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCancelFlowRequest) ToJsonString added in v1.0.521

func (r *ChannelCancelFlowRequest) ToJsonString() string

type ChannelCancelFlowRequestParams added in v1.0.521

type ChannelCancelFlowRequestParams struct {
	// 签署流程编号
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 撤回原因,最大不超过200字符
	CancelMessage *string `json:"CancelMessage,omitempty" name:"CancelMessage"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 撤销理由自定义格式;选项:
	// 0 默认格式
	// 1 只保留身份信息:展示为【发起方】
	// 2 保留身份信息+企业名称:展示为【发起方xxx公司】
	// 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
	CancelMessageFormat *int64 `json:"CancelMessageFormat,omitempty" name:"CancelMessageFormat"`
}

Predefined struct for user

type ChannelCancelFlowResponse added in v1.0.521

type ChannelCancelFlowResponse struct {
	*tchttp.BaseResponse
	Response *ChannelCancelFlowResponseParams `json:"Response"`
}

func NewChannelCancelFlowResponse added in v1.0.521

func NewChannelCancelFlowResponse() (response *ChannelCancelFlowResponse)

func (*ChannelCancelFlowResponse) FromJsonString added in v1.0.521

func (r *ChannelCancelFlowResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCancelFlowResponse) ToJsonString added in v1.0.521

func (r *ChannelCancelFlowResponse) ToJsonString() string

type ChannelCancelFlowResponseParams added in v1.0.521

type ChannelCancelFlowResponseParams struct {
	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelCancelMultiFlowSignQRCodeRequest added in v1.0.418

type ChannelCancelMultiFlowSignQRCodeRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 二维码id
	QrCodeId *string `json:"QrCodeId,omitempty" name:"QrCodeId"`

	// 用户信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewChannelCancelMultiFlowSignQRCodeRequest added in v1.0.418

func NewChannelCancelMultiFlowSignQRCodeRequest() (request *ChannelCancelMultiFlowSignQRCodeRequest)

func (*ChannelCancelMultiFlowSignQRCodeRequest) FromJsonString added in v1.0.418

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCancelMultiFlowSignQRCodeRequest) ToJsonString added in v1.0.418

type ChannelCancelMultiFlowSignQRCodeRequestParams added in v1.0.426

type ChannelCancelMultiFlowSignQRCodeRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 二维码id
	QrCodeId *string `json:"QrCodeId,omitempty" name:"QrCodeId"`

	// 用户信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type ChannelCancelMultiFlowSignQRCodeResponse added in v1.0.418

type ChannelCancelMultiFlowSignQRCodeResponse struct {
	*tchttp.BaseResponse
	Response *ChannelCancelMultiFlowSignQRCodeResponseParams `json:"Response"`
}

func NewChannelCancelMultiFlowSignQRCodeResponse added in v1.0.418

func NewChannelCancelMultiFlowSignQRCodeResponse() (response *ChannelCancelMultiFlowSignQRCodeResponse)

func (*ChannelCancelMultiFlowSignQRCodeResponse) FromJsonString added in v1.0.418

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCancelMultiFlowSignQRCodeResponse) ToJsonString added in v1.0.418

type ChannelCancelMultiFlowSignQRCodeResponseParams added in v1.0.426

type ChannelCancelMultiFlowSignQRCodeResponseParams struct {
	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelCreateBatchCancelFlowUrlRequest added in v1.0.458

type ChannelCreateBatchCancelFlowUrlRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署流程Id数组
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 操作人信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewChannelCreateBatchCancelFlowUrlRequest added in v1.0.458

func NewChannelCreateBatchCancelFlowUrlRequest() (request *ChannelCreateBatchCancelFlowUrlRequest)

func (*ChannelCreateBatchCancelFlowUrlRequest) FromJsonString added in v1.0.458

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateBatchCancelFlowUrlRequest) ToJsonString added in v1.0.458

type ChannelCreateBatchCancelFlowUrlRequestParams added in v1.0.458

type ChannelCreateBatchCancelFlowUrlRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署流程Id数组
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 操作人信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type ChannelCreateBatchCancelFlowUrlResponse added in v1.0.458

type ChannelCreateBatchCancelFlowUrlResponse struct {
	*tchttp.BaseResponse
	Response *ChannelCreateBatchCancelFlowUrlResponseParams `json:"Response"`
}

func NewChannelCreateBatchCancelFlowUrlResponse added in v1.0.458

func NewChannelCreateBatchCancelFlowUrlResponse() (response *ChannelCreateBatchCancelFlowUrlResponse)

func (*ChannelCreateBatchCancelFlowUrlResponse) FromJsonString added in v1.0.458

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateBatchCancelFlowUrlResponse) ToJsonString added in v1.0.458

type ChannelCreateBatchCancelFlowUrlResponseParams added in v1.0.458

type ChannelCreateBatchCancelFlowUrlResponseParams struct {
	// 批量撤销url
	BatchCancelFlowUrl *string `json:"BatchCancelFlowUrl,omitempty" name:"BatchCancelFlowUrl"`

	// 签署流程批量撤销失败原因
	FailMessages []*string `json:"FailMessages,omitempty" name:"FailMessages"`

	// 签署撤销url过期时间-年月日-时分秒
	UrlExpireOn *string `json:"UrlExpireOn,omitempty" name:"UrlExpireOn"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelCreateBoundFlowsRequest added in v1.0.541

type ChannelCreateBoundFlowsRequest struct {
	*tchttp.BaseRequest

	// 应用信息
	// 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 领取的合同id列表
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 暂未开放
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewChannelCreateBoundFlowsRequest added in v1.0.541

func NewChannelCreateBoundFlowsRequest() (request *ChannelCreateBoundFlowsRequest)

func (*ChannelCreateBoundFlowsRequest) FromJsonString added in v1.0.541

func (r *ChannelCreateBoundFlowsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateBoundFlowsRequest) ToJsonString added in v1.0.541

func (r *ChannelCreateBoundFlowsRequest) ToJsonString() string

type ChannelCreateBoundFlowsRequestParams added in v1.0.541

type ChannelCreateBoundFlowsRequestParams struct {
	// 应用信息
	// 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 领取的合同id列表
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 暂未开放
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type ChannelCreateBoundFlowsResponse added in v1.0.541

type ChannelCreateBoundFlowsResponse struct {
	*tchttp.BaseResponse
	Response *ChannelCreateBoundFlowsResponseParams `json:"Response"`
}

func NewChannelCreateBoundFlowsResponse added in v1.0.541

func NewChannelCreateBoundFlowsResponse() (response *ChannelCreateBoundFlowsResponse)

func (*ChannelCreateBoundFlowsResponse) FromJsonString added in v1.0.541

func (r *ChannelCreateBoundFlowsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateBoundFlowsResponse) ToJsonString added in v1.0.541

func (r *ChannelCreateBoundFlowsResponse) ToJsonString() string

type ChannelCreateBoundFlowsResponseParams added in v1.0.541

type ChannelCreateBoundFlowsResponseParams struct {
	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelCreateConvertTaskApiRequest added in v1.0.467

type ChannelCreateConvertTaskApiRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 资源类型 取值范围doc,docx,html,xls,xlsx之一
	ResourceType *string `json:"ResourceType,omitempty" name:"ResourceType"`

	// 资源名称,长度限制为256字符
	ResourceName *string `json:"ResourceName,omitempty" name:"ResourceName"`

	// 资源Id,通过UploadFiles获取
	ResourceId *string `json:"ResourceId,omitempty" name:"ResourceId"`

	// 调用方用户信息,userId 必填
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 暂未开放
	Organization *OrganizationInfo `json:"Organization,omitempty" name:"Organization"`
}

func NewChannelCreateConvertTaskApiRequest added in v1.0.467

func NewChannelCreateConvertTaskApiRequest() (request *ChannelCreateConvertTaskApiRequest)

func (*ChannelCreateConvertTaskApiRequest) FromJsonString added in v1.0.467

func (r *ChannelCreateConvertTaskApiRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateConvertTaskApiRequest) ToJsonString added in v1.0.467

func (r *ChannelCreateConvertTaskApiRequest) ToJsonString() string

type ChannelCreateConvertTaskApiRequestParams added in v1.0.467

type ChannelCreateConvertTaskApiRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 资源类型 取值范围doc,docx,html,xls,xlsx之一
	ResourceType *string `json:"ResourceType,omitempty" name:"ResourceType"`

	// 资源名称,长度限制为256字符
	ResourceName *string `json:"ResourceName,omitempty" name:"ResourceName"`

	// 资源Id,通过UploadFiles获取
	ResourceId *string `json:"ResourceId,omitempty" name:"ResourceId"`

	// 调用方用户信息,userId 必填
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 暂未开放
	Organization *OrganizationInfo `json:"Organization,omitempty" name:"Organization"`
}

Predefined struct for user

type ChannelCreateConvertTaskApiResponse added in v1.0.467

type ChannelCreateConvertTaskApiResponse struct {
	*tchttp.BaseResponse
	Response *ChannelCreateConvertTaskApiResponseParams `json:"Response"`
}

func NewChannelCreateConvertTaskApiResponse added in v1.0.467

func NewChannelCreateConvertTaskApiResponse() (response *ChannelCreateConvertTaskApiResponse)

func (*ChannelCreateConvertTaskApiResponse) FromJsonString added in v1.0.467

func (r *ChannelCreateConvertTaskApiResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateConvertTaskApiResponse) ToJsonString added in v1.0.467

func (r *ChannelCreateConvertTaskApiResponse) ToJsonString() string

type ChannelCreateConvertTaskApiResponseParams added in v1.0.467

type ChannelCreateConvertTaskApiResponseParams struct {
	// 任务id
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelCreateFlowByFilesRequest added in v1.0.390

type ChannelCreateFlowByFilesRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署流程名称,长度不超过200个字符
	FlowName *string `json:"FlowName,omitempty" name:"FlowName"`

	// 签署流程签约方列表,最多不超过5个参与方
	FlowApprovers []*FlowApproverInfo `json:"FlowApprovers,omitempty" name:"FlowApprovers"`

	// 签署文件资源Id列表,目前仅支持单个文件
	FileIds []*string `json:"FileIds,omitempty" name:"FileIds"`

	// 签署文件中的发起方的填写控件,需要在发起的时候进行填充
	Components []*Component `json:"Components,omitempty" name:"Components"`

	// 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
	Deadline *int64 `json:"Deadline,omitempty" name:"Deadline"`

	// 签署流程回调地址,长度不超过255个字符
	CallbackUrl *string `json:"CallbackUrl,omitempty" name:"CallbackUrl"`

	// 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
	Unordered *bool `json:"Unordered,omitempty" name:"Unordered"`

	// 签署流程的类型,长度不超过255个字符
	FlowType *string `json:"FlowType,omitempty" name:"FlowType"`

	// 签署流程的描述,长度不超过1000个字符
	FlowDescription *string `json:"FlowDescription,omitempty" name:"FlowDescription"`

	// 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
	CustomShowMap *string `json:"CustomShowMap,omitempty" name:"CustomShowMap"`

	// 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
	CustomerData *string `json:"CustomerData,omitempty" name:"CustomerData"`

	// 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。  注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
	NeedSignReview *bool `json:"NeedSignReview,omitempty" name:"NeedSignReview"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 签署人校验方式
	// VerifyCheck: 人脸识别(默认)
	// MobileCheck:手机号验证
	// 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
	ApproverVerifyType *string `json:"ApproverVerifyType,omitempty" name:"ApproverVerifyType"`

	// 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
	SignBeanTag *int64 `json:"SignBeanTag,omitempty" name:"SignBeanTag"`
}

func NewChannelCreateFlowByFilesRequest added in v1.0.390

func NewChannelCreateFlowByFilesRequest() (request *ChannelCreateFlowByFilesRequest)

func (*ChannelCreateFlowByFilesRequest) FromJsonString added in v1.0.390

func (r *ChannelCreateFlowByFilesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateFlowByFilesRequest) ToJsonString added in v1.0.390

func (r *ChannelCreateFlowByFilesRequest) ToJsonString() string

type ChannelCreateFlowByFilesRequestParams added in v1.0.426

type ChannelCreateFlowByFilesRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署流程名称,长度不超过200个字符
	FlowName *string `json:"FlowName,omitempty" name:"FlowName"`

	// 签署流程签约方列表,最多不超过5个参与方
	FlowApprovers []*FlowApproverInfo `json:"FlowApprovers,omitempty" name:"FlowApprovers"`

	// 签署文件资源Id列表,目前仅支持单个文件
	FileIds []*string `json:"FileIds,omitempty" name:"FileIds"`

	// 签署文件中的发起方的填写控件,需要在发起的时候进行填充
	Components []*Component `json:"Components,omitempty" name:"Components"`

	// 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
	Deadline *int64 `json:"Deadline,omitempty" name:"Deadline"`

	// 签署流程回调地址,长度不超过255个字符
	CallbackUrl *string `json:"CallbackUrl,omitempty" name:"CallbackUrl"`

	// 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
	Unordered *bool `json:"Unordered,omitempty" name:"Unordered"`

	// 签署流程的类型,长度不超过255个字符
	FlowType *string `json:"FlowType,omitempty" name:"FlowType"`

	// 签署流程的描述,长度不超过1000个字符
	FlowDescription *string `json:"FlowDescription,omitempty" name:"FlowDescription"`

	// 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
	CustomShowMap *string `json:"CustomShowMap,omitempty" name:"CustomShowMap"`

	// 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
	CustomerData *string `json:"CustomerData,omitempty" name:"CustomerData"`

	// 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。  注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
	NeedSignReview *bool `json:"NeedSignReview,omitempty" name:"NeedSignReview"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 签署人校验方式
	// VerifyCheck: 人脸识别(默认)
	// MobileCheck:手机号验证
	// 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
	ApproverVerifyType *string `json:"ApproverVerifyType,omitempty" name:"ApproverVerifyType"`

	// 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
	SignBeanTag *int64 `json:"SignBeanTag,omitempty" name:"SignBeanTag"`
}

Predefined struct for user

type ChannelCreateFlowByFilesResponse added in v1.0.390

type ChannelCreateFlowByFilesResponse struct {
	*tchttp.BaseResponse
	Response *ChannelCreateFlowByFilesResponseParams `json:"Response"`
}

func NewChannelCreateFlowByFilesResponse added in v1.0.390

func NewChannelCreateFlowByFilesResponse() (response *ChannelCreateFlowByFilesResponse)

func (*ChannelCreateFlowByFilesResponse) FromJsonString added in v1.0.390

func (r *ChannelCreateFlowByFilesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateFlowByFilesResponse) ToJsonString added in v1.0.390

func (r *ChannelCreateFlowByFilesResponse) ToJsonString() string

type ChannelCreateFlowByFilesResponseParams added in v1.0.426

type ChannelCreateFlowByFilesResponseParams struct {
	// 合同签署流程ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelCreateFlowGroupByFilesRequest added in v1.0.494

type ChannelCreateFlowGroupByFilesRequest struct {
	*tchttp.BaseRequest

	// 每个子合同的发起所需的信息,数量限制2-100
	FlowFileInfos []*FlowFileInfo `json:"FlowFileInfos,omitempty" name:"FlowFileInfos"`

	// 合同组名称,长度不超过200个字符
	FlowGroupName *string `json:"FlowGroupName,omitempty" name:"FlowGroupName"`

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署人校验方式
	// VerifyCheck: 人脸识别(默认)
	// MobileCheck:手机号验证
	// 参数说明:若选择后者,未实名的个人签署方查看合同时,无需进行人脸识别实名认证(但签署合同时仍然需要人脸实名),该能力仅适用于个人签署方。
	ApproverVerifyType *string `json:"ApproverVerifyType,omitempty" name:"ApproverVerifyType"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewChannelCreateFlowGroupByFilesRequest added in v1.0.494

func NewChannelCreateFlowGroupByFilesRequest() (request *ChannelCreateFlowGroupByFilesRequest)

func (*ChannelCreateFlowGroupByFilesRequest) FromJsonString added in v1.0.494

func (r *ChannelCreateFlowGroupByFilesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateFlowGroupByFilesRequest) ToJsonString added in v1.0.494

func (r *ChannelCreateFlowGroupByFilesRequest) ToJsonString() string

type ChannelCreateFlowGroupByFilesRequestParams added in v1.0.494

type ChannelCreateFlowGroupByFilesRequestParams struct {
	// 每个子合同的发起所需的信息,数量限制2-100
	FlowFileInfos []*FlowFileInfo `json:"FlowFileInfos,omitempty" name:"FlowFileInfos"`

	// 合同组名称,长度不超过200个字符
	FlowGroupName *string `json:"FlowGroupName,omitempty" name:"FlowGroupName"`

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署人校验方式
	// VerifyCheck: 人脸识别(默认)
	// MobileCheck:手机号验证
	// 参数说明:若选择后者,未实名的个人签署方查看合同时,无需进行人脸识别实名认证(但签署合同时仍然需要人脸实名),该能力仅适用于个人签署方。
	ApproverVerifyType *string `json:"ApproverVerifyType,omitempty" name:"ApproverVerifyType"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type ChannelCreateFlowGroupByFilesResponse added in v1.0.494

type ChannelCreateFlowGroupByFilesResponse struct {
	*tchttp.BaseResponse
	Response *ChannelCreateFlowGroupByFilesResponseParams `json:"Response"`
}

func NewChannelCreateFlowGroupByFilesResponse added in v1.0.494

func NewChannelCreateFlowGroupByFilesResponse() (response *ChannelCreateFlowGroupByFilesResponse)

func (*ChannelCreateFlowGroupByFilesResponse) FromJsonString added in v1.0.494

func (r *ChannelCreateFlowGroupByFilesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateFlowGroupByFilesResponse) ToJsonString added in v1.0.494

type ChannelCreateFlowGroupByFilesResponseParams added in v1.0.494

type ChannelCreateFlowGroupByFilesResponseParams struct {
	// 合同组ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowGroupId *string `json:"FlowGroupId,omitempty" name:"FlowGroupId"`

	// 子合同ID列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelCreateFlowRemindsRequest added in v1.0.585

type ChannelCreateFlowRemindsRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署流程Id数组,最多100个,超过100不处理
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`
}

func NewChannelCreateFlowRemindsRequest added in v1.0.585

func NewChannelCreateFlowRemindsRequest() (request *ChannelCreateFlowRemindsRequest)

func (*ChannelCreateFlowRemindsRequest) FromJsonString added in v1.0.585

func (r *ChannelCreateFlowRemindsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateFlowRemindsRequest) ToJsonString added in v1.0.585

func (r *ChannelCreateFlowRemindsRequest) ToJsonString() string

type ChannelCreateFlowRemindsRequestParams added in v1.0.585

type ChannelCreateFlowRemindsRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署流程Id数组,最多100个,超过100不处理
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`
}

Predefined struct for user

type ChannelCreateFlowRemindsResponse added in v1.0.585

type ChannelCreateFlowRemindsResponse struct {
	*tchttp.BaseResponse
	Response *ChannelCreateFlowRemindsResponseParams `json:"Response"`
}

func NewChannelCreateFlowRemindsResponse added in v1.0.585

func NewChannelCreateFlowRemindsResponse() (response *ChannelCreateFlowRemindsResponse)

func (*ChannelCreateFlowRemindsResponse) FromJsonString added in v1.0.585

func (r *ChannelCreateFlowRemindsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateFlowRemindsResponse) ToJsonString added in v1.0.585

func (r *ChannelCreateFlowRemindsResponse) ToJsonString() string

type ChannelCreateFlowRemindsResponseParams added in v1.0.585

type ChannelCreateFlowRemindsResponseParams struct {
	// 合同催办详情信息
	RemindFlowRecords []*RemindFlowRecords `json:"RemindFlowRecords,omitempty" name:"RemindFlowRecords"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelCreateFlowSignReviewRequest added in v1.0.472

type ChannelCreateFlowSignReviewRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署流程编号
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 企业内部审核结果
	// PASS: 通过
	// REJECT: 拒绝
	// SIGN_REJECT:拒签(流程结束)
	ReviewType *string `json:"ReviewType,omitempty" name:"ReviewType"`

	// 审核原因
	// 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
	ReviewMessage *string `json:"ReviewMessage,omitempty" name:"ReviewMessage"`

	// 签署节点审核时需要指定
	RecipientId *string `json:"RecipientId,omitempty" name:"RecipientId"`
}

func NewChannelCreateFlowSignReviewRequest added in v1.0.472

func NewChannelCreateFlowSignReviewRequest() (request *ChannelCreateFlowSignReviewRequest)

func (*ChannelCreateFlowSignReviewRequest) FromJsonString added in v1.0.472

func (r *ChannelCreateFlowSignReviewRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateFlowSignReviewRequest) ToJsonString added in v1.0.472

func (r *ChannelCreateFlowSignReviewRequest) ToJsonString() string

type ChannelCreateFlowSignReviewRequestParams added in v1.0.472

type ChannelCreateFlowSignReviewRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署流程编号
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 企业内部审核结果
	// PASS: 通过
	// REJECT: 拒绝
	// SIGN_REJECT:拒签(流程结束)
	ReviewType *string `json:"ReviewType,omitempty" name:"ReviewType"`

	// 审核原因
	// 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
	ReviewMessage *string `json:"ReviewMessage,omitempty" name:"ReviewMessage"`

	// 签署节点审核时需要指定
	RecipientId *string `json:"RecipientId,omitempty" name:"RecipientId"`
}

Predefined struct for user

type ChannelCreateFlowSignReviewResponse added in v1.0.472

type ChannelCreateFlowSignReviewResponse struct {
	*tchttp.BaseResponse
	Response *ChannelCreateFlowSignReviewResponseParams `json:"Response"`
}

func NewChannelCreateFlowSignReviewResponse added in v1.0.472

func NewChannelCreateFlowSignReviewResponse() (response *ChannelCreateFlowSignReviewResponse)

func (*ChannelCreateFlowSignReviewResponse) FromJsonString added in v1.0.472

func (r *ChannelCreateFlowSignReviewResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateFlowSignReviewResponse) ToJsonString added in v1.0.472

func (r *ChannelCreateFlowSignReviewResponse) ToJsonString() string

type ChannelCreateFlowSignReviewResponseParams added in v1.0.472

type ChannelCreateFlowSignReviewResponseParams struct {
	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelCreateFlowSignUrlRequest added in v1.0.580

type ChannelCreateFlowSignUrlRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 流程编号
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 流程签署人,其中Name和Mobile必传,其他可不传,ApproverType目前只支持PERSON类型的签署人,如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
	FlowApproverInfos []*FlowApproverInfo `json:"FlowApproverInfos,omitempty" name:"FlowApproverInfos"`

	// 用户信息,暂未开放
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 机构信息,暂未开放
	Organization *OrganizationInfo `json:"Organization,omitempty" name:"Organization"`
}

func NewChannelCreateFlowSignUrlRequest added in v1.0.580

func NewChannelCreateFlowSignUrlRequest() (request *ChannelCreateFlowSignUrlRequest)

func (*ChannelCreateFlowSignUrlRequest) FromJsonString added in v1.0.580

func (r *ChannelCreateFlowSignUrlRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateFlowSignUrlRequest) ToJsonString added in v1.0.580

func (r *ChannelCreateFlowSignUrlRequest) ToJsonString() string

type ChannelCreateFlowSignUrlRequestParams added in v1.0.580

type ChannelCreateFlowSignUrlRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 流程编号
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 流程签署人,其中Name和Mobile必传,其他可不传,ApproverType目前只支持PERSON类型的签署人,如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
	FlowApproverInfos []*FlowApproverInfo `json:"FlowApproverInfos,omitempty" name:"FlowApproverInfos"`

	// 用户信息,暂未开放
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 机构信息,暂未开放
	Organization *OrganizationInfo `json:"Organization,omitempty" name:"Organization"`
}

Predefined struct for user

type ChannelCreateFlowSignUrlResponse added in v1.0.580

type ChannelCreateFlowSignUrlResponse struct {
	*tchttp.BaseResponse
	Response *ChannelCreateFlowSignUrlResponseParams `json:"Response"`
}

func NewChannelCreateFlowSignUrlResponse added in v1.0.580

func NewChannelCreateFlowSignUrlResponse() (response *ChannelCreateFlowSignUrlResponse)

func (*ChannelCreateFlowSignUrlResponse) FromJsonString added in v1.0.580

func (r *ChannelCreateFlowSignUrlResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateFlowSignUrlResponse) ToJsonString added in v1.0.580

func (r *ChannelCreateFlowSignUrlResponse) ToJsonString() string

type ChannelCreateFlowSignUrlResponseParams added in v1.0.580

type ChannelCreateFlowSignUrlResponseParams struct {
	// 签署人签署链接信息
	FlowApproverUrlInfos []*FlowApproverUrlInfo `json:"FlowApproverUrlInfos,omitempty" name:"FlowApproverUrlInfos"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelCreateMultiFlowSignQRCodeRequest added in v1.0.418

type ChannelCreateMultiFlowSignQRCodeRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。
	// 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 模版ID
	TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`

	// 签署流程名称,最大长度200个字符。
	FlowName *string `json:"FlowName,omitempty" name:"FlowName"`

	// 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
	MaxFlowNum *int64 `json:"MaxFlowNum,omitempty" name:"MaxFlowNum"`

	// 签署流程有效天数 默认7天 最高设置不超过30天
	FlowEffectiveDay *int64 `json:"FlowEffectiveDay,omitempty" name:"FlowEffectiveDay"`

	// 二维码有效天数 默认7天 最高设置不超过90天
	QrEffectiveDay *int64 `json:"QrEffectiveDay,omitempty" name:"QrEffectiveDay"`

	// 限制二维码用户条件
	Restrictions []*ApproverRestriction `json:"Restrictions,omitempty" name:"Restrictions"`

	// 回调地址,最大长度1000个字符
	// 不传默认使用渠道应用号配置的回调地址
	// 回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
	CallbackUrl *string `json:"CallbackUrl,omitempty" name:"CallbackUrl"`

	// 用户信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 限制二维码用户条件(已弃用)
	ApproverRestrictions *ApproverRestriction `json:"ApproverRestrictions,omitempty" name:"ApproverRestrictions"`
}

func NewChannelCreateMultiFlowSignQRCodeRequest added in v1.0.418

func NewChannelCreateMultiFlowSignQRCodeRequest() (request *ChannelCreateMultiFlowSignQRCodeRequest)

func (*ChannelCreateMultiFlowSignQRCodeRequest) FromJsonString added in v1.0.418

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateMultiFlowSignQRCodeRequest) ToJsonString added in v1.0.418

type ChannelCreateMultiFlowSignQRCodeRequestParams added in v1.0.426

type ChannelCreateMultiFlowSignQRCodeRequestParams struct {
	// 渠道应用相关信息。
	// 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 模版ID
	TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`

	// 签署流程名称,最大长度200个字符。
	FlowName *string `json:"FlowName,omitempty" name:"FlowName"`

	// 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
	MaxFlowNum *int64 `json:"MaxFlowNum,omitempty" name:"MaxFlowNum"`

	// 签署流程有效天数 默认7天 最高设置不超过30天
	FlowEffectiveDay *int64 `json:"FlowEffectiveDay,omitempty" name:"FlowEffectiveDay"`

	// 二维码有效天数 默认7天 最高设置不超过90天
	QrEffectiveDay *int64 `json:"QrEffectiveDay,omitempty" name:"QrEffectiveDay"`

	// 限制二维码用户条件
	Restrictions []*ApproverRestriction `json:"Restrictions,omitempty" name:"Restrictions"`

	// 回调地址,最大长度1000个字符
	// 不传默认使用渠道应用号配置的回调地址
	// 回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
	CallbackUrl *string `json:"CallbackUrl,omitempty" name:"CallbackUrl"`

	// 用户信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 限制二维码用户条件(已弃用)
	ApproverRestrictions *ApproverRestriction `json:"ApproverRestrictions,omitempty" name:"ApproverRestrictions"`
}

Predefined struct for user

type ChannelCreateMultiFlowSignQRCodeResponse added in v1.0.418

type ChannelCreateMultiFlowSignQRCodeResponse struct {
	*tchttp.BaseResponse
	Response *ChannelCreateMultiFlowSignQRCodeResponseParams `json:"Response"`
}

func NewChannelCreateMultiFlowSignQRCodeResponse added in v1.0.418

func NewChannelCreateMultiFlowSignQRCodeResponse() (response *ChannelCreateMultiFlowSignQRCodeResponse)

func (*ChannelCreateMultiFlowSignQRCodeResponse) FromJsonString added in v1.0.418

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateMultiFlowSignQRCodeResponse) ToJsonString added in v1.0.418

type ChannelCreateMultiFlowSignQRCodeResponseParams added in v1.0.426

type ChannelCreateMultiFlowSignQRCodeResponseParams struct {
	// 签署二维码对象
	QrCode *SignQrCode `json:"QrCode,omitempty" name:"QrCode"`

	// 签署链接对象
	SignUrls *SignUrl `json:"SignUrls,omitempty" name:"SignUrls"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelCreateReleaseFlowRequest added in v1.0.547

type ChannelCreateReleaseFlowRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 待解除的流程编号(即原流程的编号)
	NeedRelievedFlowId *string `json:"NeedRelievedFlowId,omitempty" name:"NeedRelievedFlowId"`

	// 解除协议内容
	ReliveInfo *RelieveInfo `json:"ReliveInfo,omitempty" name:"ReliveInfo"`

	// 非必须,解除协议的本企业签署人列表,默认使用原流程的签署人列表;当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业的其他签署人来替换原流程中的原签署人,注意需要指明ApproverNumber来代表需要替换哪一个签署人,解除协议的签署人数量不能多于原流程的签署人数量
	ReleasedApprovers []*ReleasedApprover `json:"ReleasedApprovers,omitempty" name:"ReleasedApprovers"`

	// 签署完回调url,最大长度1000个字符
	CallbackUrl *string `json:"CallbackUrl,omitempty" name:"CallbackUrl"`

	// 机构信息
	Organization *OrganizationInfo `json:"Organization,omitempty" name:"Organization"`

	// 用户信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewChannelCreateReleaseFlowRequest added in v1.0.547

func NewChannelCreateReleaseFlowRequest() (request *ChannelCreateReleaseFlowRequest)

func (*ChannelCreateReleaseFlowRequest) FromJsonString added in v1.0.547

func (r *ChannelCreateReleaseFlowRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateReleaseFlowRequest) ToJsonString added in v1.0.547

func (r *ChannelCreateReleaseFlowRequest) ToJsonString() string

type ChannelCreateReleaseFlowRequestParams added in v1.0.547

type ChannelCreateReleaseFlowRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 待解除的流程编号(即原流程的编号)
	NeedRelievedFlowId *string `json:"NeedRelievedFlowId,omitempty" name:"NeedRelievedFlowId"`

	// 解除协议内容
	ReliveInfo *RelieveInfo `json:"ReliveInfo,omitempty" name:"ReliveInfo"`

	// 非必须,解除协议的本企业签署人列表,默认使用原流程的签署人列表;当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业的其他签署人来替换原流程中的原签署人,注意需要指明ApproverNumber来代表需要替换哪一个签署人,解除协议的签署人数量不能多于原流程的签署人数量
	ReleasedApprovers []*ReleasedApprover `json:"ReleasedApprovers,omitempty" name:"ReleasedApprovers"`

	// 签署完回调url,最大长度1000个字符
	CallbackUrl *string `json:"CallbackUrl,omitempty" name:"CallbackUrl"`

	// 机构信息
	Organization *OrganizationInfo `json:"Organization,omitempty" name:"Organization"`

	// 用户信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type ChannelCreateReleaseFlowResponse added in v1.0.547

type ChannelCreateReleaseFlowResponse struct {
	*tchttp.BaseResponse
	Response *ChannelCreateReleaseFlowResponseParams `json:"Response"`
}

func NewChannelCreateReleaseFlowResponse added in v1.0.547

func NewChannelCreateReleaseFlowResponse() (response *ChannelCreateReleaseFlowResponse)

func (*ChannelCreateReleaseFlowResponse) FromJsonString added in v1.0.547

func (r *ChannelCreateReleaseFlowResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelCreateReleaseFlowResponse) ToJsonString added in v1.0.547

func (r *ChannelCreateReleaseFlowResponse) ToJsonString() string

type ChannelCreateReleaseFlowResponseParams added in v1.0.547

type ChannelCreateReleaseFlowResponseParams struct {
	// 解除协议流程编号
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelDescribeEmployeesRequest added in v1.0.508

type ChannelDescribeEmployeesRequest struct {
	*tchttp.BaseRequest

	// 返回最大数量,最大为20
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 查询过滤实名用户,Key为Status,Values为["IsVerified"]
	// 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
	// 查询离职员工时,Key为Status,Values为["QuiteJob"]
	Filters []*Filter `json:"Filters,omitempty" name:"Filters"`

	// 偏移量,默认为0,最大为20000
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewChannelDescribeEmployeesRequest added in v1.0.508

func NewChannelDescribeEmployeesRequest() (request *ChannelDescribeEmployeesRequest)

func (*ChannelDescribeEmployeesRequest) FromJsonString added in v1.0.508

func (r *ChannelDescribeEmployeesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelDescribeEmployeesRequest) ToJsonString added in v1.0.508

func (r *ChannelDescribeEmployeesRequest) ToJsonString() string

type ChannelDescribeEmployeesRequestParams added in v1.0.508

type ChannelDescribeEmployeesRequestParams struct {
	// 返回最大数量,最大为20
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 查询过滤实名用户,Key为Status,Values为["IsVerified"]
	// 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
	// 查询离职员工时,Key为Status,Values为["QuiteJob"]
	Filters []*Filter `json:"Filters,omitempty" name:"Filters"`

	// 偏移量,默认为0,最大为20000
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type ChannelDescribeEmployeesResponse added in v1.0.508

type ChannelDescribeEmployeesResponse struct {
	*tchttp.BaseResponse
	Response *ChannelDescribeEmployeesResponseParams `json:"Response"`
}

func NewChannelDescribeEmployeesResponse added in v1.0.508

func NewChannelDescribeEmployeesResponse() (response *ChannelDescribeEmployeesResponse)

func (*ChannelDescribeEmployeesResponse) FromJsonString added in v1.0.508

func (r *ChannelDescribeEmployeesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelDescribeEmployeesResponse) ToJsonString added in v1.0.508

func (r *ChannelDescribeEmployeesResponse) ToJsonString() string

type ChannelDescribeEmployeesResponseParams added in v1.0.508

type ChannelDescribeEmployeesResponseParams struct {
	// 员工数据列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	Employees []*Staff `json:"Employees,omitempty" name:"Employees"`

	// 偏移量,默认为0,最大为20000
	// 注意:此字段可能返回 null,表示取不到有效值。
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 返回最大数量,最大为20
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 符合条件的员工数量
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelDescribeOrganizationSealsRequest added in v1.0.532

type ChannelDescribeOrganizationSealsRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 返回最大数量,最大为100
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 偏移量,默认为0,最大为20000
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 查询信息类型,为1时返回授权用户,为其他值时不返回
	InfoType *int64 `json:"InfoType,omitempty" name:"InfoType"`

	// 印章id(没有输入返回所有)
	SealId *string `json:"SealId,omitempty" name:"SealId"`
}

func NewChannelDescribeOrganizationSealsRequest added in v1.0.532

func NewChannelDescribeOrganizationSealsRequest() (request *ChannelDescribeOrganizationSealsRequest)

func (*ChannelDescribeOrganizationSealsRequest) FromJsonString added in v1.0.532

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelDescribeOrganizationSealsRequest) ToJsonString added in v1.0.532

type ChannelDescribeOrganizationSealsRequestParams added in v1.0.532

type ChannelDescribeOrganizationSealsRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 返回最大数量,最大为100
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 偏移量,默认为0,最大为20000
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 查询信息类型,为1时返回授权用户,为其他值时不返回
	InfoType *int64 `json:"InfoType,omitempty" name:"InfoType"`

	// 印章id(没有输入返回所有)
	SealId *string `json:"SealId,omitempty" name:"SealId"`
}

Predefined struct for user

type ChannelDescribeOrganizationSealsResponse added in v1.0.532

type ChannelDescribeOrganizationSealsResponse struct {
	*tchttp.BaseResponse
	Response *ChannelDescribeOrganizationSealsResponseParams `json:"Response"`
}

func NewChannelDescribeOrganizationSealsResponse added in v1.0.532

func NewChannelDescribeOrganizationSealsResponse() (response *ChannelDescribeOrganizationSealsResponse)

func (*ChannelDescribeOrganizationSealsResponse) FromJsonString added in v1.0.532

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelDescribeOrganizationSealsResponse) ToJsonString added in v1.0.532

type ChannelDescribeOrganizationSealsResponseParams added in v1.0.532

type ChannelDescribeOrganizationSealsResponseParams struct {
	// 在设置了SealId时返回0或1,没有设置时返回公司的总印章数量,可能比返回的印章数组数量多
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// 查询到的印章结果数组
	Seals []*OccupiedSeal `json:"Seals,omitempty" name:"Seals"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelGetTaskResultApiRequest added in v1.0.467

type ChannelGetTaskResultApiRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 任务Id,通过ChannelCreateConvertTaskApi接口获得
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 暂未开放
	Organization *OrganizationInfo `json:"Organization,omitempty" name:"Organization"`
}

func NewChannelGetTaskResultApiRequest added in v1.0.467

func NewChannelGetTaskResultApiRequest() (request *ChannelGetTaskResultApiRequest)

func (*ChannelGetTaskResultApiRequest) FromJsonString added in v1.0.467

func (r *ChannelGetTaskResultApiRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelGetTaskResultApiRequest) ToJsonString added in v1.0.467

func (r *ChannelGetTaskResultApiRequest) ToJsonString() string

type ChannelGetTaskResultApiRequestParams added in v1.0.467

type ChannelGetTaskResultApiRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 任务Id,通过ChannelCreateConvertTaskApi接口获得
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 暂未开放
	Organization *OrganizationInfo `json:"Organization,omitempty" name:"Organization"`
}

Predefined struct for user

type ChannelGetTaskResultApiResponse added in v1.0.467

type ChannelGetTaskResultApiResponse struct {
	*tchttp.BaseResponse
	Response *ChannelGetTaskResultApiResponseParams `json:"Response"`
}

func NewChannelGetTaskResultApiResponse added in v1.0.467

func NewChannelGetTaskResultApiResponse() (response *ChannelGetTaskResultApiResponse)

func (*ChannelGetTaskResultApiResponse) FromJsonString added in v1.0.467

func (r *ChannelGetTaskResultApiResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelGetTaskResultApiResponse) ToJsonString added in v1.0.467

func (r *ChannelGetTaskResultApiResponse) ToJsonString() string

type ChannelGetTaskResultApiResponseParams added in v1.0.467

type ChannelGetTaskResultApiResponseParams struct {
	// 任务Id
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// 任务状态,需要关注的状态
	// 0  :NeedTranform   - 任务已提交
	// 4  :Processing     - 文档转换中
	// 8  :TaskEnd        - 任务处理完成
	// -2 :DownloadFailed - 下载失败
	// -6 :ProcessFailed  - 转换失败
	// -13:ProcessTimeout - 转换文件超时
	TaskStatus *int64 `json:"TaskStatus,omitempty" name:"TaskStatus"`

	// 状态描述,需要关注的状态
	// NeedTranform   - 任务已提交
	// Processing     - 文档转换中
	// TaskEnd        - 任务处理完成
	// DownloadFailed - 下载失败
	// ProcessFailed  - 转换失败
	// ProcessTimeout - 转换文件超时
	TaskMessage *string `json:"TaskMessage,omitempty" name:"TaskMessage"`

	// 资源Id,也是FileId,用于文件发起使用
	ResourceId *string `json:"ResourceId,omitempty" name:"ResourceId"`

	// 预览文件Url,有效期30分钟
	// 注意:此字段可能返回 null,表示取不到有效值。
	PreviewUrl *string `json:"PreviewUrl,omitempty" name:"PreviewUrl"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ChannelVerifyPdfRequest added in v1.0.501

type ChannelVerifyPdfRequest struct {
	*tchttp.BaseRequest

	// 合同Id,流程Id
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewChannelVerifyPdfRequest added in v1.0.501

func NewChannelVerifyPdfRequest() (request *ChannelVerifyPdfRequest)

func (*ChannelVerifyPdfRequest) FromJsonString added in v1.0.501

func (r *ChannelVerifyPdfRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelVerifyPdfRequest) ToJsonString added in v1.0.501

func (r *ChannelVerifyPdfRequest) ToJsonString() string

type ChannelVerifyPdfRequestParams added in v1.0.501

type ChannelVerifyPdfRequestParams struct {
	// 合同Id,流程Id
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type ChannelVerifyPdfResponse added in v1.0.501

type ChannelVerifyPdfResponse struct {
	*tchttp.BaseResponse
	Response *ChannelVerifyPdfResponseParams `json:"Response"`
}

func NewChannelVerifyPdfResponse added in v1.0.501

func NewChannelVerifyPdfResponse() (response *ChannelVerifyPdfResponse)

func (*ChannelVerifyPdfResponse) FromJsonString added in v1.0.501

func (r *ChannelVerifyPdfResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ChannelVerifyPdfResponse) ToJsonString added in v1.0.501

func (r *ChannelVerifyPdfResponse) ToJsonString() string

type ChannelVerifyPdfResponseParams added in v1.0.501

type ChannelVerifyPdfResponseParams struct {
	// 验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
	VerifyResult *int64 `json:"VerifyResult,omitempty" name:"VerifyResult"`

	// 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域
	// ;5-文件签名格式错误
	PdfVerifyResults []*PdfVerifyResult `json:"PdfVerifyResults,omitempty" name:"PdfVerifyResults"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) ChannelBatchCancelFlows added in v1.0.494

func (c *Client) ChannelBatchCancelFlows(request *ChannelBatchCancelFlowsRequest) (response *ChannelBatchCancelFlowsResponse, err error)

ChannelBatchCancelFlows 指定需要批量撤销的签署流程Id,批量撤销合同

客户指定需要撤销的签署流程Id,最多100个,超过100不处理;接口失败后返回错误信息

注意:

能撤回合同的只能是合同的发起人或者发起企业的超管、法人

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER_DUPTASK = "InvalidParameter.DupTask"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_FLOWHASTERMINATED = "OperationDenied.FlowHasTerminated"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelBatchCancelFlowsWithContext added in v1.0.494

func (c *Client) ChannelBatchCancelFlowsWithContext(ctx context.Context, request *ChannelBatchCancelFlowsRequest) (response *ChannelBatchCancelFlowsResponse, err error)

ChannelBatchCancelFlows 指定需要批量撤销的签署流程Id,批量撤销合同

客户指定需要撤销的签署流程Id,最多100个,超过100不处理;接口失败后返回错误信息

注意:

能撤回合同的只能是合同的发起人或者发起企业的超管、法人

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER_DUPTASK = "InvalidParameter.DupTask"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_FLOWHASTERMINATED = "OperationDenied.FlowHasTerminated"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCancelFlow added in v1.0.521

func (c *Client) ChannelCancelFlow(request *ChannelCancelFlowRequest) (response *ChannelCancelFlowResponse, err error)

ChannelCancelFlow 渠道版撤销签署流程接口,可以撤回:未全部签署完成;不可以撤回(终态):已全部签署完成、已拒签、已过期、已撤回。

注意:

能撤回合同的只能是合同的发起人或者发起企业的超管、法人

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CANCELREASON = "InvalidParameter.CancelReason"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETER_STATUS = "InvalidParameter.Status"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_FLOWHASTERMINATED = "OperationDenied.FlowHasTerminated"
OPERATIONDENIED_FORBID = "OperationDenied.Forbid"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ChannelCancelFlowWithContext added in v1.0.521

func (c *Client) ChannelCancelFlowWithContext(ctx context.Context, request *ChannelCancelFlowRequest) (response *ChannelCancelFlowResponse, err error)

ChannelCancelFlow 渠道版撤销签署流程接口,可以撤回:未全部签署完成;不可以撤回(终态):已全部签署完成、已拒签、已过期、已撤回。

注意:

能撤回合同的只能是合同的发起人或者发起企业的超管、法人

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CANCELREASON = "InvalidParameter.CancelReason"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETER_STATUS = "InvalidParameter.Status"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_FLOWHASTERMINATED = "OperationDenied.FlowHasTerminated"
OPERATIONDENIED_FORBID = "OperationDenied.Forbid"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ChannelCancelMultiFlowSignQRCode added in v1.0.418

func (c *Client) ChannelCancelMultiFlowSignQRCode(request *ChannelCancelMultiFlowSignQRCodeRequest) (response *ChannelCancelMultiFlowSignQRCodeResponse, err error)

ChannelCancelMultiFlowSignQRCode 此接口(ChannelCancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_DBREAD = "InternalError.DbRead"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED_FORBID = "OperationDenied.Forbid"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCancelMultiFlowSignQRCodeWithContext added in v1.0.418

func (c *Client) ChannelCancelMultiFlowSignQRCodeWithContext(ctx context.Context, request *ChannelCancelMultiFlowSignQRCodeRequest) (response *ChannelCancelMultiFlowSignQRCodeResponse, err error)

ChannelCancelMultiFlowSignQRCode 此接口(ChannelCancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_DBREAD = "InternalError.DbRead"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED_FORBID = "OperationDenied.Forbid"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateBatchCancelFlowUrl added in v1.0.458

func (c *Client) ChannelCreateBatchCancelFlowUrl(request *ChannelCreateBatchCancelFlowUrlRequest) (response *ChannelCreateBatchCancelFlowUrlResponse, err error)

ChannelCreateBatchCancelFlowUrl 指定需要批量撤销的签署流程Id,获取批量撤销链接 - 不建议使用此接口,可使用ChannelBatchCancelFlows

客户指定需要撤销的签署流程Id,最多100个,超过100不处理;

接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销;

可以撤回:未全部签署完成;不可以撤回(终态):已全部签署完成、已拒签、已过期、已撤回。

注意:

能撤回合同的只能是合同的发起人或者发起企业的超管、法人

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateBatchCancelFlowUrlWithContext added in v1.0.458

func (c *Client) ChannelCreateBatchCancelFlowUrlWithContext(ctx context.Context, request *ChannelCreateBatchCancelFlowUrlRequest) (response *ChannelCreateBatchCancelFlowUrlResponse, err error)

ChannelCreateBatchCancelFlowUrl 指定需要批量撤销的签署流程Id,获取批量撤销链接 - 不建议使用此接口,可使用ChannelBatchCancelFlows

客户指定需要撤销的签署流程Id,最多100个,超过100不处理;

接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销;

可以撤回:未全部签署完成;不可以撤回(终态):已全部签署完成、已拒签、已过期、已撤回。

注意:

能撤回合同的只能是合同的发起人或者发起企业的超管、法人

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateBoundFlows added in v1.0.541

func (c *Client) ChannelCreateBoundFlows(request *ChannelCreateBoundFlowsRequest) (response *ChannelCreateBoundFlowsResponse, err error)

ChannelCreateBoundFlows 此接口(ChannelCreateBoundFlows)用于渠道子客领取合同,经办人需要有相应的角色,领取后的合同不能重复领取。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_HASAUTHORIZED = "FailedOperation.HasAuthorized"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_DBINSERT = "InternalError.DbInsert"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BUSINESSLICENSE = "InvalidParameter.BusinessLicense"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_FILETYPE = "InvalidParameter.FileType"
INVALIDPARAMETER_MENUSTATUS = "InvalidParameter.MenuStatus"
INVALIDPARAMETER_OPENID = "InvalidParameter.OpenId"
INVALIDPARAMETER_ORGANIZATIONID = "InvalidParameter.OrganizationId"
INVALIDPARAMETER_ORGANIZATIONNAME = "InvalidParameter.OrganizationName"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
LIMITEXCEEDED_FILESIZE = "LimitExceeded.FileSize"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_COMPANYACTIVEINFO = "MissingParameter.CompanyActiveInfo"
MISSINGPARAMETER_ORGOPENID = "MissingParameter.OrgOpenId"
MISSINGPARAMETER_PROXYOPERATOROPENID = "MissingParameter.ProxyOperatorOpenId"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BANNEDAPPLICATION = "OperationDenied.BannedApplication"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_APPLICATIONID = "ResourceNotFound.ApplicationId"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ChannelCreateBoundFlowsWithContext added in v1.0.541

func (c *Client) ChannelCreateBoundFlowsWithContext(ctx context.Context, request *ChannelCreateBoundFlowsRequest) (response *ChannelCreateBoundFlowsResponse, err error)

ChannelCreateBoundFlows 此接口(ChannelCreateBoundFlows)用于渠道子客领取合同,经办人需要有相应的角色,领取后的合同不能重复领取。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_HASAUTHORIZED = "FailedOperation.HasAuthorized"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_DBINSERT = "InternalError.DbInsert"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BUSINESSLICENSE = "InvalidParameter.BusinessLicense"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_FILETYPE = "InvalidParameter.FileType"
INVALIDPARAMETER_MENUSTATUS = "InvalidParameter.MenuStatus"
INVALIDPARAMETER_OPENID = "InvalidParameter.OpenId"
INVALIDPARAMETER_ORGANIZATIONID = "InvalidParameter.OrganizationId"
INVALIDPARAMETER_ORGANIZATIONNAME = "InvalidParameter.OrganizationName"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
LIMITEXCEEDED_FILESIZE = "LimitExceeded.FileSize"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_COMPANYACTIVEINFO = "MissingParameter.CompanyActiveInfo"
MISSINGPARAMETER_ORGOPENID = "MissingParameter.OrgOpenId"
MISSINGPARAMETER_PROXYOPERATOROPENID = "MissingParameter.ProxyOperatorOpenId"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BANNEDAPPLICATION = "OperationDenied.BannedApplication"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_APPLICATIONID = "ResourceNotFound.ApplicationId"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ChannelCreateConvertTaskApi added in v1.0.467

func (c *Client) ChannelCreateConvertTaskApi(request *ChannelCreateConvertTaskApiRequest) (response *ChannelCreateConvertTaskApiResponse, err error)

ChannelCreateConvertTaskApi 渠道创建文件转换任务

可能返回的错误码:

INTERNALERROR_DEPENDSAPI = "InternalError.DependsApi"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateConvertTaskApiWithContext added in v1.0.467

func (c *Client) ChannelCreateConvertTaskApiWithContext(ctx context.Context, request *ChannelCreateConvertTaskApiRequest) (response *ChannelCreateConvertTaskApiResponse, err error)

ChannelCreateConvertTaskApi 渠道创建文件转换任务

可能返回的错误码:

INTERNALERROR_DEPENDSAPI = "InternalError.DependsApi"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateFlowByFiles added in v1.0.390

func (c *Client) ChannelCreateFlowByFiles(request *ChannelCreateFlowByFilesRequest) (response *ChannelCreateFlowByFilesResponse, err error)

ChannelCreateFlowByFiles 接口(ChannelCreateFlowByFiles)用于渠道版通过文件创建签署流程。此接口静默签能力不可直接使用,需要运营申请

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_AGENOTACHIEVENORMALLEGAL = "FailedOperation.AgeNotAchieveNormalLegal"
INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_DBCONNECTION = "InternalError.DbConnection"
INTERNALERROR_DECRYPTION = "InternalError.Decryption"
INTERNALERROR_ENCRYPTION = "InternalError.Encryption"
INTERNALERROR_GENERATEID = "InternalError.GenerateId"
INTERNALERROR_PDF = "InternalError.Pdf"
INTERNALERROR_SYSTEM = "InternalError.System"
INTERNALERROR_THIRDPARTY = "InternalError.ThirdParty"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_APPROVERTYPE = "InvalidParameter.ApproverType"
INVALIDPARAMETER_BIZAPPROVERALREADYEXISTS = "InvalidParameter.BizApproverAlreadyExists"
INVALIDPARAMETER_CARDTYPE = "InvalidParameter.CardType"
INVALIDPARAMETER_COMPONENTVALUE = "InvalidParameter.ComponentValue"
INVALIDPARAMETER_CUSTOMSHOWMAP = "InvalidParameter.CustomShowMap"
INVALIDPARAMETER_CUSTOMERDATA = "InvalidParameter.CustomerData"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_FLOWAPPROVERINFOS = "InvalidParameter.FlowApproverInfos"
INVALIDPARAMETER_FLOWAPPROVERS = "InvalidParameter.FlowApprovers"
INVALIDPARAMETER_FLOWCALLBACKURL = "InvalidParameter.FlowCallbackUrl"
INVALIDPARAMETER_FLOWDEADLINE = "InvalidParameter.FlowDeadLine"
INVALIDPARAMETER_FLOWDESCRIPTION = "InvalidParameter.FlowDescription"
INVALIDPARAMETER_FLOWFILEIDS = "InvalidParameter.FlowFileIds"
INVALIDPARAMETER_FLOWNAME = "InvalidParameter.FlowName"
INVALIDPARAMETER_FLOWTYPE = "InvalidParameter.FlowType"
INVALIDPARAMETER_NAME = "InvalidParameter.Name"
INVALIDPARAMETER_NONSUPPORTMOBILE = "InvalidParameter.NonsupportMobile"
INVALIDPARAMETER_ORGANIZATIONNAME = "InvalidParameter.OrganizationName"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETER_SIGNCOMPONENTTYPE = "InvalidParameter.SignComponentType"
INVALIDPARAMETER_UNORDERED = "InvalidParameter.Unordered"
INVALIDPARAMETER_UNSUPPORTEDCOMPONENTTYPE = "InvalidParameter.UnsupportedComponentType"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_MISSCOMPONENTNAME = "MissingParameter.MissComponentName"
MISSINGPARAMETER_SEALID = "MissingParameter.SealId"
MISSINGPARAMETER_SIGNCOMPONENTS = "MissingParameter.SignComponents"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BYFILESSERVERSIGNFORBID = "OperationDenied.ByFilesServerSignForbid"
OPERATIONDENIED_ERRNORESOURCEACCESS = "OperationDenied.ErrNoResourceAccess"
OPERATIONDENIED_INVALIDAPPROVERAGE = "OperationDenied.InvalidApproverAge"
OPERATIONDENIED_NOIDENTITYVERIFY = "OperationDenied.NoIdentityVerify"
OPERATIONDENIED_NOQUOTA = "OperationDenied.NoQuota"
OPERATIONDENIED_OVERSEAABILITYNOTOPEN = "OperationDenied.OverseaAbilityNotOpen"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_RESOURCE = "ResourceNotFound.Resource"
RESOURCENOTFOUND_SEAL = "ResourceNotFound.Seal"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateFlowByFilesWithContext added in v1.0.390

func (c *Client) ChannelCreateFlowByFilesWithContext(ctx context.Context, request *ChannelCreateFlowByFilesRequest) (response *ChannelCreateFlowByFilesResponse, err error)

ChannelCreateFlowByFiles 接口(ChannelCreateFlowByFiles)用于渠道版通过文件创建签署流程。此接口静默签能力不可直接使用,需要运营申请

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_AGENOTACHIEVENORMALLEGAL = "FailedOperation.AgeNotAchieveNormalLegal"
INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_DBCONNECTION = "InternalError.DbConnection"
INTERNALERROR_DECRYPTION = "InternalError.Decryption"
INTERNALERROR_ENCRYPTION = "InternalError.Encryption"
INTERNALERROR_GENERATEID = "InternalError.GenerateId"
INTERNALERROR_PDF = "InternalError.Pdf"
INTERNALERROR_SYSTEM = "InternalError.System"
INTERNALERROR_THIRDPARTY = "InternalError.ThirdParty"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_APPROVERTYPE = "InvalidParameter.ApproverType"
INVALIDPARAMETER_BIZAPPROVERALREADYEXISTS = "InvalidParameter.BizApproverAlreadyExists"
INVALIDPARAMETER_CARDTYPE = "InvalidParameter.CardType"
INVALIDPARAMETER_COMPONENTVALUE = "InvalidParameter.ComponentValue"
INVALIDPARAMETER_CUSTOMSHOWMAP = "InvalidParameter.CustomShowMap"
INVALIDPARAMETER_CUSTOMERDATA = "InvalidParameter.CustomerData"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_FLOWAPPROVERINFOS = "InvalidParameter.FlowApproverInfos"
INVALIDPARAMETER_FLOWAPPROVERS = "InvalidParameter.FlowApprovers"
INVALIDPARAMETER_FLOWCALLBACKURL = "InvalidParameter.FlowCallbackUrl"
INVALIDPARAMETER_FLOWDEADLINE = "InvalidParameter.FlowDeadLine"
INVALIDPARAMETER_FLOWDESCRIPTION = "InvalidParameter.FlowDescription"
INVALIDPARAMETER_FLOWFILEIDS = "InvalidParameter.FlowFileIds"
INVALIDPARAMETER_FLOWNAME = "InvalidParameter.FlowName"
INVALIDPARAMETER_FLOWTYPE = "InvalidParameter.FlowType"
INVALIDPARAMETER_NAME = "InvalidParameter.Name"
INVALIDPARAMETER_NONSUPPORTMOBILE = "InvalidParameter.NonsupportMobile"
INVALIDPARAMETER_ORGANIZATIONNAME = "InvalidParameter.OrganizationName"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETER_SIGNCOMPONENTTYPE = "InvalidParameter.SignComponentType"
INVALIDPARAMETER_UNORDERED = "InvalidParameter.Unordered"
INVALIDPARAMETER_UNSUPPORTEDCOMPONENTTYPE = "InvalidParameter.UnsupportedComponentType"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_MISSCOMPONENTNAME = "MissingParameter.MissComponentName"
MISSINGPARAMETER_SEALID = "MissingParameter.SealId"
MISSINGPARAMETER_SIGNCOMPONENTS = "MissingParameter.SignComponents"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BYFILESSERVERSIGNFORBID = "OperationDenied.ByFilesServerSignForbid"
OPERATIONDENIED_ERRNORESOURCEACCESS = "OperationDenied.ErrNoResourceAccess"
OPERATIONDENIED_INVALIDAPPROVERAGE = "OperationDenied.InvalidApproverAge"
OPERATIONDENIED_NOIDENTITYVERIFY = "OperationDenied.NoIdentityVerify"
OPERATIONDENIED_NOQUOTA = "OperationDenied.NoQuota"
OPERATIONDENIED_OVERSEAABILITYNOTOPEN = "OperationDenied.OverseaAbilityNotOpen"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_RESOURCE = "ResourceNotFound.Resource"
RESOURCENOTFOUND_SEAL = "ResourceNotFound.Seal"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateFlowGroupByFiles added in v1.0.494

func (c *Client) ChannelCreateFlowGroupByFiles(request *ChannelCreateFlowGroupByFilesRequest) (response *ChannelCreateFlowGroupByFilesResponse, err error)

ChannelCreateFlowGroupByFiles 接口(ChannelCreateFlowGroupByFiles)用于通过多文件创建合同组签署流程。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_AGENOTACHIEVENORMALLEGAL = "FailedOperation.AgeNotAchieveNormalLegal"
INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_DBCONNECTION = "InternalError.DbConnection"
INTERNALERROR_DECRYPTION = "InternalError.Decryption"
INTERNALERROR_ENCRYPTION = "InternalError.Encryption"
INTERNALERROR_GENERATEID = "InternalError.GenerateId"
INTERNALERROR_SYSTEM = "InternalError.System"
INTERNALERROR_THIRDPARTY = "InternalError.ThirdParty"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_APPROVERTYPE = "InvalidParameter.ApproverType"
INVALIDPARAMETER_BIZAPPROVERALREADYEXISTS = "InvalidParameter.BizApproverAlreadyExists"
INVALIDPARAMETER_CARDTYPE = "InvalidParameter.CardType"
INVALIDPARAMETER_CUSTOMSHOWMAP = "InvalidParameter.CustomShowMap"
INVALIDPARAMETER_CUSTOMERDATA = "InvalidParameter.CustomerData"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_FLOWAPPROVERINFOS = "InvalidParameter.FlowApproverInfos"
INVALIDPARAMETER_FLOWAPPROVERS = "InvalidParameter.FlowApprovers"
INVALIDPARAMETER_FLOWCALLBACKURL = "InvalidParameter.FlowCallbackUrl"
INVALIDPARAMETER_FLOWDEADLINE = "InvalidParameter.FlowDeadLine"
INVALIDPARAMETER_FLOWDESCRIPTION = "InvalidParameter.FlowDescription"
INVALIDPARAMETER_FLOWFILEIDS = "InvalidParameter.FlowFileIds"
INVALIDPARAMETER_FLOWNAME = "InvalidParameter.FlowName"
INVALIDPARAMETER_FLOWTYPE = "InvalidParameter.FlowType"
INVALIDPARAMETER_NONSUPPORTMOBILE = "InvalidParameter.NonsupportMobile"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETER_SIGNCOMPONENTTYPE = "InvalidParameter.SignComponentType"
INVALIDPARAMETER_UNORDERED = "InvalidParameter.Unordered"
INVALIDPARAMETER_UNSUPPORTEDCOMPONENTTYPE = "InvalidParameter.UnsupportedComponentType"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_MISSCOMPONENTNAME = "MissingParameter.MissComponentName"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BYFILESSERVERSIGNFORBID = "OperationDenied.ByFilesServerSignForbid"
OPERATIONDENIED_ERRNORESOURCEACCESS = "OperationDenied.ErrNoResourceAccess"
OPERATIONDENIED_NOIDENTITYVERIFY = "OperationDenied.NoIdentityVerify"
OPERATIONDENIED_NOQUOTA = "OperationDenied.NoQuota"
OPERATIONDENIED_OVERSEAABILITYNOTOPEN = "OperationDenied.OverseaAbilityNotOpen"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_RESOURCE = "ResourceNotFound.Resource"
RESOURCENOTFOUND_SEAL = "ResourceNotFound.Seal"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateFlowGroupByFilesWithContext added in v1.0.494

func (c *Client) ChannelCreateFlowGroupByFilesWithContext(ctx context.Context, request *ChannelCreateFlowGroupByFilesRequest) (response *ChannelCreateFlowGroupByFilesResponse, err error)

ChannelCreateFlowGroupByFiles 接口(ChannelCreateFlowGroupByFiles)用于通过多文件创建合同组签署流程。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_AGENOTACHIEVENORMALLEGAL = "FailedOperation.AgeNotAchieveNormalLegal"
INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_DBCONNECTION = "InternalError.DbConnection"
INTERNALERROR_DECRYPTION = "InternalError.Decryption"
INTERNALERROR_ENCRYPTION = "InternalError.Encryption"
INTERNALERROR_GENERATEID = "InternalError.GenerateId"
INTERNALERROR_SYSTEM = "InternalError.System"
INTERNALERROR_THIRDPARTY = "InternalError.ThirdParty"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_APPROVERTYPE = "InvalidParameter.ApproverType"
INVALIDPARAMETER_BIZAPPROVERALREADYEXISTS = "InvalidParameter.BizApproverAlreadyExists"
INVALIDPARAMETER_CARDTYPE = "InvalidParameter.CardType"
INVALIDPARAMETER_CUSTOMSHOWMAP = "InvalidParameter.CustomShowMap"
INVALIDPARAMETER_CUSTOMERDATA = "InvalidParameter.CustomerData"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_FLOWAPPROVERINFOS = "InvalidParameter.FlowApproverInfos"
INVALIDPARAMETER_FLOWAPPROVERS = "InvalidParameter.FlowApprovers"
INVALIDPARAMETER_FLOWCALLBACKURL = "InvalidParameter.FlowCallbackUrl"
INVALIDPARAMETER_FLOWDEADLINE = "InvalidParameter.FlowDeadLine"
INVALIDPARAMETER_FLOWDESCRIPTION = "InvalidParameter.FlowDescription"
INVALIDPARAMETER_FLOWFILEIDS = "InvalidParameter.FlowFileIds"
INVALIDPARAMETER_FLOWNAME = "InvalidParameter.FlowName"
INVALIDPARAMETER_FLOWTYPE = "InvalidParameter.FlowType"
INVALIDPARAMETER_NONSUPPORTMOBILE = "InvalidParameter.NonsupportMobile"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETER_SIGNCOMPONENTTYPE = "InvalidParameter.SignComponentType"
INVALIDPARAMETER_UNORDERED = "InvalidParameter.Unordered"
INVALIDPARAMETER_UNSUPPORTEDCOMPONENTTYPE = "InvalidParameter.UnsupportedComponentType"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_MISSCOMPONENTNAME = "MissingParameter.MissComponentName"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BYFILESSERVERSIGNFORBID = "OperationDenied.ByFilesServerSignForbid"
OPERATIONDENIED_ERRNORESOURCEACCESS = "OperationDenied.ErrNoResourceAccess"
OPERATIONDENIED_NOIDENTITYVERIFY = "OperationDenied.NoIdentityVerify"
OPERATIONDENIED_NOQUOTA = "OperationDenied.NoQuota"
OPERATIONDENIED_OVERSEAABILITYNOTOPEN = "OperationDenied.OverseaAbilityNotOpen"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_RESOURCE = "ResourceNotFound.Resource"
RESOURCENOTFOUND_SEAL = "ResourceNotFound.Seal"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateFlowReminds added in v1.0.585

func (c *Client) ChannelCreateFlowReminds(request *ChannelCreateFlowRemindsRequest) (response *ChannelCreateFlowRemindsResponse, err error)

ChannelCreateFlowReminds 指定需要批量催办的签署流程Id,批量催办合同,最多100个;接口失败后返回错误信息

注意:

该接口需要开白后使用

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateFlowRemindsWithContext added in v1.0.585

func (c *Client) ChannelCreateFlowRemindsWithContext(ctx context.Context, request *ChannelCreateFlowRemindsRequest) (response *ChannelCreateFlowRemindsResponse, err error)

ChannelCreateFlowReminds 指定需要批量催办的签署流程Id,批量催办合同,最多100个;接口失败后返回错误信息

注意:

该接口需要开白后使用

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateFlowSignReview added in v1.0.472

func (c *Client) ChannelCreateFlowSignReview(request *ChannelCreateFlowSignReviewRequest) (response *ChannelCreateFlowSignReviewResponse, err error)

ChannelCreateFlowSignReview 提交企业签署流程审批结果

在通过接口(CreateFlowsByTemplates 或者ChannelCreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。

若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。

可能返回的错误码:

FAILEDOPERATION_NOTAVAILABLESIGNREVIEW = "FailedOperation.NotAvailableSignReview"
INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETER_STATUS = "InvalidParameter.Status"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_NOFLOWPERMISSION = "OperationDenied.NoFlowPermission"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ChannelCreateFlowSignReviewWithContext added in v1.0.472

func (c *Client) ChannelCreateFlowSignReviewWithContext(ctx context.Context, request *ChannelCreateFlowSignReviewRequest) (response *ChannelCreateFlowSignReviewResponse, err error)

ChannelCreateFlowSignReview 提交企业签署流程审批结果

在通过接口(CreateFlowsByTemplates 或者ChannelCreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。

若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。

可能返回的错误码:

FAILEDOPERATION_NOTAVAILABLESIGNREVIEW = "FailedOperation.NotAvailableSignReview"
INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETER_STATUS = "InvalidParameter.Status"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_NOFLOWPERMISSION = "OperationDenied.NoFlowPermission"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ChannelCreateFlowSignUrl added in v1.0.580

func (c *Client) ChannelCreateFlowSignUrl(request *ChannelCreateFlowSignUrlRequest) (response *ChannelCreateFlowSignUrlResponse, err error)

ChannelCreateFlowSignUrl 渠道版创建签署链接,需要联系运营人员开白后才可使用

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateFlowSignUrlWithContext added in v1.0.580

func (c *Client) ChannelCreateFlowSignUrlWithContext(ctx context.Context, request *ChannelCreateFlowSignUrlRequest) (response *ChannelCreateFlowSignUrlResponse, err error)

ChannelCreateFlowSignUrl 渠道版创建签署链接,需要联系运营人员开白后才可使用

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateMultiFlowSignQRCode added in v1.0.418

func (c *Client) ChannelCreateMultiFlowSignQRCode(request *ChannelCreateMultiFlowSignQRCodeRequest) (response *ChannelCreateMultiFlowSignQRCodeResponse, err error)

ChannelCreateMultiFlowSignQRCode 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫签署流程二维码。

适用的模版仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模版,且模版中发起方没有填写控件。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_QRCODECREATORSIGNCOMPONENTS = "FailedOperation.QrCodeCreatorSignComponents"
FAILEDOPERATION_QRCODESIGNUSERS = "FailedOperation.QrCodeSignUsers"
FAILEDOPERATION_QRCODETEMPLATEID = "FailedOperation.QrCodeTemplateId"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED_NOQUOTA = "OperationDenied.NoQuota"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateMultiFlowSignQRCodeWithContext added in v1.0.418

func (c *Client) ChannelCreateMultiFlowSignQRCodeWithContext(ctx context.Context, request *ChannelCreateMultiFlowSignQRCodeRequest) (response *ChannelCreateMultiFlowSignQRCodeResponse, err error)

ChannelCreateMultiFlowSignQRCode 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫签署流程二维码。

适用的模版仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模版,且模版中发起方没有填写控件。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_QRCODECREATORSIGNCOMPONENTS = "FailedOperation.QrCodeCreatorSignComponents"
FAILEDOPERATION_QRCODESIGNUSERS = "FailedOperation.QrCodeSignUsers"
FAILEDOPERATION_QRCODETEMPLATEID = "FailedOperation.QrCodeTemplateId"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED_NOQUOTA = "OperationDenied.NoQuota"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateReleaseFlow added in v1.0.547

func (c *Client) ChannelCreateReleaseFlow(request *ChannelCreateReleaseFlowRequest) (response *ChannelCreateReleaseFlowResponse, err error)

ChannelCreateReleaseFlow 渠道版发起解除协议,主要应用场景为:基于一份已经签署的合同,进行解除操作。

合同发起人必须在电子签已经进行实名。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_PDF = "InternalError.Pdf"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_MOBILE = "InvalidParameter.Mobile"
INVALIDPARAMETER_NAME = "InvalidParameter.Name"
INVALIDPARAMETER_OPENID = "InvalidParameter.OpenId"
INVALIDPARAMETER_ORGANIZATIONNAME = "InvalidParameter.OrganizationName"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelCreateReleaseFlowWithContext added in v1.0.547

func (c *Client) ChannelCreateReleaseFlowWithContext(ctx context.Context, request *ChannelCreateReleaseFlowRequest) (response *ChannelCreateReleaseFlowResponse, err error)

ChannelCreateReleaseFlow 渠道版发起解除协议,主要应用场景为:基于一份已经签署的合同,进行解除操作。

合同发起人必须在电子签已经进行实名。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_PDF = "InternalError.Pdf"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_MOBILE = "InvalidParameter.Mobile"
INVALIDPARAMETER_NAME = "InvalidParameter.Name"
INVALIDPARAMETER_OPENID = "InvalidParameter.OpenId"
INVALIDPARAMETER_ORGANIZATIONNAME = "InvalidParameter.OrganizationName"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelDescribeEmployees added in v1.0.508

func (c *Client) ChannelDescribeEmployees(request *ChannelDescribeEmployeesRequest) (response *ChannelDescribeEmployeesResponse, err error)

ChannelDescribeEmployees 查询企业员工列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_DBCONNECTION = "InternalError.DbConnection"
INTERNALERROR_DBREAD = "InternalError.DbRead"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_DEPARTUSERID = "InvalidParameter.DepartUserId"
INVALIDPARAMETER_ORGANIZATIONID = "InvalidParameter.OrganizationId"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelDescribeEmployeesWithContext added in v1.0.508

func (c *Client) ChannelDescribeEmployeesWithContext(ctx context.Context, request *ChannelDescribeEmployeesRequest) (response *ChannelDescribeEmployeesResponse, err error)

ChannelDescribeEmployees 查询企业员工列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_DBCONNECTION = "InternalError.DbConnection"
INTERNALERROR_DBREAD = "InternalError.DbRead"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_DEPARTUSERID = "InvalidParameter.DepartUserId"
INVALIDPARAMETER_ORGANIZATIONID = "InvalidParameter.OrganizationId"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelDescribeOrganizationSeals added in v1.0.532

func (c *Client) ChannelDescribeOrganizationSeals(request *ChannelDescribeOrganizationSealsRequest) (response *ChannelDescribeOrganizationSealsResponse, err error)

ChannelDescribeOrganizationSeals 查询渠道子客企业电子印章,需要操作者具有管理印章权限

客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_OPERATORHASNOPERMISSION = "OperationDenied.OperatorHasNoPermission"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelDescribeOrganizationSealsWithContext added in v1.0.532

func (c *Client) ChannelDescribeOrganizationSealsWithContext(ctx context.Context, request *ChannelDescribeOrganizationSealsRequest) (response *ChannelDescribeOrganizationSealsResponse, err error)

ChannelDescribeOrganizationSeals 查询渠道子客企业电子印章,需要操作者具有管理印章权限

客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_OPERATORHASNOPERMISSION = "OperationDenied.OperatorHasNoPermission"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelGetTaskResultApi added in v1.0.467

func (c *Client) ChannelGetTaskResultApi(request *ChannelGetTaskResultApiRequest) (response *ChannelGetTaskResultApiResponse, err error)

ChannelGetTaskResultApi 渠道版查询转换任务状态

可能返回的错误码:

INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelGetTaskResultApiWithContext added in v1.0.467

func (c *Client) ChannelGetTaskResultApiWithContext(ctx context.Context, request *ChannelGetTaskResultApiRequest) (response *ChannelGetTaskResultApiResponse, err error)

ChannelGetTaskResultApi 渠道版查询转换任务状态

可能返回的错误码:

INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelVerifyPdf added in v1.0.501

func (c *Client) ChannelVerifyPdf(request *ChannelVerifyPdfRequest) (response *ChannelVerifyPdfResponse, err error)

ChannelVerifyPdf 合同文件验签

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_ERRNORESOURCEACCESS = "OperationDenied.ErrNoResourceAccess"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ChannelVerifyPdfWithContext added in v1.0.501

func (c *Client) ChannelVerifyPdfWithContext(ctx context.Context, request *ChannelVerifyPdfRequest) (response *ChannelVerifyPdfResponse, err error)

ChannelVerifyPdf 合同文件验签

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_ERRNORESOURCEACCESS = "OperationDenied.ErrNoResourceAccess"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) CreateChannelFlowEvidenceReport added in v1.0.485

func (c *Client) CreateChannelFlowEvidenceReport(request *CreateChannelFlowEvidenceReportRequest) (response *CreateChannelFlowEvidenceReportResponse, err error)

CreateChannelFlowEvidenceReport 创建出证报告,返回报告 ID。需要配合出证套餐才能调用。

出证需要一定时间,建议调用创建出证24小时之后再通过DescribeChannelFlowEvidenceReport进行查询。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR_SYSTEM = "InternalError.System"
MISSINGPARAMETER_FLOWID = "MissingParameter.FlowId"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_FLOWSTATUSFORBID = "OperationDenied.FlowStatusForbid"
OPERATIONDENIED_NOTBELONGSUPERADMINORLEGALPERSON = "OperationDenied.NotBelongSuperAdminOrLegalPerson"
OPERATIONDENIED_PROVENOQUOTA = "OperationDenied.ProveNoQuota"
OPERATIONDENIED_WHITELISTFORBID = "OperationDenied.WhiteListForbid"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
RESOURCENOTFOUND_FLOWAPPROVER = "ResourceNotFound.FlowApprover"
RESOURCENOTFOUND_URL = "ResourceNotFound.URL"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) CreateChannelFlowEvidenceReportWithContext added in v1.0.485

func (c *Client) CreateChannelFlowEvidenceReportWithContext(ctx context.Context, request *CreateChannelFlowEvidenceReportRequest) (response *CreateChannelFlowEvidenceReportResponse, err error)

CreateChannelFlowEvidenceReport 创建出证报告,返回报告 ID。需要配合出证套餐才能调用。

出证需要一定时间,建议调用创建出证24小时之后再通过DescribeChannelFlowEvidenceReport进行查询。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR_SYSTEM = "InternalError.System"
MISSINGPARAMETER_FLOWID = "MissingParameter.FlowId"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_FLOWSTATUSFORBID = "OperationDenied.FlowStatusForbid"
OPERATIONDENIED_NOTBELONGSUPERADMINORLEGALPERSON = "OperationDenied.NotBelongSuperAdminOrLegalPerson"
OPERATIONDENIED_PROVENOQUOTA = "OperationDenied.ProveNoQuota"
OPERATIONDENIED_WHITELISTFORBID = "OperationDenied.WhiteListForbid"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
RESOURCENOTFOUND_FLOWAPPROVER = "ResourceNotFound.FlowApprover"
RESOURCENOTFOUND_URL = "ResourceNotFound.URL"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) CreateConsoleLoginUrl

func (c *Client) CreateConsoleLoginUrl(request *CreateConsoleLoginUrlRequest) (response *CreateConsoleLoginUrlResponse, err error)

CreateConsoleLoginUrl 此接口(CreateConsoleLoginUrl)用于创建渠道子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。

若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)

若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。

若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_HASAUTHORIZED = "FailedOperation.HasAuthorized"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_DBINSERT = "InternalError.DbInsert"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BUSINESSLICENSE = "InvalidParameter.BusinessLicense"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_ENDPOINT = "InvalidParameter.EndPoint"
INVALIDPARAMETER_FILETYPE = "InvalidParameter.FileType"
INVALIDPARAMETER_MENUSTATUS = "InvalidParameter.MenuStatus"
INVALIDPARAMETER_OPENID = "InvalidParameter.OpenId"
INVALIDPARAMETER_ORGANIZATIONID = "InvalidParameter.OrganizationId"
INVALIDPARAMETER_ORGANIZATIONNAME = "InvalidParameter.OrganizationName"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
LIMITEXCEEDED_FILESIZE = "LimitExceeded.FileSize"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_COMPANYACTIVEINFO = "MissingParameter.CompanyActiveInfo"
MISSINGPARAMETER_ORGOPENID = "MissingParameter.OrgOpenId"
MISSINGPARAMETER_PROXYOPERATOROPENID = "MissingParameter.ProxyOperatorOpenId"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BANNEDAPPLICATION = "OperationDenied.BannedApplication"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_APPLICATIONID = "ResourceNotFound.ApplicationId"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateConsoleLoginUrlWithContext added in v1.0.324

func (c *Client) CreateConsoleLoginUrlWithContext(ctx context.Context, request *CreateConsoleLoginUrlRequest) (response *CreateConsoleLoginUrlResponse, err error)

CreateConsoleLoginUrl 此接口(CreateConsoleLoginUrl)用于创建渠道子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。

若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)

若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。

若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_HASAUTHORIZED = "FailedOperation.HasAuthorized"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_DBINSERT = "InternalError.DbInsert"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BUSINESSLICENSE = "InvalidParameter.BusinessLicense"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_ENDPOINT = "InvalidParameter.EndPoint"
INVALIDPARAMETER_FILETYPE = "InvalidParameter.FileType"
INVALIDPARAMETER_MENUSTATUS = "InvalidParameter.MenuStatus"
INVALIDPARAMETER_OPENID = "InvalidParameter.OpenId"
INVALIDPARAMETER_ORGANIZATIONID = "InvalidParameter.OrganizationId"
INVALIDPARAMETER_ORGANIZATIONNAME = "InvalidParameter.OrganizationName"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
LIMITEXCEEDED_FILESIZE = "LimitExceeded.FileSize"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_COMPANYACTIVEINFO = "MissingParameter.CompanyActiveInfo"
MISSINGPARAMETER_ORGOPENID = "MissingParameter.OrgOpenId"
MISSINGPARAMETER_PROXYOPERATOROPENID = "MissingParameter.ProxyOperatorOpenId"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BANNEDAPPLICATION = "OperationDenied.BannedApplication"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_APPLICATIONID = "ResourceNotFound.ApplicationId"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateFlowsByTemplates

func (c *Client) CreateFlowsByTemplates(request *CreateFlowsByTemplatesRequest) (response *CreateFlowsByTemplatesResponse, err error)

CreateFlowsByTemplates 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。

如若在模板中配置了动态表格, 上传的附件必须为A4大小

合同发起人必须在电子签已经进行实名。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_DECRYPTION = "InternalError.Decryption"
INTERNALERROR_ENCRYPTION = "InternalError.Encryption"
INTERNALERROR_GENERATEID = "InternalError.GenerateId"
INTERNALERROR_SYSTEM = "InternalError.System"
INTERNALERROR_THIRDPARTY = "InternalError.ThirdParty"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_BIZAPPROVERALREADYEXISTS = "InvalidParameter.BizApproverAlreadyExists"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_FLOWINFOS = "InvalidParameter.FlowInfos"
INVALIDPARAMETER_MISSINGREQUIREDPARAMETERVALUE = "InvalidParameter.MissingRequiredParameterValue"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
LIMITEXCEEDED_CREATEFLOWNUM = "LimitExceeded.CreateFlowNum"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_NOIDENTITYVERIFY = "OperationDenied.NoIdentityVerify"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) CreateFlowsByTemplatesWithContext added in v1.0.324

func (c *Client) CreateFlowsByTemplatesWithContext(ctx context.Context, request *CreateFlowsByTemplatesRequest) (response *CreateFlowsByTemplatesResponse, err error)

CreateFlowsByTemplates 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。

如若在模板中配置了动态表格, 上传的附件必须为A4大小

合同发起人必须在电子签已经进行实名。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_DECRYPTION = "InternalError.Decryption"
INTERNALERROR_ENCRYPTION = "InternalError.Encryption"
INTERNALERROR_GENERATEID = "InternalError.GenerateId"
INTERNALERROR_SYSTEM = "InternalError.System"
INTERNALERROR_THIRDPARTY = "InternalError.ThirdParty"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_BIZAPPROVERALREADYEXISTS = "InvalidParameter.BizApproverAlreadyExists"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_FLOWINFOS = "InvalidParameter.FlowInfos"
INVALIDPARAMETER_MISSINGREQUIREDPARAMETERVALUE = "InvalidParameter.MissingRequiredParameterValue"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
LIMITEXCEEDED_CREATEFLOWNUM = "LimitExceeded.CreateFlowNum"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_NOIDENTITYVERIFY = "OperationDenied.NoIdentityVerify"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) CreateSealByImage added in v1.0.390

func (c *Client) CreateSealByImage(request *CreateSealByImageRequest) (response *CreateSealByImageResponse, err error)

CreateSealByImage 渠道通过图片为子客代创建印章,图片最大5MB

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_AUTHFAIL = "FailedOperation.AuthFail"
FAILEDOPERATION_EXISTSAMESEALNAME = "FailedOperation.ExistSameSealName"
INTERNALERROR_SEALUPLOAD = "InternalError.SealUpload"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER_IMAGE = "InvalidParameter.Image"
INVALIDPARAMETER_LIMITSEALNAME = "InvalidParameter.LimitSealName"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETER_SENSITIVEFILECONTENT = "InvalidParameter.SensitiveFileContent"
MISSINGPARAMETER_ORGANIZATIONID = "MissingParameter.OrganizationId"
MISSINGPARAMETER_SEALIMAGE = "MissingParameter.SealImage"
MISSINGPARAMETER_SEALNAME = "MissingParameter.SealName"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_ORGANIZATION = "ResourceNotFound.Organization"
RESOURCENOTFOUND_VERIFYUSER = "ResourceNotFound.VerifyUser"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) CreateSealByImageWithContext added in v1.0.390

func (c *Client) CreateSealByImageWithContext(ctx context.Context, request *CreateSealByImageRequest) (response *CreateSealByImageResponse, err error)

CreateSealByImage 渠道通过图片为子客代创建印章,图片最大5MB

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_AUTHFAIL = "FailedOperation.AuthFail"
FAILEDOPERATION_EXISTSAMESEALNAME = "FailedOperation.ExistSameSealName"
INTERNALERROR_SEALUPLOAD = "InternalError.SealUpload"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER_IMAGE = "InvalidParameter.Image"
INVALIDPARAMETER_LIMITSEALNAME = "InvalidParameter.LimitSealName"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETER_SENSITIVEFILECONTENT = "InvalidParameter.SensitiveFileContent"
MISSINGPARAMETER_ORGANIZATIONID = "MissingParameter.OrganizationId"
MISSINGPARAMETER_SEALIMAGE = "MissingParameter.SealImage"
MISSINGPARAMETER_SEALNAME = "MissingParameter.SealName"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_ORGANIZATION = "ResourceNotFound.Organization"
RESOURCENOTFOUND_VERIFYUSER = "ResourceNotFound.VerifyUser"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) CreateSignUrls

func (c *Client) CreateSignUrls(request *CreateSignUrlsRequest) (response *CreateSignUrlsResponse, err error)

CreateSignUrls 创建跳转小程序查看或签署的链接。

跳转小程序的几种方式:主要是设置不同的EndPoint

1. 通过链接Url直接跳转到小程序,不需要返回

设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。

2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl

设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。

3. 客户App直接跳转到小程序-->小程序签署完成-->返回App

跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)

全屏方式:

https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html

半屏方式:

https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html

其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。

使用CreateSignUrls,设置EndPoint为APP,得到path。

4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序

实现方式同App跳小程序。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_GENERATEID = "InternalError.GenerateId"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_ENDPOINT = "InvalidParameter.EndPoint"
INVALIDPARAMETER_GENERATETYPE = "InvalidParameter.GenerateType"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_FLOWIDSORFLOWGROUPID = "MissingParameter.FlowIdsOrFlowGroupId"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_NOIDENTITYVERIFY = "OperationDenied.NoIdentityVerify"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_FLOWGROUP = "ResourceNotFound.FlowGroup"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) CreateSignUrlsWithContext added in v1.0.324

func (c *Client) CreateSignUrlsWithContext(ctx context.Context, request *CreateSignUrlsRequest) (response *CreateSignUrlsResponse, err error)

CreateSignUrls 创建跳转小程序查看或签署的链接。

跳转小程序的几种方式:主要是设置不同的EndPoint

1. 通过链接Url直接跳转到小程序,不需要返回

设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。

2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl

设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。

3. 客户App直接跳转到小程序-->小程序签署完成-->返回App

跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)

全屏方式:

https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html

半屏方式:

https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html

其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。

使用CreateSignUrls,设置EndPoint为APP,得到path。

4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序

实现方式同App跳小程序。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_GENERATEID = "InternalError.GenerateId"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_ENDPOINT = "InvalidParameter.EndPoint"
INVALIDPARAMETER_GENERATETYPE = "InvalidParameter.GenerateType"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_FLOWIDSORFLOWGROUPID = "MissingParameter.FlowIdsOrFlowGroupId"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_NOIDENTITYVERIFY = "OperationDenied.NoIdentityVerify"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_FLOWGROUP = "ResourceNotFound.FlowGroup"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) DescribeChannelFlowEvidenceReport added in v1.0.546

func (c *Client) DescribeChannelFlowEvidenceReport(request *DescribeChannelFlowEvidenceReportRequest) (response *DescribeChannelFlowEvidenceReportResponse, err error)

DescribeChannelFlowEvidenceReport 查询出证报告,返回报告 URL。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
MISSINGPARAMETER_FLOWID = "MissingParameter.FlowId"
OPERATIONDENIED_FLOWSTATUSFORBID = "OperationDenied.FlowStatusForbid"
OPERATIONDENIED_NOTBELONGSUPERADMINORLEGALPERSON = "OperationDenied.NotBelongSuperAdminOrLegalPerson"
OPERATIONDENIED_WHITELISTFORBID = "OperationDenied.WhiteListForbid"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
RESOURCENOTFOUND_FLOWAPPROVER = "ResourceNotFound.FlowApprover"
RESOURCENOTFOUND_URL = "ResourceNotFound.URL"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) DescribeChannelFlowEvidenceReportWithContext added in v1.0.546

func (c *Client) DescribeChannelFlowEvidenceReportWithContext(ctx context.Context, request *DescribeChannelFlowEvidenceReportRequest) (response *DescribeChannelFlowEvidenceReportResponse, err error)

DescribeChannelFlowEvidenceReport 查询出证报告,返回报告 URL。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
MISSINGPARAMETER_FLOWID = "MissingParameter.FlowId"
OPERATIONDENIED_FLOWSTATUSFORBID = "OperationDenied.FlowStatusForbid"
OPERATIONDENIED_NOTBELONGSUPERADMINORLEGALPERSON = "OperationDenied.NotBelongSuperAdminOrLegalPerson"
OPERATIONDENIED_WHITELISTFORBID = "OperationDenied.WhiteListForbid"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
RESOURCENOTFOUND_FLOWAPPROVER = "ResourceNotFound.FlowApprover"
RESOURCENOTFOUND_URL = "ResourceNotFound.URL"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) DescribeExtendedServiceAuthInfo added in v1.0.578

func (c *Client) DescribeExtendedServiceAuthInfo(request *DescribeExtendedServiceAuthInfoRequest) (response *DescribeExtendedServiceAuthInfoResponse, err error)

DescribeExtendedServiceAuthInfo 查询企业扩展服务授权信息,企业经办人需要是企业超管或者法人

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) DescribeExtendedServiceAuthInfoWithContext added in v1.0.578

func (c *Client) DescribeExtendedServiceAuthInfoWithContext(ctx context.Context, request *DescribeExtendedServiceAuthInfoRequest) (response *DescribeExtendedServiceAuthInfoResponse, err error)

DescribeExtendedServiceAuthInfo 查询企业扩展服务授权信息,企业经办人需要是企业超管或者法人

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) DescribeFlowDetailInfo added in v1.0.319

func (c *Client) DescribeFlowDetailInfo(request *DescribeFlowDetailInfoRequest) (response *DescribeFlowDetailInfoResponse, err error)

DescribeFlowDetailInfo 此接口(DescribeFlowDetailInfo)用于查询合同(签署流程)的详细信息。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_ENDPOINT = "InvalidParameter.EndPoint"
INVALIDPARAMETER_FLOWIDS = "InvalidParameter.FlowIds"
LIMITEXCEEDED_FLOWIDS = "LimitExceeded.FlowIds"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_FLOWIDS = "MissingParameter.FlowIds"
MISSINGPARAMETER_FLOWIDSORFLOWGROUPID = "MissingParameter.FlowIdsOrFlowGroupId"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_FLOWAPPROVERS = "ResourceNotFound.FlowApprovers"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeFlowDetailInfoWithContext added in v1.0.324

func (c *Client) DescribeFlowDetailInfoWithContext(ctx context.Context, request *DescribeFlowDetailInfoRequest) (response *DescribeFlowDetailInfoResponse, err error)

DescribeFlowDetailInfo 此接口(DescribeFlowDetailInfo)用于查询合同(签署流程)的详细信息。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_ENDPOINT = "InvalidParameter.EndPoint"
INVALIDPARAMETER_FLOWIDS = "InvalidParameter.FlowIds"
LIMITEXCEEDED_FLOWIDS = "LimitExceeded.FlowIds"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_FLOWIDS = "MissingParameter.FlowIds"
MISSINGPARAMETER_FLOWIDSORFLOWGROUPID = "MissingParameter.FlowIdsOrFlowGroupId"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_FLOWAPPROVERS = "ResourceNotFound.FlowApprovers"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeResourceUrlsByFlows added in v1.0.274

func (c *Client) DescribeResourceUrlsByFlows(request *DescribeResourceUrlsByFlowsRequest) (response *DescribeResourceUrlsByFlowsResponse, err error)

DescribeResourceUrlsByFlows 根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。

此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_FLOWID = "MissingParameter.FlowId"
MISSINGPARAMETER_USEROPENID = "MissingParameter.UserOpenId"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_OUTQUERYLIMIT = "OperationDenied.OutQueryLimit"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_ORGANIZATION = "ResourceNotFound.Organization"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNAUTHORIZEDOPERATION_UNAUTHORIZEDOPERATIONDOWNLOAD = "UnauthorizedOperation.UnauthorizedOperationDownload"
UNAUTHORIZEDOPERATION_UNAUTHORIZEDOPERATIONORGANIZATION = "UnauthorizedOperation.UnauthorizedOperationOrganization"

func (*Client) DescribeResourceUrlsByFlowsWithContext added in v1.0.324

func (c *Client) DescribeResourceUrlsByFlowsWithContext(ctx context.Context, request *DescribeResourceUrlsByFlowsRequest) (response *DescribeResourceUrlsByFlowsResponse, err error)

DescribeResourceUrlsByFlows 根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。

此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_FLOWID = "MissingParameter.FlowId"
MISSINGPARAMETER_USEROPENID = "MissingParameter.UserOpenId"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_OUTQUERYLIMIT = "OperationDenied.OutQueryLimit"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_ORGANIZATION = "ResourceNotFound.Organization"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNAUTHORIZEDOPERATION_UNAUTHORIZEDOPERATIONDOWNLOAD = "UnauthorizedOperation.UnauthorizedOperationDownload"
UNAUTHORIZEDOPERATION_UNAUTHORIZEDOPERATIONORGANIZATION = "UnauthorizedOperation.UnauthorizedOperationOrganization"

func (*Client) DescribeTemplates

func (c *Client) DescribeTemplates(request *DescribeTemplatesRequest) (response *DescribeTemplatesResponse, err error)

DescribeTemplates 通过此接口(DescribeTemplates)查询该子客企业在电子签拥有的有效模板,不包括渠道模板

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_DBREAD = "InternalError.DbRead"
INTERNALERROR_DEPENDSAPI = "InternalError.DependsApi"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_CONTENTTYPE = "InvalidParameter.ContentType"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_NOIDENTITYVERIFY = "OperationDenied.NoIdentityVerify"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_RESOURCE = "ResourceNotFound.Resource"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) DescribeTemplatesWithContext added in v1.0.324

func (c *Client) DescribeTemplatesWithContext(ctx context.Context, request *DescribeTemplatesRequest) (response *DescribeTemplatesResponse, err error)

DescribeTemplates 通过此接口(DescribeTemplates)查询该子客企业在电子签拥有的有效模板,不包括渠道模板

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_DBREAD = "InternalError.DbRead"
INTERNALERROR_DEPENDSAPI = "InternalError.DependsApi"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_APPLICATION = "InvalidParameter.Application"
INVALIDPARAMETER_CONTENTTYPE = "InvalidParameter.ContentType"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_NOIDENTITYVERIFY = "OperationDenied.NoIdentityVerify"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_RESOURCE = "ResourceNotFound.Resource"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) DescribeUsage

func (c *Client) DescribeUsage(request *DescribeUsageRequest) (response *DescribeUsageResponse, err error)

DescribeUsage 此接口(DescribeUsage)用于获取渠道所有合作企业流量消耗情况。

注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DATE = "InvalidParameter.Date"
LIMITEXCEEDED_CALLTIMES = "LimitExceeded.CallTimes"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_DATE = "MissingParameter.Date"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BANNEDAPPLICATION = "OperationDenied.BannedApplication"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeUsageWithContext added in v1.0.324

func (c *Client) DescribeUsageWithContext(ctx context.Context, request *DescribeUsageRequest) (response *DescribeUsageResponse, err error)

DescribeUsage 此接口(DescribeUsage)用于获取渠道所有合作企业流量消耗情况。

注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DATE = "InvalidParameter.Date"
LIMITEXCEEDED_CALLTIMES = "LimitExceeded.CallTimes"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_DATE = "MissingParameter.Date"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BANNEDAPPLICATION = "OperationDenied.BannedApplication"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetDownloadFlowUrl added in v1.0.317

func (c *Client) GetDownloadFlowUrl(request *GetDownloadFlowUrlRequest) (response *GetDownloadFlowUrlResponse, err error)

GetDownloadFlowUrl 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。

当前接口限制最多合同(流程)50个.

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_FLOWNUMEXCEED = "FailedOperation.FlowNumExceed"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_FLOWINFO = "MissingParameter.FlowInfo"
MISSINGPARAMETER_ORGOPENID = "MissingParameter.OrgOpenId"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BANNEDAPPLICATION = "OperationDenied.BannedApplication"
OPERATIONDENIED_DOWNLOADMORETHANONE = "OperationDenied.DownLoadMoreThanOne"
OPERATIONDENIED_FILEDELETED = "OperationDenied.FileDeleted"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_APPLICATIONID = "ResourceNotFound.ApplicationId"
RESOURCENOTFOUND_FILE = "ResourceNotFound.File"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
RESOURCENOTFOUND_TEAMWORKORGANIZATION = "ResourceNotFound.TeamWorkOrganization"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNAUTHORIZEDOPERATION_UNAUTHORIZEDOPERATIONDOWNLOAD = "UnauthorizedOperation.UnauthorizedOperationDownload"
UNAUTHORIZEDOPERATION_UNAUTHORIZEDOPERATIONORGANIZATION = "UnauthorizedOperation.UnauthorizedOperationOrganization"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetDownloadFlowUrlWithContext added in v1.0.324

func (c *Client) GetDownloadFlowUrlWithContext(ctx context.Context, request *GetDownloadFlowUrlRequest) (response *GetDownloadFlowUrlResponse, err error)

GetDownloadFlowUrl 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。

当前接口限制最多合同(流程)50个.

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_FLOWNUMEXCEED = "FailedOperation.FlowNumExceed"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_FLOWINFO = "MissingParameter.FlowInfo"
MISSINGPARAMETER_ORGOPENID = "MissingParameter.OrgOpenId"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BANNEDAPPLICATION = "OperationDenied.BannedApplication"
OPERATIONDENIED_DOWNLOADMORETHANONE = "OperationDenied.DownLoadMoreThanOne"
OPERATIONDENIED_FILEDELETED = "OperationDenied.FileDeleted"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_APPLICATIONID = "ResourceNotFound.ApplicationId"
RESOURCENOTFOUND_FILE = "ResourceNotFound.File"
RESOURCENOTFOUND_FLOW = "ResourceNotFound.Flow"
RESOURCENOTFOUND_TEAMWORKORGANIZATION = "ResourceNotFound.TeamWorkOrganization"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNAUTHORIZEDOPERATION_UNAUTHORIZEDOPERATIONDOWNLOAD = "UnauthorizedOperation.UnauthorizedOperationDownload"
UNAUTHORIZEDOPERATION_UNAUTHORIZEDOPERATIONORGANIZATION = "UnauthorizedOperation.UnauthorizedOperationOrganization"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ModifyExtendedService added in v1.0.578

func (c *Client) ModifyExtendedService(request *ModifyExtendedServiceRequest) (response *ModifyExtendedServiceResponse, err error)

ModifyExtendedService 修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) ModifyExtendedServiceWithContext added in v1.0.578

func (c *Client) ModifyExtendedServiceWithContext(ctx context.Context, request *ModifyExtendedServiceRequest) (response *ModifyExtendedServiceResponse, err error)

ModifyExtendedService 修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) OperateChannelTemplate added in v1.0.317

func (c *Client) OperateChannelTemplate(request *OperateChannelTemplateRequest) (response *OperateChannelTemplateResponse, err error)

OperateChannelTemplate 此接口(OperateChannelTemplate)用于针对渠道模板库中的模板对子客企业可见性的查询和设置,不会直接分配渠道模板给子客企业。

1、OperateType=select时:

查询渠道模板库

2、OperateType=update或者delete时:

对子客企业进行模板库中模板可见性的修改、删除操作。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_STAFFALREADYVERIFY = "FailedOperation.StaffAlreadyVerify"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_DBCONNECTION = "InternalError.DbConnection"
INTERNALERROR_DBREAD = "InternalError.DbRead"
INTERNALERROR_DBUPDATE = "InternalError.DbUpdate"
INTERNALERROR_DECRYPTION = "InternalError.Decryption"
INTERNALERROR_ENCRYPTION = "InternalError.Encryption"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_EMPTYPARAMS = "InvalidParameter.EmptyParams"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_TEMPLATES = "MissingParameter.Templates"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTHTAG = "OperationDenied.AuthTag"
OPERATIONDENIED_NOAPIAUTH = "OperationDenied.NoApiAuth"
OPERATIONDENIED_OPERATETYPE = "OperationDenied.OperateType"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_APPLICATIONAUTH = "ResourceNotFound.ApplicationAuth"
RESOURCENOTFOUND_ORGANIZATION = "ResourceNotFound.Organization"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) OperateChannelTemplateWithContext added in v1.0.324

func (c *Client) OperateChannelTemplateWithContext(ctx context.Context, request *OperateChannelTemplateRequest) (response *OperateChannelTemplateResponse, err error)

OperateChannelTemplate 此接口(OperateChannelTemplate)用于针对渠道模板库中的模板对子客企业可见性的查询和设置,不会直接分配渠道模板给子客企业。

1、OperateType=select时:

查询渠道模板库

2、OperateType=update或者delete时:

对子客企业进行模板库中模板可见性的修改、删除操作。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_STAFFALREADYVERIFY = "FailedOperation.StaffAlreadyVerify"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_DB = "InternalError.Db"
INTERNALERROR_DBCONNECTION = "InternalError.DbConnection"
INTERNALERROR_DBREAD = "InternalError.DbRead"
INTERNALERROR_DBUPDATE = "InternalError.DbUpdate"
INTERNALERROR_DECRYPTION = "InternalError.Decryption"
INTERNALERROR_ENCRYPTION = "InternalError.Encryption"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_EMPTYPARAMS = "InvalidParameter.EmptyParams"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
MISSINGPARAMETER = "MissingParameter"
MISSINGPARAMETER_TEMPLATES = "MissingParameter.Templates"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTHTAG = "OperationDenied.AuthTag"
OPERATIONDENIED_NOAPIAUTH = "OperationDenied.NoApiAuth"
OPERATIONDENIED_OPERATETYPE = "OperationDenied.OperateType"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_APPLICATIONAUTH = "ResourceNotFound.ApplicationAuth"
RESOURCENOTFOUND_ORGANIZATION = "ResourceNotFound.Organization"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) PrepareFlows

func (c *Client) PrepareFlows(request *PrepareFlowsRequest) (response *PrepareFlowsResponse, err error)

PrepareFlows 该接口 (PrepareFlows) 用于创建待发起文件

用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。

目前该接口只支持B2C,不建议使用,将会废弃。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_FLOWDEADLINE = "InvalidParameter.FlowDeadLine"
INVALIDPARAMETER_FLOWNAME = "InvalidParameter.FlowName"
INVALIDPARAMETER_NAME = "InvalidParameter.Name"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
LIMITEXCEEDED_FLOWINFOS = "LimitExceeded.FlowInfos"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_ORGANIZATION = "ResourceNotFound.Organization"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) PrepareFlowsWithContext added in v1.0.324

func (c *Client) PrepareFlowsWithContext(ctx context.Context, request *PrepareFlowsRequest) (response *PrepareFlowsResponse, err error)

PrepareFlows 该接口 (PrepareFlows) 用于创建待发起文件

用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。

目前该接口只支持B2C,不建议使用,将会废弃。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DATANOTFOUND = "InvalidParameter.DataNotFound"
INVALIDPARAMETER_FLOWDEADLINE = "InvalidParameter.FlowDeadLine"
INVALIDPARAMETER_FLOWNAME = "InvalidParameter.FlowName"
INVALIDPARAMETER_NAME = "InvalidParameter.Name"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
LIMITEXCEEDED_FLOWINFOS = "LimitExceeded.FlowInfos"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_ORGANIZATION = "ResourceNotFound.Organization"
RESOURCENOTFOUND_TEMPLATE = "ResourceNotFound.Template"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) SyncProxyOrganization

func (c *Client) SyncProxyOrganization(request *SyncProxyOrganizationRequest) (response *SyncProxyOrganizationResponse, err error)

SyncProxyOrganization 此接口(SyncProxyOrganization)用于同步渠道子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BUSINESSLICENSE = "InvalidParameter.BusinessLicense"
INVALIDPARAMETER_FILETYPE = "InvalidParameter.FileType"
INVALIDPARAMETER_NAME = "InvalidParameter.Name"
INVALIDPARAMETER_ORGANIZATIONID = "InvalidParameter.OrganizationId"
INVALIDPARAMETER_ORGANIZATIONNAME = "InvalidParameter.OrganizationName"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
LIMITEXCEEDED_FILESIZE = "LimitExceeded.FileSize"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BANNEDAPPLICATION = "OperationDenied.BannedApplication"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_APPLICATIONID = "ResourceNotFound.ApplicationId"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) SyncProxyOrganizationOperators

func (c *Client) SyncProxyOrganizationOperators(request *SyncProxyOrganizationOperatorsRequest) (response *SyncProxyOrganizationOperatorsResponse, err error)

SyncProxyOrganizationOperators 此接口(SyncProxyOrganizationOperators)用于同步渠道子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于渠道平台的,无法针对员工做新增/更新/离职等操作。

若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_STAFFALREADYVERIFY = "FailedOperation.StaffAlreadyVerify"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_DBCONNECTION = "InternalError.DbConnection"
INTERNALERROR_DBREAD = "InternalError.DbRead"
INTERNALERROR_DBUPDATE = "InternalError.DbUpdate"
INTERNALERROR_DECRYPTION = "InternalError.Decryption"
INTERNALERROR_ENCRYPTION = "InternalError.Encryption"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_EMPTYPARAMS = "InvalidParameter.EmptyParams"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
LIMITEXCEEDED_PROXYORGANIZATIONOPERATOR = "LimitExceeded.ProxyOrganizationOperator"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_NOAPIAUTH = "OperationDenied.NoApiAuth"
OPERATIONDENIED_OPERATETYPE = "OperationDenied.OperateType"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_APPLICATIONID = "ResourceNotFound.ApplicationId"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) SyncProxyOrganizationOperatorsWithContext added in v1.0.324

func (c *Client) SyncProxyOrganizationOperatorsWithContext(ctx context.Context, request *SyncProxyOrganizationOperatorsRequest) (response *SyncProxyOrganizationOperatorsResponse, err error)

SyncProxyOrganizationOperators 此接口(SyncProxyOrganizationOperators)用于同步渠道子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于渠道平台的,无法针对员工做新增/更新/离职等操作。

若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_STAFFALREADYVERIFY = "FailedOperation.StaffAlreadyVerify"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_DBCONNECTION = "InternalError.DbConnection"
INTERNALERROR_DBREAD = "InternalError.DbRead"
INTERNALERROR_DBUPDATE = "InternalError.DbUpdate"
INTERNALERROR_DECRYPTION = "InternalError.Decryption"
INTERNALERROR_ENCRYPTION = "InternalError.Encryption"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_EMPTYPARAMS = "InvalidParameter.EmptyParams"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
LIMITEXCEEDED_PROXYORGANIZATIONOPERATOR = "LimitExceeded.ProxyOrganizationOperator"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_NOAPIAUTH = "OperationDenied.NoApiAuth"
OPERATIONDENIED_OPERATETYPE = "OperationDenied.OperateType"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_APPLICATIONID = "ResourceNotFound.ApplicationId"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) SyncProxyOrganizationWithContext added in v1.0.324

func (c *Client) SyncProxyOrganizationWithContext(ctx context.Context, request *SyncProxyOrganizationRequest) (response *SyncProxyOrganizationResponse, err error)

SyncProxyOrganization 此接口(SyncProxyOrganization)用于同步渠道子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_API = "InternalError.Api"
INTERNALERROR_SYSTEM = "InternalError.System"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BUSINESSLICENSE = "InvalidParameter.BusinessLicense"
INVALIDPARAMETER_FILETYPE = "InvalidParameter.FileType"
INVALIDPARAMETER_NAME = "InvalidParameter.Name"
INVALIDPARAMETER_ORGANIZATIONID = "InvalidParameter.OrganizationId"
INVALIDPARAMETER_ORGANIZATIONNAME = "InvalidParameter.OrganizationName"
INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
LIMITEXCEEDED_FILESIZE = "LimitExceeded.FileSize"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BANNEDAPPLICATION = "OperationDenied.BannedApplication"
OPERATIONDENIED_USERNOTINORGANIZATION = "OperationDenied.UserNotInOrganization"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_APPLICATION = "ResourceNotFound.Application"
RESOURCENOTFOUND_APPLICATIONID = "ResourceNotFound.ApplicationId"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UploadFiles added in v1.0.370

func (c *Client) UploadFiles(request *UploadFilesRequest) (response *UploadFilesResponse, err error)

UploadFiles 此接口(UploadFiles)用于文件上传。

调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。

代码示例:

HttpProfile httpProfile = new HttpProfile();

httpProfile.setEndpoint("file.test.ess.tencent.cn");

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR_SERIALIZE = "InternalError.Serialize"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

func (*Client) UploadFilesWithContext added in v1.0.370

func (c *Client) UploadFilesWithContext(ctx context.Context, request *UploadFilesRequest) (response *UploadFilesResponse, err error)

UploadFiles 此接口(UploadFiles)用于文件上传。

调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。

代码示例:

HttpProfile httpProfile = new HttpProfile();

httpProfile.setEndpoint("file.test.ess.tencent.cn");

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR_SERIALIZE = "InternalError.Serialize"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION_NOPERMISSIONFEATURE = "UnauthorizedOperation.NoPermissionFeature"

type Component

type Component struct {
	// 控件编号
	//
	// CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
	//
	// 注:
	// 当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
	// 例:
	// 当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
	// 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
	//
	// 创建控件时,此值为空
	// 查询时返回完整结构
	ComponentId *string `json:"ComponentId,omitempty" name:"ComponentId"`

	// 如果是Component控件类型,则可选的字段为:
	// TEXT - 普通文本控件,输入文本字符串;
	// MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
	// CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
	// FILL_IMAGE - 图片控件,ComponentValue 填写图片的资源 ID;
	// DYNAMIC_TABLE - 动态表格控件;
	// ATTACHMENT - 附件控件,ComponentValue 填写福建图片的资源 ID列表,以逗号分割;
	// SELECTOR - 选择器控件,ComponentValue填写选择的字符串内容;
	// DATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;
	// DISTRICT - 省市区行政区划控件,ComponentValue填写省市区行政区划字符串内容;
	//
	// 如果是SignComponent控件类型,则可选的字段为
	// SIGN_SEAL - 签署印章控件;
	// SIGN_DATE - 签署日期控件;
	// SIGN_SIGNATURE - 用户签名控件;
	// SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
	// SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
	// SIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认
	//
	// 表单域的控件不能作为印章和签名控件
	ComponentType *string `json:"ComponentType,omitempty" name:"ComponentType"`

	// 控件简称,不能超过30个字符
	ComponentName *string `json:"ComponentName,omitempty" name:"ComponentName"`

	// 定义控件是否为必填项,默认为false
	ComponentRequired *bool `json:"ComponentRequired,omitempty" name:"ComponentRequired"`

	// 控件关联的签署方id
	ComponentRecipientId *string `json:"ComponentRecipientId,omitempty" name:"ComponentRecipientId"`

	// 控件所属文件的序号 (文档中文件的排列序号,从0开始)
	FileIndex *int64 `json:"FileIndex,omitempty" name:"FileIndex"`

	// 控件生成的方式:
	// NORMAL - 普通控件
	// FIELD - 表单域
	// KEYWORD - 关键字
	GenerateMode *string `json:"GenerateMode,omitempty" name:"GenerateMode"`

	// 参数控件宽度,默认100,单位px
	// 表单域和关键字转换控件不用填
	ComponentWidth *float64 `json:"ComponentWidth,omitempty" name:"ComponentWidth"`

	// 参数控件高度,默认100,单位px
	// 表单域和关键字转换控件不用填
	ComponentHeight *float64 `json:"ComponentHeight,omitempty" name:"ComponentHeight"`

	// 参数控件所在页码,从1开始
	ComponentPage *int64 `json:"ComponentPage,omitempty" name:"ComponentPage"`

	// 参数控件X位置,单位px
	ComponentPosX *float64 `json:"ComponentPosX,omitempty" name:"ComponentPosX"`

	// 参数控件Y位置,单位px
	ComponentPosY *float64 `json:"ComponentPosY,omitempty" name:"ComponentPosY"`

	// 参数控件样式,json格式表述
	//
	// 不同类型的控件会有部分非通用参数
	//
	// TEXT/MULTI_LINE_TEXT控件可以指定
	// 1 Font:目前只支持黑体、宋体
	// 2 FontSize: 范围12-72
	// 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
	// 例如:{"FontSize":12}
	//
	// ComponentType为FILL_IMAGE时,支持以下参数:
	// NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
	// FillMethod: int. 填充方式。0-铺满(默认);1-等比例缩放
	//
	// ComponentType为SIGN_SIGNATURE类型可以控制签署方式
	// {“ComponentTypeLimit”: [“xxx”]}
	// xxx可以为:
	// HANDWRITE – 手写签名
	// BORDERLESS_ESIGN – 自动生成无边框腾讯体
	// OCR_ESIGN -- AI智能识别手写签名
	// ESIGN -- 个人印章类型
	// 如:{“ComponentTypeLimit”: [“BORDERLESS_ESIGN”]}
	ComponentExtra *string `json:"ComponentExtra,omitempty" name:"ComponentExtra"`

	// 控件填充vaule,ComponentType和传入值类型对应关系:
	// TEXT - 文本内容
	// MULTI_LINE_TEXT - 文本内容
	// CHECK_BOX - true/false
	// FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
	// SELECTOR - 选项值
	// DATE - 默认是格式化为xxxx年xx月xx日
	// DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
	// SIGN_SEAL - 印章ID
	// SIGN_PAGING_SEAL - 可以指定印章ID
	//
	// 控件值约束说明:
	// 企业全称控件:
	//   约束:企业名称中文字符中文括号
	//   检查正则表达式:/^[\u3400-\u4dbf\u4e00-\u9fa5()]+$/
	//
	// 统一社会信用代码控件:
	//   检查正则表达式:/^[A-Z0-9]{1,18}$/
	//
	// 法人名称控件:
	//   约束:最大50个字符,2到25个汉字或者1到50个字母
	//   检查正则表达式:/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/
	//
	// 签署意见控件:
	//   约束:签署意见最大长度为50字符
	//
	// 签署人手机号控件:
	//   约束:国内手机号 13,14,15,16,17,18,19号段长度11位
	//
	// 签署人身份证控件:
	//   约束:合法的身份证号码检查
	//
	// 控件名称:
	//   约束:控件名称最大长度为20字符
	//
	// 单行文本控件:
	//   约束:只允许输入中文,英文,数字,中英文标点符号
	//
	// 多行文本控件:
	//   约束:只允许输入中文,英文,数字,中英文标点符号
	//
	// 勾选框控件:
	//   约束:选择填字符串true,不选填字符串false
	//
	// 选择器控件:
	//   约束:同单行文本控件约束,填写选择值中的字符串
	//
	// 数字控件:
	//   约束:请输入有效的数字(可带小数点)
	//   检查正则表达式:/^(-|\+)?\d+(\.\d+)?$/
	//
	// 日期控件:
	//   约束:格式:yyyy年mm月dd日
	//
	// 附件控件:
	//   约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件
	//
	// 图片控件:
	//   约束:JPG或PNG图片,填写上传的图片资源ID
	//
	// 邮箱控件:
	//   约束:请输入有效的邮箱地址, w3c标准
	//   检查正则表达式:/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/
	//   参考:https://emailregex.com/
	//
	// 地址控件:
	//   同单行文本控件约束
	//
	// 省市区控件:
	//   同单行文本控件约束
	//
	// 性别控件:
	//   同单行文本控件约束,填写选择值中的字符串
	//
	// 学历控件:
	//   同单行文本控件约束,填写选择值中的字符串
	ComponentValue *string `json:"ComponentValue,omitempty" name:"ComponentValue"`

	// 日期签署控件的字号,默认为 12
	//
	// 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
	ComponentDateFontSize *int64 `json:"ComponentDateFontSize,omitempty" name:"ComponentDateFontSize"`

	// 控件所属文档的Id, 模块相关接口为空值
	DocumentId *string `json:"DocumentId,omitempty" name:"DocumentId"`

	// 控件描述,不能超过30个字符
	ComponentDescription *string `json:"ComponentDescription,omitempty" name:"ComponentDescription"`

	// 指定关键字时横坐标偏移量,单位pt
	OffsetX *float64 `json:"OffsetX,omitempty" name:"OffsetX"`

	// 指定关键字时纵坐标偏移量,单位pt
	OffsetY *float64 `json:"OffsetY,omitempty" name:"OffsetY"`

	// 渠道控件ID。
	// 如果不为空,属于渠道预设控件;
	ChannelComponentId *string `json:"ChannelComponentId,omitempty" name:"ChannelComponentId"`

	// 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
	// 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
	KeywordOrder *string `json:"KeywordOrder,omitempty" name:"KeywordOrder"`

	// 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
	KeywordPage *int64 `json:"KeywordPage,omitempty" name:"KeywordPage"`

	// 关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
	RelativeLocation *string `json:"RelativeLocation,omitempty" name:"RelativeLocation"`

	// 关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。
	KeywordIndexes []*int64 `json:"KeywordIndexes,omitempty" name:"KeywordIndexes"`
}

type CreateChannelFlowEvidenceReportRequest added in v1.0.485

type CreateChannelFlowEvidenceReportRequest struct {
	*tchttp.BaseRequest

	// 签署流程编号
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewCreateChannelFlowEvidenceReportRequest added in v1.0.485

func NewCreateChannelFlowEvidenceReportRequest() (request *CreateChannelFlowEvidenceReportRequest)

func (*CreateChannelFlowEvidenceReportRequest) FromJsonString added in v1.0.485

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateChannelFlowEvidenceReportRequest) ToJsonString added in v1.0.485

type CreateChannelFlowEvidenceReportRequestParams added in v1.0.485

type CreateChannelFlowEvidenceReportRequestParams struct {
	// 签署流程编号
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type CreateChannelFlowEvidenceReportResponse added in v1.0.485

type CreateChannelFlowEvidenceReportResponse struct {
	*tchttp.BaseResponse
	Response *CreateChannelFlowEvidenceReportResponseParams `json:"Response"`
}

func NewCreateChannelFlowEvidenceReportResponse added in v1.0.485

func NewCreateChannelFlowEvidenceReportResponse() (response *CreateChannelFlowEvidenceReportResponse)

func (*CreateChannelFlowEvidenceReportResponse) FromJsonString added in v1.0.485

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateChannelFlowEvidenceReportResponse) ToJsonString added in v1.0.485

type CreateChannelFlowEvidenceReportResponseParams added in v1.0.485

type CreateChannelFlowEvidenceReportResponseParams struct {
	// 出证报告 ID,用于查询出证报告接口DescribeChannelFlowEvidenceReport时用到
	// 注意:此字段可能返回 null,表示取不到有效值。
	ReportId *string `json:"ReportId,omitempty" name:"ReportId"`

	// 执行中:EvidenceStatusExecuting
	// 成功:EvidenceStatusSuccess
	// 失败:EvidenceStatusFailed
	Status *string `json:"Status,omitempty" name:"Status"`

	// 废除,字段无效
	// 注意:此字段可能返回 null,表示取不到有效值。
	ReportUrl *string `json:"ReportUrl,omitempty" name:"ReportUrl"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateConsoleLoginUrlRequest

type CreateConsoleLoginUrlRequest struct {
	*tchttp.BaseRequest

	// 应用信息
	// 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 渠道子客企业名称,最大长度64个字符
	ProxyOrganizationName *string `json:"ProxyOrganizationName,omitempty" name:"ProxyOrganizationName"`

	// 渠道子客企业经办人的姓名,最大长度50个字符
	ProxyOperatorName *string `json:"ProxyOperatorName,omitempty" name:"ProxyOperatorName"`

	// PC控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"。 EndPoint为"CHANNEL"/"APP"只支持"SEAL"-印章管理
	Module *string `json:"Module,omitempty" name:"Module"`

	// 控制台指定模块Id
	ModuleId *string `json:"ModuleId,omitempty" name:"ModuleId"`

	// 渠道子客企业统一社会信用代码,最大长度200个字符
	UniformSocialCreditCode *string `json:"UniformSocialCreditCode,omitempty" name:"UniformSocialCreditCode"`

	// 是否展示左侧菜单栏 是:ENABLE(默认) 否:DISABLE
	MenuStatus *string `json:"MenuStatus,omitempty" name:"MenuStatus"`

	// 链接跳转类型:"PC"-PC控制台,“CHANNEL”-H5跳转到电子签小程序;“APP”-第三方APP或小程序跳转电子签小程序,默认为PC控制台
	Endpoint *string `json:"Endpoint,omitempty" name:"Endpoint"`

	// 触发自动跳转事件,仅对App类型有效,"VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
	AutoJumpBackEvent *string `json:"AutoJumpBackEvent,omitempty" name:"AutoJumpBackEvent"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 支持的授权方式,授权方式: "1" - 上传授权书认证  "2" - 法定代表人认证
	AuthorizationTypes []*int64 `json:"AuthorizationTypes,omitempty" name:"AuthorizationTypes"`
}

func NewCreateConsoleLoginUrlRequest

func NewCreateConsoleLoginUrlRequest() (request *CreateConsoleLoginUrlRequest)

func (*CreateConsoleLoginUrlRequest) FromJsonString

func (r *CreateConsoleLoginUrlRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateConsoleLoginUrlRequest) ToJsonString

func (r *CreateConsoleLoginUrlRequest) ToJsonString() string

type CreateConsoleLoginUrlRequestParams added in v1.0.426

type CreateConsoleLoginUrlRequestParams struct {
	// 应用信息
	// 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 渠道子客企业名称,最大长度64个字符
	ProxyOrganizationName *string `json:"ProxyOrganizationName,omitempty" name:"ProxyOrganizationName"`

	// 渠道子客企业经办人的姓名,最大长度50个字符
	ProxyOperatorName *string `json:"ProxyOperatorName,omitempty" name:"ProxyOperatorName"`

	// PC控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"。 EndPoint为"CHANNEL"/"APP"只支持"SEAL"-印章管理
	Module *string `json:"Module,omitempty" name:"Module"`

	// 控制台指定模块Id
	ModuleId *string `json:"ModuleId,omitempty" name:"ModuleId"`

	// 渠道子客企业统一社会信用代码,最大长度200个字符
	UniformSocialCreditCode *string `json:"UniformSocialCreditCode,omitempty" name:"UniformSocialCreditCode"`

	// 是否展示左侧菜单栏 是:ENABLE(默认) 否:DISABLE
	MenuStatus *string `json:"MenuStatus,omitempty" name:"MenuStatus"`

	// 链接跳转类型:"PC"-PC控制台,“CHANNEL”-H5跳转到电子签小程序;“APP”-第三方APP或小程序跳转电子签小程序,默认为PC控制台
	Endpoint *string `json:"Endpoint,omitempty" name:"Endpoint"`

	// 触发自动跳转事件,仅对App类型有效,"VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
	AutoJumpBackEvent *string `json:"AutoJumpBackEvent,omitempty" name:"AutoJumpBackEvent"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 支持的授权方式,授权方式: "1" - 上传授权书认证  "2" - 法定代表人认证
	AuthorizationTypes []*int64 `json:"AuthorizationTypes,omitempty" name:"AuthorizationTypes"`
}

Predefined struct for user

type CreateConsoleLoginUrlResponse

type CreateConsoleLoginUrlResponse struct {
	*tchttp.BaseResponse
	Response *CreateConsoleLoginUrlResponseParams `json:"Response"`
}

func NewCreateConsoleLoginUrlResponse

func NewCreateConsoleLoginUrlResponse() (response *CreateConsoleLoginUrlResponse)

func (*CreateConsoleLoginUrlResponse) FromJsonString

func (r *CreateConsoleLoginUrlResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateConsoleLoginUrlResponse) ToJsonString

func (r *CreateConsoleLoginUrlResponse) ToJsonString() string

type CreateConsoleLoginUrlResponseParams added in v1.0.426

type CreateConsoleLoginUrlResponseParams struct {
	// 子客Web控制台url注意事项:
	// 1. 所有类型的链接在企业未认证/员工未认证完成时,只要在有效期内(一年)都可以访问
	// 2. 若企业认证完成且员工认证完成后,重新获取pc端的链接5分钟之内有效,且只能访问一次
	// 3. 若企业认证完成且员工认证完成后,重新获取H5/APP的链接只要在有效期内(一年)都可以访问
	// 4. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接)
	// 5. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
	ConsoleUrl *string `json:"ConsoleUrl,omitempty" name:"ConsoleUrl"`

	// 渠道子客企业是否已开通腾讯电子签
	IsActivated *bool `json:"IsActivated,omitempty" name:"IsActivated"`

	// 当前经办人是否已认证(false:未认证 true:已认证)
	ProxyOperatorIsVerified *bool `json:"ProxyOperatorIsVerified,omitempty" name:"ProxyOperatorIsVerified"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateFlowsByTemplatesRequest

type CreateFlowsByTemplatesRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 多个合同(签署流程)信息,最多支持20个
	FlowInfos []*FlowInfo `json:"FlowInfos,omitempty" name:"FlowInfos"`

	// 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls;
	// 预览链接有效期300秒;
	// 同时,如果预览的文件中指定了动态表格控件,需要进行异步合成;此时此接口返回的是合成前的文档预览链接,而合成完成后的文档预览链接会通过:回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询;
	NeedPreview *bool `json:"NeedPreview,omitempty" name:"NeedPreview"`

	// 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
	PreviewType *int64 `json:"PreviewType,omitempty" name:"PreviewType"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewCreateFlowsByTemplatesRequest

func NewCreateFlowsByTemplatesRequest() (request *CreateFlowsByTemplatesRequest)

func (*CreateFlowsByTemplatesRequest) FromJsonString

func (r *CreateFlowsByTemplatesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateFlowsByTemplatesRequest) ToJsonString

func (r *CreateFlowsByTemplatesRequest) ToJsonString() string

type CreateFlowsByTemplatesRequestParams added in v1.0.426

type CreateFlowsByTemplatesRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 多个合同(签署流程)信息,最多支持20个
	FlowInfos []*FlowInfo `json:"FlowInfos,omitempty" name:"FlowInfos"`

	// 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls;
	// 预览链接有效期300秒;
	// 同时,如果预览的文件中指定了动态表格控件,需要进行异步合成;此时此接口返回的是合成前的文档预览链接,而合成完成后的文档预览链接会通过:回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询;
	NeedPreview *bool `json:"NeedPreview,omitempty" name:"NeedPreview"`

	// 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
	PreviewType *int64 `json:"PreviewType,omitempty" name:"PreviewType"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type CreateFlowsByTemplatesResponse

type CreateFlowsByTemplatesResponse struct {
	*tchttp.BaseResponse
	Response *CreateFlowsByTemplatesResponseParams `json:"Response"`
}

func NewCreateFlowsByTemplatesResponse

func NewCreateFlowsByTemplatesResponse() (response *CreateFlowsByTemplatesResponse)

func (*CreateFlowsByTemplatesResponse) FromJsonString

func (r *CreateFlowsByTemplatesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateFlowsByTemplatesResponse) ToJsonString

func (r *CreateFlowsByTemplatesResponse) ToJsonString() string

type CreateFlowsByTemplatesResponseParams added in v1.0.426

type CreateFlowsByTemplatesResponseParams struct {
	// 多个合同ID
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 渠道的业务信息,限制1024字符
	CustomerData []*string `json:"CustomerData,omitempty" name:"CustomerData"`

	// 创建消息,对应多个合同ID,
	// 成功为“”,创建失败则对应失败消息
	ErrorMessages []*string `json:"ErrorMessages,omitempty" name:"ErrorMessages"`

	// 预览模式下返回的预览文件url数组
	PreviewUrls []*string `json:"PreviewUrls,omitempty" name:"PreviewUrls"`

	// 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
	// 如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
	TaskInfos []*TaskInfo `json:"TaskInfos,omitempty" name:"TaskInfos"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateSealByImageRequest added in v1.0.390

type CreateSealByImageRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 印章名称,最大长度不超过50字符
	SealName *string `json:"SealName,omitempty" name:"SealName"`

	// 印章图片base64,大小不超过10M(原始图片不超过7.6M)
	SealImage *string `json:"SealImage,omitempty" name:"SealImage"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewCreateSealByImageRequest added in v1.0.390

func NewCreateSealByImageRequest() (request *CreateSealByImageRequest)

func (*CreateSealByImageRequest) FromJsonString added in v1.0.390

func (r *CreateSealByImageRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateSealByImageRequest) ToJsonString added in v1.0.390

func (r *CreateSealByImageRequest) ToJsonString() string

type CreateSealByImageRequestParams added in v1.0.426

type CreateSealByImageRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 印章名称,最大长度不超过50字符
	SealName *string `json:"SealName,omitempty" name:"SealName"`

	// 印章图片base64,大小不超过10M(原始图片不超过7.6M)
	SealImage *string `json:"SealImage,omitempty" name:"SealImage"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type CreateSealByImageResponse added in v1.0.390

type CreateSealByImageResponse struct {
	*tchttp.BaseResponse
	Response *CreateSealByImageResponseParams `json:"Response"`
}

func NewCreateSealByImageResponse added in v1.0.390

func NewCreateSealByImageResponse() (response *CreateSealByImageResponse)

func (*CreateSealByImageResponse) FromJsonString added in v1.0.390

func (r *CreateSealByImageResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateSealByImageResponse) ToJsonString added in v1.0.390

func (r *CreateSealByImageResponse) ToJsonString() string

type CreateSealByImageResponseParams added in v1.0.426

type CreateSealByImageResponseParams struct {
	// 印章id
	SealId *string `json:"SealId,omitempty" name:"SealId"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateSignUrlsRequest

type CreateSignUrlsRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署流程编号数组,最多支持100个。(备注:该参数和合同组编号必须二选一)
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
	FlowGroupId *string `json:"FlowGroupId,omitempty" name:"FlowGroupId"`

	// 签署链接类型:“WEIXINAPP”-短链直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;"LONGURL2WEIXINAPP"-长链接跳转小程序;默认“WEIXINAPP”类型,即跳转至小程序;
	Endpoint *string `json:"Endpoint,omitempty" name:"Endpoint"`

	// 签署链接生成类型,默认是 "ALL";
	// "ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
	// "CHANNEL":渠道合作企业;
	// "NOT_CHANNEL":非渠道合作企业;
	// "PERSON":个人;
	// "FOLLOWER":关注方,目前是合同抄送方;
	GenerateType *string `json:"GenerateType,omitempty" name:"GenerateType"`

	// 非渠道合作企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
	OrganizationName *string `json:"OrganizationName,omitempty" name:"OrganizationName"`

	// 参与人姓名,GenerateType为"PERSON"时必填
	Name *string `json:"Name,omitempty" name:"Name"`

	// 参与人手机号;
	// GenerateType为"PERSON"或"FOLLOWER"时必填
	Mobile *string `json:"Mobile,omitempty" name:"Mobile"`

	// 渠道合作企业的企业Id,GenerateType为"CHANNEL"时必填
	OrganizationOpenId *string `json:"OrganizationOpenId,omitempty" name:"OrganizationOpenId"`

	// 渠道合作企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人
	OpenId *string `json:"OpenId,omitempty" name:"OpenId"`

	// Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
	AutoJumpBack *bool `json:"AutoJumpBack,omitempty" name:"AutoJumpBack"`

	// 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
	JumpUrl *string `json:"JumpUrl,omitempty" name:"JumpUrl"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewCreateSignUrlsRequest

func NewCreateSignUrlsRequest() (request *CreateSignUrlsRequest)

func (*CreateSignUrlsRequest) FromJsonString

func (r *CreateSignUrlsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateSignUrlsRequest) ToJsonString

func (r *CreateSignUrlsRequest) ToJsonString() string

type CreateSignUrlsRequestParams added in v1.0.426

type CreateSignUrlsRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 签署流程编号数组,最多支持100个。(备注:该参数和合同组编号必须二选一)
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
	FlowGroupId *string `json:"FlowGroupId,omitempty" name:"FlowGroupId"`

	// 签署链接类型:“WEIXINAPP”-短链直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;"LONGURL2WEIXINAPP"-长链接跳转小程序;默认“WEIXINAPP”类型,即跳转至小程序;
	Endpoint *string `json:"Endpoint,omitempty" name:"Endpoint"`

	// 签署链接生成类型,默认是 "ALL";
	// "ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
	// "CHANNEL":渠道合作企业;
	// "NOT_CHANNEL":非渠道合作企业;
	// "PERSON":个人;
	// "FOLLOWER":关注方,目前是合同抄送方;
	GenerateType *string `json:"GenerateType,omitempty" name:"GenerateType"`

	// 非渠道合作企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
	OrganizationName *string `json:"OrganizationName,omitempty" name:"OrganizationName"`

	// 参与人姓名,GenerateType为"PERSON"时必填
	Name *string `json:"Name,omitempty" name:"Name"`

	// 参与人手机号;
	// GenerateType为"PERSON"或"FOLLOWER"时必填
	Mobile *string `json:"Mobile,omitempty" name:"Mobile"`

	// 渠道合作企业的企业Id,GenerateType为"CHANNEL"时必填
	OrganizationOpenId *string `json:"OrganizationOpenId,omitempty" name:"OrganizationOpenId"`

	// 渠道合作企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人
	OpenId *string `json:"OpenId,omitempty" name:"OpenId"`

	// Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
	AutoJumpBack *bool `json:"AutoJumpBack,omitempty" name:"AutoJumpBack"`

	// 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
	JumpUrl *string `json:"JumpUrl,omitempty" name:"JumpUrl"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type CreateSignUrlsResponse

type CreateSignUrlsResponse struct {
	*tchttp.BaseResponse
	Response *CreateSignUrlsResponseParams `json:"Response"`
}

func NewCreateSignUrlsResponse

func NewCreateSignUrlsResponse() (response *CreateSignUrlsResponse)

func (*CreateSignUrlsResponse) FromJsonString

func (r *CreateSignUrlsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateSignUrlsResponse) ToJsonString

func (r *CreateSignUrlsResponse) ToJsonString() string

type CreateSignUrlsResponseParams added in v1.0.426

type CreateSignUrlsResponseParams struct {
	// 签署参与者签署H5链接信息数组
	SignUrlInfos []*SignUrlInfo `json:"SignUrlInfos,omitempty" name:"SignUrlInfos"`

	// 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
	ErrorMessages []*string `json:"ErrorMessages,omitempty" name:"ErrorMessages"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type Department added in v1.0.508

type Department struct {
	// 部门id
	// 注意:此字段可能返回 null,表示取不到有效值。
	DepartmentId *string `json:"DepartmentId,omitempty" name:"DepartmentId"`

	// 部门名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	DepartmentName *string `json:"DepartmentName,omitempty" name:"DepartmentName"`
}

type DescribeChannelFlowEvidenceReportRequest added in v1.0.546

type DescribeChannelFlowEvidenceReportRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 出证报告编号
	ReportId *string `json:"ReportId,omitempty" name:"ReportId"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewDescribeChannelFlowEvidenceReportRequest added in v1.0.546

func NewDescribeChannelFlowEvidenceReportRequest() (request *DescribeChannelFlowEvidenceReportRequest)

func (*DescribeChannelFlowEvidenceReportRequest) FromJsonString added in v1.0.546

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeChannelFlowEvidenceReportRequest) ToJsonString added in v1.0.546

type DescribeChannelFlowEvidenceReportRequestParams added in v1.0.546

type DescribeChannelFlowEvidenceReportRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 出证报告编号
	ReportId *string `json:"ReportId,omitempty" name:"ReportId"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type DescribeChannelFlowEvidenceReportResponse added in v1.0.546

type DescribeChannelFlowEvidenceReportResponse struct {
	*tchttp.BaseResponse
	Response *DescribeChannelFlowEvidenceReportResponseParams `json:"Response"`
}

func NewDescribeChannelFlowEvidenceReportResponse added in v1.0.546

func NewDescribeChannelFlowEvidenceReportResponse() (response *DescribeChannelFlowEvidenceReportResponse)

func (*DescribeChannelFlowEvidenceReportResponse) FromJsonString added in v1.0.546

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeChannelFlowEvidenceReportResponse) ToJsonString added in v1.0.546

type DescribeChannelFlowEvidenceReportResponseParams added in v1.0.546

type DescribeChannelFlowEvidenceReportResponseParams struct {
	// 出证报告 URL
	// 注意:此字段可能返回 null,表示取不到有效值。
	ReportUrl *string `json:"ReportUrl,omitempty" name:"ReportUrl"`

	// 执行中:EvidenceStatusExecuting
	// 成功:EvidenceStatusSuccess
	// 失败:EvidenceStatusFailed
	Status *string `json:"Status,omitempty" name:"Status"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeExtendedServiceAuthInfoRequest added in v1.0.578

type DescribeExtendedServiceAuthInfoRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
	//
	// 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`
}

func NewDescribeExtendedServiceAuthInfoRequest added in v1.0.578

func NewDescribeExtendedServiceAuthInfoRequest() (request *DescribeExtendedServiceAuthInfoRequest)

func (*DescribeExtendedServiceAuthInfoRequest) FromJsonString added in v1.0.578

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeExtendedServiceAuthInfoRequest) ToJsonString added in v1.0.578

type DescribeExtendedServiceAuthInfoRequestParams added in v1.0.578

type DescribeExtendedServiceAuthInfoRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
	//
	// 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`
}

Predefined struct for user

type DescribeExtendedServiceAuthInfoResponse added in v1.0.578

type DescribeExtendedServiceAuthInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeExtendedServiceAuthInfoResponseParams `json:"Response"`
}

func NewDescribeExtendedServiceAuthInfoResponse added in v1.0.578

func NewDescribeExtendedServiceAuthInfoResponse() (response *DescribeExtendedServiceAuthInfoResponse)

func (*DescribeExtendedServiceAuthInfoResponse) FromJsonString added in v1.0.578

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeExtendedServiceAuthInfoResponse) ToJsonString added in v1.0.578

type DescribeExtendedServiceAuthInfoResponseParams added in v1.0.578

type DescribeExtendedServiceAuthInfoResponseParams struct {
	// 企业扩展服务授权信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	AuthInfo []*ExtentServiceAuthInfo `json:"AuthInfo,omitempty" name:"AuthInfo"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeFlowDetailInfoRequest added in v1.0.319

type DescribeFlowDetailInfoRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 合同(流程)编号数组,最多支持100个。
	// (备注:该参数和合同组编号必须二选一)
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
	FlowGroupId *string `json:"FlowGroupId,omitempty" name:"FlowGroupId"`
}

func NewDescribeFlowDetailInfoRequest added in v1.0.319

func NewDescribeFlowDetailInfoRequest() (request *DescribeFlowDetailInfoRequest)

func (*DescribeFlowDetailInfoRequest) FromJsonString added in v1.0.319

func (r *DescribeFlowDetailInfoRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeFlowDetailInfoRequest) ToJsonString added in v1.0.319

func (r *DescribeFlowDetailInfoRequest) ToJsonString() string

type DescribeFlowDetailInfoRequestParams added in v1.0.426

type DescribeFlowDetailInfoRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 合同(流程)编号数组,最多支持100个。
	// (备注:该参数和合同组编号必须二选一)
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
	FlowGroupId *string `json:"FlowGroupId,omitempty" name:"FlowGroupId"`
}

Predefined struct for user

type DescribeFlowDetailInfoResponse added in v1.0.319

type DescribeFlowDetailInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeFlowDetailInfoResponseParams `json:"Response"`
}

func NewDescribeFlowDetailInfoResponse added in v1.0.319

func NewDescribeFlowDetailInfoResponse() (response *DescribeFlowDetailInfoResponse)

func (*DescribeFlowDetailInfoResponse) FromJsonString added in v1.0.319

func (r *DescribeFlowDetailInfoResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeFlowDetailInfoResponse) ToJsonString added in v1.0.319

func (r *DescribeFlowDetailInfoResponse) ToJsonString() string

type DescribeFlowDetailInfoResponseParams added in v1.0.426

type DescribeFlowDetailInfoResponseParams struct {
	// 渠道侧应用号Id
	ApplicationId *string `json:"ApplicationId,omitempty" name:"ApplicationId"`

	// 渠道侧企业第三方Id
	ProxyOrganizationOpenId *string `json:"ProxyOrganizationOpenId,omitempty" name:"ProxyOrganizationOpenId"`

	// 合同(签署流程)的具体详细描述信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowInfo []*FlowDetailInfo `json:"FlowInfo,omitempty" name:"FlowInfo"`

	// 合同组编号
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowGroupId *string `json:"FlowGroupId,omitempty" name:"FlowGroupId"`

	// 合同组名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowGroupName *string `json:"FlowGroupName,omitempty" name:"FlowGroupName"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeResourceUrlsByFlowsRequest added in v1.0.274

type DescribeResourceUrlsByFlowsRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。
	// 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 查询资源所对应的签署流程Id,最多支持50个
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewDescribeResourceUrlsByFlowsRequest added in v1.0.274

func NewDescribeResourceUrlsByFlowsRequest() (request *DescribeResourceUrlsByFlowsRequest)

func (*DescribeResourceUrlsByFlowsRequest) FromJsonString added in v1.0.274

func (r *DescribeResourceUrlsByFlowsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeResourceUrlsByFlowsRequest) ToJsonString added in v1.0.274

func (r *DescribeResourceUrlsByFlowsRequest) ToJsonString() string

type DescribeResourceUrlsByFlowsRequestParams added in v1.0.426

type DescribeResourceUrlsByFlowsRequestParams struct {
	// 渠道应用相关信息。
	// 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 查询资源所对应的签署流程Id,最多支持50个
	FlowIds []*string `json:"FlowIds,omitempty" name:"FlowIds"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type DescribeResourceUrlsByFlowsResponse added in v1.0.274

type DescribeResourceUrlsByFlowsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeResourceUrlsByFlowsResponseParams `json:"Response"`
}

func NewDescribeResourceUrlsByFlowsResponse added in v1.0.274

func NewDescribeResourceUrlsByFlowsResponse() (response *DescribeResourceUrlsByFlowsResponse)

func (*DescribeResourceUrlsByFlowsResponse) FromJsonString added in v1.0.274

func (r *DescribeResourceUrlsByFlowsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeResourceUrlsByFlowsResponse) ToJsonString added in v1.0.274

func (r *DescribeResourceUrlsByFlowsResponse) ToJsonString() string

type DescribeResourceUrlsByFlowsResponseParams added in v1.0.426

type DescribeResourceUrlsByFlowsResponseParams struct {
	// 签署流程资源对应链接信息
	FlowResourceUrlInfos []*FlowResourceUrlInfo `json:"FlowResourceUrlInfos,omitempty" name:"FlowResourceUrlInfos"`

	// 创建消息,对应多个合同ID,
	// 成功为“”,创建失败则对应失败消息
	ErrorMessages []*string `json:"ErrorMessages,omitempty" name:"ErrorMessages"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeTemplatesRequest

type DescribeTemplatesRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 模板唯一标识,查询单个模板时使用
	TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`

	// 查询内容:0-模板列表及详情(默认),1-仅模板列表
	ContentType *int64 `json:"ContentType,omitempty" name:"ContentType"`

	// 查询个数,默认20,最大100;在查询列表的时候有效
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 查询偏移位置,默认0;在查询列表的时候有效
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// 是否返回所有组件信息。默认false,只返回发起方控件;true,返回所有签署方控件
	QueryAllComponents *bool `json:"QueryAllComponents,omitempty" name:"QueryAllComponents"`

	// 模糊搜索模板名称,最大长度200
	TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 是否获取模板预览链接
	WithPreviewUrl *bool `json:"WithPreviewUrl,omitempty" name:"WithPreviewUrl"`

	// 是否获取模板的PDF文件链接-渠道版需要开启白名单时才能使用。
	WithPdfUrl *bool `json:"WithPdfUrl,omitempty" name:"WithPdfUrl"`

	// 渠道模板ID
	ChannelTemplateId *string `json:"ChannelTemplateId,omitempty" name:"ChannelTemplateId"`
}

func NewDescribeTemplatesRequest

func NewDescribeTemplatesRequest() (request *DescribeTemplatesRequest)

func (*DescribeTemplatesRequest) FromJsonString

func (r *DescribeTemplatesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTemplatesRequest) ToJsonString

func (r *DescribeTemplatesRequest) ToJsonString() string

type DescribeTemplatesRequestParams added in v1.0.426

type DescribeTemplatesRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 模板唯一标识,查询单个模板时使用
	TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`

	// 查询内容:0-模板列表及详情(默认),1-仅模板列表
	ContentType *int64 `json:"ContentType,omitempty" name:"ContentType"`

	// 查询个数,默认20,最大100;在查询列表的时候有效
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 查询偏移位置,默认0;在查询列表的时候有效
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// 是否返回所有组件信息。默认false,只返回发起方控件;true,返回所有签署方控件
	QueryAllComponents *bool `json:"QueryAllComponents,omitempty" name:"QueryAllComponents"`

	// 模糊搜索模板名称,最大长度200
	TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`

	// 是否获取模板预览链接
	WithPreviewUrl *bool `json:"WithPreviewUrl,omitempty" name:"WithPreviewUrl"`

	// 是否获取模板的PDF文件链接-渠道版需要开启白名单时才能使用。
	WithPdfUrl *bool `json:"WithPdfUrl,omitempty" name:"WithPdfUrl"`

	// 渠道模板ID
	ChannelTemplateId *string `json:"ChannelTemplateId,omitempty" name:"ChannelTemplateId"`
}

Predefined struct for user

type DescribeTemplatesResponse

type DescribeTemplatesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTemplatesResponseParams `json:"Response"`
}

func NewDescribeTemplatesResponse

func NewDescribeTemplatesResponse() (response *DescribeTemplatesResponse)

func (*DescribeTemplatesResponse) FromJsonString

func (r *DescribeTemplatesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTemplatesResponse) ToJsonString

func (r *DescribeTemplatesResponse) ToJsonString() string

type DescribeTemplatesResponseParams added in v1.0.426

type DescribeTemplatesResponseParams struct {
	// 模板详情
	Templates []*TemplateInfo `json:"Templates,omitempty" name:"Templates"`

	// 查询总数
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// 查询数量
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 查询起始偏移
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUsageRequest

type DescribeUsageRequest struct {
	*tchttp.BaseRequest

	// 应用信息,此接口Agent.AppId必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 开始时间,例如:2021-03-21
	StartDate *string `json:"StartDate,omitempty" name:"StartDate"`

	// 结束时间,例如:2021-06-21;
	// 开始时间到结束时间的区间长度小于等于90天。
	EndDate *string `json:"EndDate,omitempty" name:"EndDate"`

	// 是否汇总数据,默认不汇总。
	// 不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数;
	// 汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据;
	NeedAggregate *bool `json:"NeedAggregate,omitempty" name:"NeedAggregate"`

	// 单次返回的最多条目数量。默认为1000,且不能超过1000。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 偏移量,默认是0。
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewDescribeUsageRequest

func NewDescribeUsageRequest() (request *DescribeUsageRequest)

func (*DescribeUsageRequest) FromJsonString

func (r *DescribeUsageRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUsageRequest) ToJsonString

func (r *DescribeUsageRequest) ToJsonString() string

type DescribeUsageRequestParams added in v1.0.426

type DescribeUsageRequestParams struct {
	// 应用信息,此接口Agent.AppId必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 开始时间,例如:2021-03-21
	StartDate *string `json:"StartDate,omitempty" name:"StartDate"`

	// 结束时间,例如:2021-06-21;
	// 开始时间到结束时间的区间长度小于等于90天。
	EndDate *string `json:"EndDate,omitempty" name:"EndDate"`

	// 是否汇总数据,默认不汇总。
	// 不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数;
	// 汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据;
	NeedAggregate *bool `json:"NeedAggregate,omitempty" name:"NeedAggregate"`

	// 单次返回的最多条目数量。默认为1000,且不能超过1000。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 偏移量,默认是0。
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type DescribeUsageResponse

type DescribeUsageResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUsageResponseParams `json:"Response"`
}

func NewDescribeUsageResponse

func NewDescribeUsageResponse() (response *DescribeUsageResponse)

func (*DescribeUsageResponse) FromJsonString

func (r *DescribeUsageResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUsageResponse) ToJsonString

func (r *DescribeUsageResponse) ToJsonString() string

type DescribeUsageResponseParams added in v1.0.426

type DescribeUsageResponseParams struct {
	// 用量明细条数
	Total *uint64 `json:"Total,omitempty" name:"Total"`

	// 用量明细
	// 注意:此字段可能返回 null,表示取不到有效值。
	Details []*UsageDetail `json:"Details,omitempty" name:"Details"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DownloadFlowInfo added in v1.0.317

type DownloadFlowInfo struct {
	// 文件夹名称
	FileName *string `json:"FileName,omitempty" name:"FileName"`

	// 签署流程的标识数组
	FlowIdList []*string `json:"FlowIdList,omitempty" name:"FlowIdList"`
}

type ExtentServiceAuthInfo added in v1.0.578

type ExtentServiceAuthInfo struct {
	// 扩展服务类型
	//   AUTO_SIGN             企业静默签(自动签署)
	//   OVERSEA_SIGN          企业与港澳台居民*签署合同
	//   MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
	//   PAGING_SEAL           骑缝章
	//   DOWNLOAD_FLOW         授权渠道下载合同
	Type *string `json:"Type,omitempty" name:"Type"`

	// 扩展服务名称
	Name *string `json:"Name,omitempty" name:"Name"`

	// 服务状态
	// ENABLE 开启
	// DISABLE 关闭
	Status *string `json:"Status,omitempty" name:"Status"`

	// 最近操作人openid(经办人openid)
	// 注意:此字段可能返回 null,表示取不到有效值。
	OperatorOpenId *string `json:"OperatorOpenId,omitempty" name:"OperatorOpenId"`

	// 最近操作时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	OperateOn *int64 `json:"OperateOn,omitempty" name:"OperateOn"`
}

type Filter added in v1.0.508

type Filter struct {
	// 查询过滤条件的Key
	Key *string `json:"Key,omitempty" name:"Key"`

	// 查询过滤条件的Value列表
	Values []*string `json:"Values,omitempty" name:"Values"`
}

type FlowApproverDetail added in v1.0.319

type FlowApproverDetail struct {
	// 模板配置时候的签署人id,与控件绑定
	ReceiptId *string `json:"ReceiptId,omitempty" name:"ReceiptId"`

	// 渠道侧企业的第三方id
	// 注意:此字段可能返回 null,表示取不到有效值。
	ProxyOrganizationOpenId *string `json:"ProxyOrganizationOpenId,omitempty" name:"ProxyOrganizationOpenId"`

	// 渠道侧企业操作人的第三方id
	ProxyOperatorOpenId *string `json:"ProxyOperatorOpenId,omitempty" name:"ProxyOperatorOpenId"`

	// 渠道侧企业名称
	ProxyOrganizationName *string `json:"ProxyOrganizationName,omitempty" name:"ProxyOrganizationName"`

	// 签署人手机号
	Mobile *string `json:"Mobile,omitempty" name:"Mobile"`

	// 签署人签署顺序
	SignOrder *int64 `json:"SignOrder,omitempty" name:"SignOrder"`

	// 签署人姓名
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApproveName *string `json:"ApproveName,omitempty" name:"ApproveName"`

	// 当前签署人的状态
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApproveStatus *string `json:"ApproveStatus,omitempty" name:"ApproveStatus"`

	// 签署人信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApproveMessage *string `json:"ApproveMessage,omitempty" name:"ApproveMessage"`

	// 签署人签署时间
	ApproveTime *int64 `json:"ApproveTime,omitempty" name:"ApproveTime"`

	// 参与者类型 (ORGANIZATION企业/PERSON个人)
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApproveType *string `json:"ApproveType,omitempty" name:"ApproveType"`
}

type FlowApproverInfo

type FlowApproverInfo struct {
	// 签署人姓名,最大长度50个字符
	Name *string `json:"Name,omitempty" name:"Name"`

	// 签署人身份证件类型
	// 1.ID_CARD 居民身份证
	// 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
	// 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
	IdCardType *string `json:"IdCardType,omitempty" name:"IdCardType"`

	// 签署人证件号
	IdCardNumber *string `json:"IdCardNumber,omitempty" name:"IdCardNumber"`

	// 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
	Mobile *string `json:"Mobile,omitempty" name:"Mobile"`

	// 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
	OrganizationName *string `json:"OrganizationName,omitempty" name:"OrganizationName"`

	// 指定签署人非渠道企业下员工,在ApproverType为ORGANIZATION时指定。
	// 默认为false,即签署人位于同一个渠道应用号下;
	NotChannelOrganization *bool `json:"NotChannelOrganization,omitempty" name:"NotChannelOrganization"`

	// 用户侧第三方id,最大长度64个字符
	// 当签署方为同一渠道下的员工时,该字段若不指定,则发起【待领取】的流程
	OpenId *string `json:"OpenId,omitempty" name:"OpenId"`

	// 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
	OrganizationOpenId *string `json:"OrganizationOpenId,omitempty" name:"OrganizationOpenId"`

	// 签署人类型
	// PERSON-个人/自然人;
	// PERSON_AUTO_SIGN-个人自动签(定制化场景下使用);
	// ORGANIZATION-企业(企业签署方或模板发起时的企业静默签);
	// ENTERPRISESERVER-企业静默签(文件发起时的企业静默签字)。
	ApproverType *string `json:"ApproverType,omitempty" name:"ApproverType"`

	// 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
	RecipientId *string `json:"RecipientId,omitempty" name:"RecipientId"`

	// 签署截止时间,默认一年
	Deadline *int64 `json:"Deadline,omitempty" name:"Deadline"`

	// 签署完回调url,最大长度1000个字符
	CallbackUrl *string `json:"CallbackUrl,omitempty" name:"CallbackUrl"`

	// 使用PDF文件直接发起合同时,签署人指定的签署控件
	SignComponents []*Component `json:"SignComponents,omitempty" name:"SignComponents"`

	// 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN(AI智慧手写签名)
	ComponentLimitType []*string `json:"ComponentLimitType,omitempty" name:"ComponentLimitType"`

	// 合同的强制预览时间:3~300s,未指定则按合同页数计算
	PreReadTime *int64 `json:"PreReadTime,omitempty" name:"PreReadTime"`

	// 签署完前端跳转的url,暂未使用
	JumpUrl *string `json:"JumpUrl,omitempty" name:"JumpUrl"`

	// 签署人个性化能力值
	ApproverOption *ApproverOption `json:"ApproverOption,omitempty" name:"ApproverOption"`

	// 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
	ApproverNeedSignReview *bool `json:"ApproverNeedSignReview,omitempty" name:"ApproverNeedSignReview"`
}

type FlowApproverUrlInfo added in v1.0.580

type FlowApproverUrlInfo struct {
	// 签署链接,注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
	SignUrl *string `json:"SignUrl,omitempty" name:"SignUrl"`

	// 签署人手机号
	Mobile *string `json:"Mobile,omitempty" name:"Mobile"`

	// 签署人姓名
	Name *string `json:"Name,omitempty" name:"Name"`

	// 签署人类型 PERSON-个人
	ApproverType *string `json:"ApproverType,omitempty" name:"ApproverType"`
}

type FlowDetailInfo added in v1.0.319

type FlowDetailInfo struct {
	// 合同(流程)的Id
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 合同(流程)的名字
	FlowName *string `json:"FlowName,omitempty" name:"FlowName"`

	// 合同(流程)的类型
	FlowType *string `json:"FlowType,omitempty" name:"FlowType"`

	// 合同(流程)的状态
	FlowStatus *string `json:"FlowStatus,omitempty" name:"FlowStatus"`

	// 合同(流程)的信息
	FlowMessage *string `json:"FlowMessage,omitempty" name:"FlowMessage"`

	// 合同(流程)的创建时间戳
	CreateOn *int64 `json:"CreateOn,omitempty" name:"CreateOn"`

	// 合同(流程)的签署截止时间戳
	DeadLine *int64 `json:"DeadLine,omitempty" name:"DeadLine"`

	// 用户自定义数据
	CustomData *string `json:"CustomData,omitempty" name:"CustomData"`

	// 合同(流程)的签署人数组
	FlowApproverInfos []*FlowApproverDetail `json:"FlowApproverInfos,omitempty" name:"FlowApproverInfos"`
}

type FlowFileInfo added in v1.0.494

type FlowFileInfo struct {
	// 签署文件资源Id列表,目前仅支持单个文件
	FileIds []*string `json:"FileIds,omitempty" name:"FileIds"`

	// 签署流程名称,长度不超过200个字符
	FlowName *string `json:"FlowName,omitempty" name:"FlowName"`

	// 签署流程签约方列表,最多不超过5个参与方
	FlowApprovers []*FlowApproverInfo `json:"FlowApprovers,omitempty" name:"FlowApprovers"`

	// 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
	Deadline *int64 `json:"Deadline,omitempty" name:"Deadline"`

	// 签署流程的描述,长度不超过1000个字符
	FlowDescription *string `json:"FlowDescription,omitempty" name:"FlowDescription"`

	// 签署流程的类型,长度不超过255个字符
	FlowType *string `json:"FlowType,omitempty" name:"FlowType"`

	// 签署流程回调地址,长度不超过255个字符
	CallbackUrl *string `json:"CallbackUrl,omitempty" name:"CallbackUrl"`

	// 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
	CustomerData *string `json:"CustomerData,omitempty" name:"CustomerData"`

	// 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
	Unordered *bool `json:"Unordered,omitempty" name:"Unordered"`

	// 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
	CustomShowMap *string `json:"CustomShowMap,omitempty" name:"CustomShowMap"`

	// 本企业(发起方企业)是否需要签署审批
	NeedSignReview *bool `json:"NeedSignReview,omitempty" name:"NeedSignReview"`
}

type FlowInfo

type FlowInfo struct {
	// 合同名字,最大长度200个字符
	FlowName *string `json:"FlowName,omitempty" name:"FlowName"`

	// 签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年
	Deadline *int64 `json:"Deadline,omitempty" name:"Deadline"`

	// 模板ID
	TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`

	// 多个签署人信息,最大支持50个签署方
	FlowApprovers []*FlowApproverInfo `json:"FlowApprovers,omitempty" name:"FlowApprovers"`

	// 表单K-V对列表
	FormFields []*FormField `json:"FormFields,omitempty" name:"FormFields"`

	// 回调地址,最大长度1000个字符
	CallbackUrl *string `json:"CallbackUrl,omitempty" name:"CallbackUrl"`

	// 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
	FlowType *string `json:"FlowType,omitempty" name:"FlowType"`

	// 合同描述,最大长度1000个字符
	FlowDescription *string `json:"FlowDescription,omitempty" name:"FlowDescription"`

	// 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
	CustomerData *string `json:"CustomerData,omitempty" name:"CustomerData"`

	// 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
	CustomShowMap *string `json:"CustomShowMap,omitempty" name:"CustomShowMap"`

	// 被抄送人的信息列表,抄送功能暂不开放
	CcInfos []*CcInfo `json:"CcInfos,omitempty" name:"CcInfos"`

	// 发起方企业的签署人进行签署操作是否需要企业内部审批。
	// 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
	//
	// 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
	NeedSignReview *bool `json:"NeedSignReview,omitempty" name:"NeedSignReview"`
}

type FlowResourceUrlInfo added in v1.0.274

type FlowResourceUrlInfo struct {
	// 流程对应Id
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 流程对应资源链接信息数组
	// 注意:此字段可能返回 null,表示取不到有效值。
	ResourceUrlInfos []*ResourceUrlInfo `json:"ResourceUrlInfos,omitempty" name:"ResourceUrlInfos"`
}

type FormField

type FormField struct {
	// 控件填充vaule,ComponentType和传入值类型对应关系:
	// TEXT - 文本内容
	// MULTI_LINE_TEXT - 文本内容
	// CHECK_BOX - true/false
	// FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
	// SELECTOR - 选项值
	// DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
	ComponentValue *string `json:"ComponentValue,omitempty" name:"ComponentValue"`

	// 表单域或控件的ID,跟ComponentName二选一,不能全为空;
	// CreateFlowsByTemplates 接口不使用此字段。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ComponentId *string `json:"ComponentId,omitempty" name:"ComponentId"`

	// 控件的名字,跟ComponentId二选一,不能全为空
	// 注意:此字段可能返回 null,表示取不到有效值。
	ComponentName *string `json:"ComponentName,omitempty" name:"ComponentName"`
}

type GetDownloadFlowUrlRequest added in v1.0.317

type GetDownloadFlowUrlRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
	DownLoadFlows []*DownloadFlowInfo `json:"DownLoadFlows,omitempty" name:"DownLoadFlows"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewGetDownloadFlowUrlRequest added in v1.0.317

func NewGetDownloadFlowUrlRequest() (request *GetDownloadFlowUrlRequest)

func (*GetDownloadFlowUrlRequest) FromJsonString added in v1.0.317

func (r *GetDownloadFlowUrlRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetDownloadFlowUrlRequest) ToJsonString added in v1.0.317

func (r *GetDownloadFlowUrlRequest) ToJsonString() string

type GetDownloadFlowUrlRequestParams added in v1.0.426

type GetDownloadFlowUrlRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
	DownLoadFlows []*DownloadFlowInfo `json:"DownLoadFlows,omitempty" name:"DownLoadFlows"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type GetDownloadFlowUrlResponse added in v1.0.317

type GetDownloadFlowUrlResponse struct {
	*tchttp.BaseResponse
	Response *GetDownloadFlowUrlResponseParams `json:"Response"`
}

func NewGetDownloadFlowUrlResponse added in v1.0.317

func NewGetDownloadFlowUrlResponse() (response *GetDownloadFlowUrlResponse)

func (*GetDownloadFlowUrlResponse) FromJsonString added in v1.0.317

func (r *GetDownloadFlowUrlResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetDownloadFlowUrlResponse) ToJsonString added in v1.0.317

func (r *GetDownloadFlowUrlResponse) ToJsonString() string

type GetDownloadFlowUrlResponseParams added in v1.0.426

type GetDownloadFlowUrlResponseParams struct {
	// 合同(流程)下载地址
	DownLoadUrl *string `json:"DownLoadUrl,omitempty" name:"DownLoadUrl"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyExtendedServiceRequest added in v1.0.578

type ModifyExtendedServiceRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	//
	// 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	//   扩展服务类型
	//   AUTO_SIGN             企业静默签(自动签署)
	//   OVERSEA_SIGN          企业与港澳台居民*签署合同
	//   MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
	//   PAGING_SEAL           骑缝章
	//   DOWNLOAD_FLOW         授权渠道下载合同
	ServiceType *string `json:"ServiceType,omitempty" name:"ServiceType"`

	// 操作类型
	// OPEN:开通
	// CLOSE:关闭
	Operate *string `json:"Operate,omitempty" name:"Operate"`
}

func NewModifyExtendedServiceRequest added in v1.0.578

func NewModifyExtendedServiceRequest() (request *ModifyExtendedServiceRequest)

func (*ModifyExtendedServiceRequest) FromJsonString added in v1.0.578

func (r *ModifyExtendedServiceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyExtendedServiceRequest) ToJsonString added in v1.0.578

func (r *ModifyExtendedServiceRequest) ToJsonString() string

type ModifyExtendedServiceRequestParams added in v1.0.578

type ModifyExtendedServiceRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	//
	// 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	//   扩展服务类型
	//   AUTO_SIGN             企业静默签(自动签署)
	//   OVERSEA_SIGN          企业与港澳台居民*签署合同
	//   MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
	//   PAGING_SEAL           骑缝章
	//   DOWNLOAD_FLOW         授权渠道下载合同
	ServiceType *string `json:"ServiceType,omitempty" name:"ServiceType"`

	// 操作类型
	// OPEN:开通
	// CLOSE:关闭
	Operate *string `json:"Operate,omitempty" name:"Operate"`
}

Predefined struct for user

type ModifyExtendedServiceResponse added in v1.0.578

type ModifyExtendedServiceResponse struct {
	*tchttp.BaseResponse
	Response *ModifyExtendedServiceResponseParams `json:"Response"`
}

func NewModifyExtendedServiceResponse added in v1.0.578

func NewModifyExtendedServiceResponse() (response *ModifyExtendedServiceResponse)

func (*ModifyExtendedServiceResponse) FromJsonString added in v1.0.578

func (r *ModifyExtendedServiceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyExtendedServiceResponse) ToJsonString added in v1.0.578

func (r *ModifyExtendedServiceResponse) ToJsonString() string

type ModifyExtendedServiceResponseParams added in v1.0.578

type ModifyExtendedServiceResponseParams struct {
	// 操作跳转链接,有效期24小时
	// 若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。
	//
	// 当操作类型是 OPEN 且 扩展服务类型是  AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
	// 返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作。
	OperateUrl *string `json:"OperateUrl,omitempty" name:"OperateUrl"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type OccupiedSeal added in v1.0.532

type OccupiedSeal struct {
	// 电子印章编号
	SealId *string `json:"SealId,omitempty" name:"SealId"`

	// 电子印章名称
	SealName *string `json:"SealName,omitempty" name:"SealName"`

	// 电子印章授权时间戳
	CreateOn *int64 `json:"CreateOn,omitempty" name:"CreateOn"`

	// 电子印章授权人
	Creator *string `json:"Creator,omitempty" name:"Creator"`

	// 电子印章策略Id
	SealPolicyId *string `json:"SealPolicyId,omitempty" name:"SealPolicyId"`

	// 印章状态,有以下六种:CHECKING(审核中)SUCCESS(已启用)FAIL(审核拒绝)CHECKING-SADM(待超管审核)DISABLE(已停用)STOPPED(已终止)
	SealStatus *string `json:"SealStatus,omitempty" name:"SealStatus"`

	// 审核失败原因
	// 注意:此字段可能返回 null,表示取不到有效值。
	FailReason *string `json:"FailReason,omitempty" name:"FailReason"`

	// 印章图片url,5分钟内有效
	Url *string `json:"Url,omitempty" name:"Url"`

	// 印章类型
	SealType *string `json:"SealType,omitempty" name:"SealType"`

	// 用印申请是否为永久授权
	IsAllTime *bool `json:"IsAllTime,omitempty" name:"IsAllTime"`

	// 授权人列表
	AuthorizedUsers []*AuthorizedUser `json:"AuthorizedUsers,omitempty" name:"AuthorizedUsers"`
}

type OperateChannelTemplateRequest added in v1.0.317

type OperateChannelTemplateRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
	OperateType *string `json:"OperateType,omitempty" name:"OperateType"`

	// 渠道方模板库模板唯一标识
	TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`

	// 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
	ProxyOrganizationOpenIds *string `json:"ProxyOrganizationOpenIds,omitempty" name:"ProxyOrganizationOpenIds"`

	// 模板可见性, 全部可见-"all", 部分可见-"part"
	AuthTag *string `json:"AuthTag,omitempty" name:"AuthTag"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewOperateChannelTemplateRequest added in v1.0.317

func NewOperateChannelTemplateRequest() (request *OperateChannelTemplateRequest)

func (*OperateChannelTemplateRequest) FromJsonString added in v1.0.317

func (r *OperateChannelTemplateRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*OperateChannelTemplateRequest) ToJsonString added in v1.0.317

func (r *OperateChannelTemplateRequest) ToJsonString() string

type OperateChannelTemplateRequestParams added in v1.0.426

type OperateChannelTemplateRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
	OperateType *string `json:"OperateType,omitempty" name:"OperateType"`

	// 渠道方模板库模板唯一标识
	TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`

	// 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
	ProxyOrganizationOpenIds *string `json:"ProxyOrganizationOpenIds,omitempty" name:"ProxyOrganizationOpenIds"`

	// 模板可见性, 全部可见-"all", 部分可见-"part"
	AuthTag *string `json:"AuthTag,omitempty" name:"AuthTag"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type OperateChannelTemplateResponse added in v1.0.317

type OperateChannelTemplateResponse struct {
	*tchttp.BaseResponse
	Response *OperateChannelTemplateResponseParams `json:"Response"`
}

func NewOperateChannelTemplateResponse added in v1.0.317

func NewOperateChannelTemplateResponse() (response *OperateChannelTemplateResponse)

func (*OperateChannelTemplateResponse) FromJsonString added in v1.0.317

func (r *OperateChannelTemplateResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*OperateChannelTemplateResponse) ToJsonString added in v1.0.317

func (r *OperateChannelTemplateResponse) ToJsonString() string

type OperateChannelTemplateResponseParams added in v1.0.426

type OperateChannelTemplateResponseParams struct {
	// 腾讯电子签颁发给渠道的应用ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	AppId *string `json:"AppId,omitempty" name:"AppId"`

	// 渠道方模板库模板唯一标识
	// 注意:此字段可能返回 null,表示取不到有效值。
	TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`

	// 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
	// 注意:此字段可能返回 null,表示取不到有效值。
	OperateResult *string `json:"OperateResult,omitempty" name:"OperateResult"`

	// 模板可见性, 全部可见-"all", 部分可见-"part"
	// 注意:此字段可能返回 null,表示取不到有效值。
	AuthTag *string `json:"AuthTag,omitempty" name:"AuthTag"`

	// 合作企业方第三方机构唯一标识数据
	// 注意:此字段可能返回 null,表示取不到有效值。
	ProxyOrganizationOpenIds []*string `json:"ProxyOrganizationOpenIds,omitempty" name:"ProxyOrganizationOpenIds"`

	// 操作失败信息数组
	// 注意:此字段可能返回 null,表示取不到有效值。
	FailMessageList []*AuthFailMessage `json:"FailMessageList,omitempty" name:"FailMessageList"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type OrganizationInfo added in v1.0.467

type OrganizationInfo struct {
	// 用户在渠道的机构编号
	OrganizationOpenId *string `json:"OrganizationOpenId,omitempty" name:"OrganizationOpenId"`

	// 用户真实的IP
	ClientIp *string `json:"ClientIp,omitempty" name:"ClientIp"`

	// 机构的代理IP
	ProxyIp *string `json:"ProxyIp,omitempty" name:"ProxyIp"`

	// 机构在平台的编号
	OrganizationId *string `json:"OrganizationId,omitempty" name:"OrganizationId"`

	// 用户渠道
	Channel *string `json:"Channel,omitempty" name:"Channel"`
}

type PdfVerifyResult added in v1.0.501

type PdfVerifyResult struct {
	// 验签结果
	VerifyResult *int64 `json:"VerifyResult,omitempty" name:"VerifyResult"`

	// 签署平台
	SignPlatform *string `json:"SignPlatform,omitempty" name:"SignPlatform"`

	// 签署人名称
	SignerName *string `json:"SignerName,omitempty" name:"SignerName"`

	// 签署时间
	SignTime *int64 `json:"SignTime,omitempty" name:"SignTime"`

	// 签名算法
	SignAlgorithm *string `json:"SignAlgorithm,omitempty" name:"SignAlgorithm"`

	// 签名证书序列号
	CertSn *string `json:"CertSn,omitempty" name:"CertSn"`

	// 证书起始时间
	CertNotBefore *int64 `json:"CertNotBefore,omitempty" name:"CertNotBefore"`

	// 证书过期时间
	CertNotAfter *int64 `json:"CertNotAfter,omitempty" name:"CertNotAfter"`

	// 签名类型
	SignType *int64 `json:"SignType,omitempty" name:"SignType"`

	// 签名域横坐标
	ComponentPosX *float64 `json:"ComponentPosX,omitempty" name:"ComponentPosX"`

	// 签名域纵坐标
	ComponentPosY *float64 `json:"ComponentPosY,omitempty" name:"ComponentPosY"`

	// 签名域宽度
	ComponentWidth *float64 `json:"ComponentWidth,omitempty" name:"ComponentWidth"`

	// 签名域高度
	ComponentHeight *float64 `json:"ComponentHeight,omitempty" name:"ComponentHeight"`

	// 签名域所在页码
	ComponentPage *int64 `json:"ComponentPage,omitempty" name:"ComponentPage"`
}

type PrepareFlowsRequest

type PrepareFlowsRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 多个合同(签署流程)信息,最大支持20个签署流程。
	FlowInfos []*FlowInfo `json:"FlowInfos,omitempty" name:"FlowInfos"`

	// 操作完成后的跳转地址,最大长度200
	JumpUrl *string `json:"JumpUrl,omitempty" name:"JumpUrl"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewPrepareFlowsRequest

func NewPrepareFlowsRequest() (request *PrepareFlowsRequest)

func (*PrepareFlowsRequest) FromJsonString

func (r *PrepareFlowsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*PrepareFlowsRequest) ToJsonString

func (r *PrepareFlowsRequest) ToJsonString() string

type PrepareFlowsRequestParams added in v1.0.426

type PrepareFlowsRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 多个合同(签署流程)信息,最大支持20个签署流程。
	FlowInfos []*FlowInfo `json:"FlowInfos,omitempty" name:"FlowInfos"`

	// 操作完成后的跳转地址,最大长度200
	JumpUrl *string `json:"JumpUrl,omitempty" name:"JumpUrl"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type PrepareFlowsResponse

type PrepareFlowsResponse struct {
	*tchttp.BaseResponse
	Response *PrepareFlowsResponseParams `json:"Response"`
}

func NewPrepareFlowsResponse

func NewPrepareFlowsResponse() (response *PrepareFlowsResponse)

func (*PrepareFlowsResponse) FromJsonString

func (r *PrepareFlowsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*PrepareFlowsResponse) ToJsonString

func (r *PrepareFlowsResponse) ToJsonString() string

type PrepareFlowsResponseParams added in v1.0.426

type PrepareFlowsResponseParams struct {
	// 待发起文件确认页
	ConfirmUrl *string `json:"ConfirmUrl,omitempty" name:"ConfirmUrl"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ProxyOrganizationOperator

type ProxyOrganizationOperator struct {
	// 对应Agent-ProxyOperator-OpenId。渠道平台自定义,对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要渠道平台保存),最大64位字符串
	Id *string `json:"Id,omitempty" name:"Id"`

	// 经办人姓名,最大长度50个字符
	Name *string `json:"Name,omitempty" name:"Name"`

	// 经办人身份证件类型
	// 1.ID_CARD 居民身份证
	// 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
	// 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
	IdCardType *string `json:"IdCardType,omitempty" name:"IdCardType"`

	// 经办人证件号
	IdCardNumber *string `json:"IdCardNumber,omitempty" name:"IdCardNumber"`

	// 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
	Mobile *string `json:"Mobile,omitempty" name:"Mobile"`
}

type Recipient added in v1.0.254

type Recipient struct {
	// 签署人唯一标识
	RecipientId *string `json:"RecipientId,omitempty" name:"RecipientId"`

	// 签署方类型:ENTERPRISE-企业INDIVIDUAL-自然人
	RecipientType *string `json:"RecipientType,omitempty" name:"RecipientType"`

	// 描述
	Description *string `json:"Description,omitempty" name:"Description"`

	// 签署方备注信息
	RoleName *string `json:"RoleName,omitempty" name:"RoleName"`

	// 是否需要校验
	RequireValidation *bool `json:"RequireValidation,omitempty" name:"RequireValidation"`

	// 是否必须填写
	RequireSign *bool `json:"RequireSign,omitempty" name:"RequireSign"`

	// 签署类型
	SignType *int64 `json:"SignType,omitempty" name:"SignType"`

	// 签署顺序:数字越小优先级越高
	RoutingOrder *int64 `json:"RoutingOrder,omitempty" name:"RoutingOrder"`

	// 是否是发起方
	IsPromoter *bool `json:"IsPromoter,omitempty" name:"IsPromoter"`
}

type ReleasedApprover added in v1.0.547

type ReleasedApprover struct {
	// 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符
	OrganizationName *string `json:"OrganizationName,omitempty" name:"OrganizationName"`

	// 签署人在原流程中的签署人列表中的顺序序号(从0开始,按顺序依次递增),如果不清楚原流程中的签署人列表,可以通过DescribeFlows接口查看
	ApproverNumber *uint64 `json:"ApproverNumber,omitempty" name:"ApproverNumber"`

	// 签署人类型,目前仅支持
	// ORGANIZATION-企业
	ApproverType *string `json:"ApproverType,omitempty" name:"ApproverType"`

	// 签署人姓名,最大长度50个字符
	Name *string `json:"Name,omitempty" name:"Name"`

	// 签署人身份证件类型
	// 1.ID_CARD 居民身份证
	// 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
	// 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
	IdCardType *string `json:"IdCardType,omitempty" name:"IdCardType"`

	// 签署人证件号
	IdCardNumber *string `json:"IdCardNumber,omitempty" name:"IdCardNumber"`

	// 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号
	Mobile *string `json:"Mobile,omitempty" name:"Mobile"`

	// 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符
	OrganizationOpenId *string `json:"OrganizationOpenId,omitempty" name:"OrganizationOpenId"`

	// 用户侧第三方id,最大长度64个字符
	// 当签署方为同一渠道下的员工时,该字必传
	OpenId *string `json:"OpenId,omitempty" name:"OpenId"`
}

type RelieveInfo added in v1.0.547

type RelieveInfo struct {
	// 解除理由,最大支持200个字
	Reason *string `json:"Reason,omitempty" name:"Reason"`

	// 解除后仍然有效的条款,保留条款,最大支持200个字
	RemainInForceItem *string `json:"RemainInForceItem,omitempty" name:"RemainInForceItem"`

	// 原合同事项处理-费用结算,最大支持200个字
	OriginalExpenseSettlement *string `json:"OriginalExpenseSettlement,omitempty" name:"OriginalExpenseSettlement"`

	// 原合同事项处理-其他事项,最大支持200个字
	OriginalOtherSettlement *string `json:"OriginalOtherSettlement,omitempty" name:"OriginalOtherSettlement"`

	// 其他约定,最大支持200个字
	OtherDeals *string `json:"OtherDeals,omitempty" name:"OtherDeals"`
}

type RemindFlowRecords added in v1.0.585

type RemindFlowRecords struct {
	// 是否能够催办
	CanRemind *bool `json:"CanRemind,omitempty" name:"CanRemind"`

	// 合同id
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 催办详情
	RemindMessage *string `json:"RemindMessage,omitempty" name:"RemindMessage"`
}

type ResourceUrlInfo added in v1.0.274

type ResourceUrlInfo struct {
	// 资源链接地址,过期时间5分钟
	// 注意:此字段可能返回 null,表示取不到有效值。
	Url *string `json:"Url,omitempty" name:"Url"`

	// 资源名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	Name *string `json:"Name,omitempty" name:"Name"`

	// 资源类型
	// 注意:此字段可能返回 null,表示取不到有效值。
	Type *string `json:"Type,omitempty" name:"Type"`
}

type SignQrCode added in v1.0.418

type SignQrCode struct {
	// 二维码id
	QrCodeId *string `json:"QrCodeId,omitempty" name:"QrCodeId"`

	// 二维码url
	QrCodeUrl *string `json:"QrCodeUrl,omitempty" name:"QrCodeUrl"`

	// 二维码过期时间
	ExpiredTime *int64 `json:"ExpiredTime,omitempty" name:"ExpiredTime"`
}

type SignUrl added in v1.0.458

type SignUrl struct {
	// 小程序签署链接
	AppSignUrl *string `json:"AppSignUrl,omitempty" name:"AppSignUrl"`

	// 签署链接有效时间
	EffectiveTime *string `json:"EffectiveTime,omitempty" name:"EffectiveTime"`

	// 移动端签署链接
	HttpSignUrl *string `json:"HttpSignUrl,omitempty" name:"HttpSignUrl"`
}

type SignUrlInfo

type SignUrlInfo struct {
	// 签署链接,过期时间为30天
	// 注意:此字段可能返回 null,表示取不到有效值。
	SignUrl *string `json:"SignUrl,omitempty" name:"SignUrl"`

	// 合同过期时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	Deadline *int64 `json:"Deadline,omitempty" name:"Deadline"`

	// 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
	// 注意:此字段可能返回 null,表示取不到有效值。
	SignOrder *int64 `json:"SignOrder,omitempty" name:"SignOrder"`

	// 签署人编号
	// 注意:此字段可能返回 null,表示取不到有效值。
	SignId *string `json:"SignId,omitempty" name:"SignId"`

	// 自定义用户编号
	// 注意:此字段可能返回 null,表示取不到有效值。
	CustomUserId *string `json:"CustomUserId,omitempty" name:"CustomUserId"`

	// 用户姓名
	// 注意:此字段可能返回 null,表示取不到有效值。
	Name *string `json:"Name,omitempty" name:"Name"`

	// 用户手机号码
	// 注意:此字段可能返回 null,表示取不到有效值。
	Mobile *string `json:"Mobile,omitempty" name:"Mobile"`

	// 签署参与者机构名字
	// 注意:此字段可能返回 null,表示取不到有效值。
	OrganizationName *string `json:"OrganizationName,omitempty" name:"OrganizationName"`

	// 参与者类型:
	// ORGANIZATION 企业经办人
	// PERSON 自然人
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApproverType *string `json:"ApproverType,omitempty" name:"ApproverType"`

	// 经办人身份证号
	// 注意:此字段可能返回 null,表示取不到有效值。
	IdCardNumber *string `json:"IdCardNumber,omitempty" name:"IdCardNumber"`

	// 签署链接对应流程Id
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowId *string `json:"FlowId,omitempty" name:"FlowId"`

	// 企业经办人 用户在渠道的编号
	// 注意:此字段可能返回 null,表示取不到有效值。
	OpenId *string `json:"OpenId,omitempty" name:"OpenId"`

	// 合同组签署链接对应的合同组id
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowGroupId *string `json:"FlowGroupId,omitempty" name:"FlowGroupId"`
}

type Staff added in v1.0.508

type Staff struct {
	// 员工在电子签平台的id
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// 显示的员工名
	DisplayName *string `json:"DisplayName,omitempty" name:"DisplayName"`

	// 员工手机号
	Mobile *string `json:"Mobile,omitempty" name:"Mobile"`

	// 员工邮箱
	// 注意:此字段可能返回 null,表示取不到有效值。
	Email *string `json:"Email,omitempty" name:"Email"`

	// 员工在第三方平台id
	// 注意:此字段可能返回 null,表示取不到有效值。
	OpenId *string `json:"OpenId,omitempty" name:"OpenId"`

	// 员工角色
	// 注意:此字段可能返回 null,表示取不到有效值。
	Roles []*StaffRole `json:"Roles,omitempty" name:"Roles"`

	// 员工部门
	// 注意:此字段可能返回 null,表示取不到有效值。
	Department *Department `json:"Department,omitempty" name:"Department"`

	// 员工是否实名
	Verified *bool `json:"Verified,omitempty" name:"Verified"`

	// 员工创建时间戳
	CreatedOn *int64 `json:"CreatedOn,omitempty" name:"CreatedOn"`

	// 员工实名时间戳
	VerifiedOn *int64 `json:"VerifiedOn,omitempty" name:"VerifiedOn"`

	// 员工是否离职:0-未离职,1-离职
	QuiteJob *int64 `json:"QuiteJob,omitempty" name:"QuiteJob"`
}

type StaffRole added in v1.0.508

type StaffRole struct {
	// 角色id
	// 注意:此字段可能返回 null,表示取不到有效值。
	RoleId *string `json:"RoleId,omitempty" name:"RoleId"`

	// 角色名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	RoleName *string `json:"RoleName,omitempty" name:"RoleName"`
}

type SyncFailReason added in v1.0.254

type SyncFailReason struct {
	// 经办人Id
	Id *string `json:"Id,omitempty" name:"Id"`

	// 失败原因
	// 例如:Id不符合规范、证件号码不合法等
	// 注意:此字段可能返回 null,表示取不到有效值。
	Message *string `json:"Message,omitempty" name:"Message"`
}

type SyncProxyOrganizationOperatorsRequest

type SyncProxyOrganizationOperatorsRequest struct {
	*tchttp.BaseRequest

	// 渠道应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
	OperatorType *string `json:"OperatorType,omitempty" name:"OperatorType"`

	// 经办人信息列表,最大长度200
	ProxyOrganizationOperators []*ProxyOrganizationOperator `json:"ProxyOrganizationOperators,omitempty" name:"ProxyOrganizationOperators"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewSyncProxyOrganizationOperatorsRequest

func NewSyncProxyOrganizationOperatorsRequest() (request *SyncProxyOrganizationOperatorsRequest)

func (*SyncProxyOrganizationOperatorsRequest) FromJsonString

func (r *SyncProxyOrganizationOperatorsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SyncProxyOrganizationOperatorsRequest) ToJsonString

type SyncProxyOrganizationOperatorsRequestParams added in v1.0.426

type SyncProxyOrganizationOperatorsRequestParams struct {
	// 渠道应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
	OperatorType *string `json:"OperatorType,omitempty" name:"OperatorType"`

	// 经办人信息列表,最大长度200
	ProxyOrganizationOperators []*ProxyOrganizationOperator `json:"ProxyOrganizationOperators,omitempty" name:"ProxyOrganizationOperators"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type SyncProxyOrganizationOperatorsResponse

type SyncProxyOrganizationOperatorsResponse struct {
	*tchttp.BaseResponse
	Response *SyncProxyOrganizationOperatorsResponseParams `json:"Response"`
}

func NewSyncProxyOrganizationOperatorsResponse

func NewSyncProxyOrganizationOperatorsResponse() (response *SyncProxyOrganizationOperatorsResponse)

func (*SyncProxyOrganizationOperatorsResponse) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SyncProxyOrganizationOperatorsResponse) ToJsonString

type SyncProxyOrganizationOperatorsResponseParams added in v1.0.426

type SyncProxyOrganizationOperatorsResponseParams struct {
	// Status 同步状态,全部同步失败接口会直接报错
	// 1-成功
	// 2-部分成功
	// 注意:此字段可能返回 null,表示取不到有效值。
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// 同步失败经办人及其失败原因
	// 注意:此字段可能返回 null,表示取不到有效值。
	FailedList []*SyncFailReason `json:"FailedList,omitempty" name:"FailedList"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type SyncProxyOrganizationRequest

type SyncProxyOrganizationRequest struct {
	*tchttp.BaseRequest

	// 应用信息
	// 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 渠道侧合作企业名称,最大长度64个字符
	ProxyOrganizationName *string `json:"ProxyOrganizationName,omitempty" name:"ProxyOrganizationName"`

	// 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
	BusinessLicense *string `json:"BusinessLicense,omitempty" name:"BusinessLicense"`

	// 渠道侧合作企业统一社会信用代码,最大长度200个字符
	UniformSocialCreditCode *string `json:"UniformSocialCreditCode,omitempty" name:"UniformSocialCreditCode"`

	// 渠道侧合作企业法人/负责人姓名
	ProxyLegalName *string `json:"ProxyLegalName,omitempty" name:"ProxyLegalName"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewSyncProxyOrganizationRequest

func NewSyncProxyOrganizationRequest() (request *SyncProxyOrganizationRequest)

func (*SyncProxyOrganizationRequest) FromJsonString

func (r *SyncProxyOrganizationRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SyncProxyOrganizationRequest) ToJsonString

func (r *SyncProxyOrganizationRequest) ToJsonString() string

type SyncProxyOrganizationRequestParams added in v1.0.426

type SyncProxyOrganizationRequestParams struct {
	// 应用信息
	// 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 渠道侧合作企业名称,最大长度64个字符
	ProxyOrganizationName *string `json:"ProxyOrganizationName,omitempty" name:"ProxyOrganizationName"`

	// 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
	BusinessLicense *string `json:"BusinessLicense,omitempty" name:"BusinessLicense"`

	// 渠道侧合作企业统一社会信用代码,最大长度200个字符
	UniformSocialCreditCode *string `json:"UniformSocialCreditCode,omitempty" name:"UniformSocialCreditCode"`

	// 渠道侧合作企业法人/负责人姓名
	ProxyLegalName *string `json:"ProxyLegalName,omitempty" name:"ProxyLegalName"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type SyncProxyOrganizationResponse

type SyncProxyOrganizationResponse struct {
	*tchttp.BaseResponse
	Response *SyncProxyOrganizationResponseParams `json:"Response"`
}

func NewSyncProxyOrganizationResponse

func NewSyncProxyOrganizationResponse() (response *SyncProxyOrganizationResponse)

func (*SyncProxyOrganizationResponse) FromJsonString

func (r *SyncProxyOrganizationResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SyncProxyOrganizationResponse) ToJsonString

func (r *SyncProxyOrganizationResponse) ToJsonString() string

type SyncProxyOrganizationResponseParams added in v1.0.426

type SyncProxyOrganizationResponseParams struct {
	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type TaskInfo added in v1.0.485

type TaskInfo struct {
	// 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
	// 注意:此字段可能返回 null,表示取不到有效值。
	TaskStatus *string `json:"TaskStatus,omitempty" name:"TaskStatus"`
}

type TemplateInfo

type TemplateInfo struct {
	// 模板ID
	TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`

	// 模板名字
	TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`

	// 模板描述信息
	Description *string `json:"Description,omitempty" name:"Description"`

	// 模板控件信息结构
	Components []*Component `json:"Components,omitempty" name:"Components"`

	// 模板中的流程参与人信息
	Recipients []*Recipient `json:"Recipients,omitempty" name:"Recipients"`

	// 签署区模板信息结构
	SignComponents []*Component `json:"SignComponents,omitempty" name:"SignComponents"`

	// 模板类型:1-静默签;3-普通模板
	TemplateType *int64 `json:"TemplateType,omitempty" name:"TemplateType"`

	// 是否是发起人 ,已弃用
	IsPromoter *bool `json:"IsPromoter,omitempty" name:"IsPromoter"`

	// 模板的创建者信息
	Creator *string `json:"Creator,omitempty" name:"Creator"`

	// 模板创建的时间戳(精确到秒)
	CreatedOn *int64 `json:"CreatedOn,omitempty" name:"CreatedOn"`

	// 模板的H5预览链接,可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
	// 注意:此字段可能返回 null,表示取不到有效值。
	PreviewUrl *string `json:"PreviewUrl,omitempty" name:"PreviewUrl"`

	// 渠道版-模板PDF文件链接
	// 注意:此字段可能返回 null,表示取不到有效值。
	PdfUrl *string `json:"PdfUrl,omitempty" name:"PdfUrl"`

	// 关联的渠道模板ID
	ChannelTemplateId *string `json:"ChannelTemplateId,omitempty" name:"ChannelTemplateId"`

	// 关联的渠道模板名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	ChannelTemplateName *string `json:"ChannelTemplateName,omitempty" name:"ChannelTemplateName"`

	// 0-需要渠道子客手动领取渠道的模板(默认); 1-渠道自动设置子客模板
	// 注意:此字段可能返回 null,表示取不到有效值。
	ChannelAutoSave *int64 `json:"ChannelAutoSave,omitempty" name:"ChannelAutoSave"`

	// 模板版本,全数字字符。默认为空,初始版本为yyyyMMdd001。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TemplateVersion *string `json:"TemplateVersion,omitempty" name:"TemplateVersion"`
}

type UploadFile added in v1.0.370

type UploadFile struct {
	// Base64编码后的文件内容
	FileBody *string `json:"FileBody,omitempty" name:"FileBody"`

	// 文件名
	FileName *string `json:"FileName,omitempty" name:"FileName"`
}

type UploadFilesRequest added in v1.0.370

type UploadFilesRequest struct {
	*tchttp.BaseRequest

	// 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 文件对应业务类型
	// 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
	// 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
	BusinessType *string `json:"BusinessType,omitempty" name:"BusinessType"`

	// 上传文件内容数组,最多支持20个文件
	FileInfos []*UploadFile `json:"FileInfos,omitempty" name:"FileInfos"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

func NewUploadFilesRequest added in v1.0.370

func NewUploadFilesRequest() (request *UploadFilesRequest)

func (*UploadFilesRequest) FromJsonString added in v1.0.370

func (r *UploadFilesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UploadFilesRequest) ToJsonString added in v1.0.370

func (r *UploadFilesRequest) ToJsonString() string

type UploadFilesRequestParams added in v1.0.426

type UploadFilesRequestParams struct {
	// 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
	Agent *Agent `json:"Agent,omitempty" name:"Agent"`

	// 文件对应业务类型
	// 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
	// 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
	BusinessType *string `json:"BusinessType,omitempty" name:"BusinessType"`

	// 上传文件内容数组,最多支持20个文件
	FileInfos []*UploadFile `json:"FileInfos,omitempty" name:"FileInfos"`

	// 操作者的信息
	Operator *UserInfo `json:"Operator,omitempty" name:"Operator"`
}

Predefined struct for user

type UploadFilesResponse added in v1.0.370

type UploadFilesResponse struct {
	*tchttp.BaseResponse
	Response *UploadFilesResponseParams `json:"Response"`
}

func NewUploadFilesResponse added in v1.0.370

func NewUploadFilesResponse() (response *UploadFilesResponse)

func (*UploadFilesResponse) FromJsonString added in v1.0.370

func (r *UploadFilesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UploadFilesResponse) ToJsonString added in v1.0.370

func (r *UploadFilesResponse) ToJsonString() string

type UploadFilesResponseParams added in v1.0.426

type UploadFilesResponseParams struct {
	// 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
	FileIds []*string `json:"FileIds,omitempty" name:"FileIds"`

	// 上传成功文件数量
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// 文件Url
	FileUrls []*string `json:"FileUrls,omitempty" name:"FileUrls"`

	// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type UsageDetail

type UsageDetail struct {
	// 渠道侧合作企业唯一标识
	ProxyOrganizationOpenId *string `json:"ProxyOrganizationOpenId,omitempty" name:"ProxyOrganizationOpenId"`

	// 渠道侧合作企业名
	// 注意:此字段可能返回 null,表示取不到有效值。
	ProxyOrganizationName *string `json:"ProxyOrganizationName,omitempty" name:"ProxyOrganizationName"`

	// 日期,当需要汇总数据时日期为空
	// 注意:此字段可能返回 null,表示取不到有效值。
	Date *string `json:"Date,omitempty" name:"Date"`

	// 消耗数量
	Usage *uint64 `json:"Usage,omitempty" name:"Usage"`

	// 撤回数量
	// 注意:此字段可能返回 null,表示取不到有效值。
	Cancel *uint64 `json:"Cancel,omitempty" name:"Cancel"`

	// 消耗渠道
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowChannel *string `json:"FlowChannel,omitempty" name:"FlowChannel"`
}

type UserInfo

type UserInfo struct {
	// 渠道平台自定义,对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要渠道平台保存),最大64位字符串
	OpenId *string `json:"OpenId,omitempty" name:"OpenId"`

	// 内部参数,暂未开放使用
	Channel *string `json:"Channel,omitempty" name:"Channel"`

	// 内部参数,暂未开放使用
	CustomUserId *string `json:"CustomUserId,omitempty" name:"CustomUserId"`

	// 内部参数,暂未开放使用
	ClientIp *string `json:"ClientIp,omitempty" name:"ClientIp"`

	// 内部参数,暂未开放使用
	ProxyIp *string `json:"ProxyIp,omitempty" name:"ProxyIp"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL