跳到主要内容

生成渠道子客用印申请审批链接

1. 接口描述

接口请求域名: essbasic.tencentcloudapi.com 。

生成用印申请审批链接,审批人可以通过此链接进入小程序进行审批。 p.s. Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批人打开。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称必选类型描述
ActionString公共参数,本接口取值:DescribeChannelSealPolicyWorkflowUrl。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

渠道应用标识: Agent.AppId
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
WorkflowInstanceIdString用印审批单的ID,可通过用印申请回调获取。
EndpointString生成链接的类型:
生成链接的类型
  • LongLink:(默认)长链接,H5跳转到电子签小程序链接,链接有效期为1年
  • ShortLink:H5跳转到电子签小程序链接,一般用于发送短信中带的链接,打开后进入腾讯电子签小程序,链接有效期为7天
  • App:第三方APP或小程序跳转电子签小程序链接,一般用于贵方小程序或者APP跳转过来,打开后进入腾讯电子签小程序,链接有效期为1年

3. 输出参数

参数名称类型描述
WorkflowUrlString用印审批小程序链接,链接类型(通过H5唤起小程序或通过APP跳转方式查看)。
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取用印审批链接

获取用印审批链接

输入示例

POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeChannelSealPolicyWorkflowUrl
<公共请求参数>

{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"WorkflowInstanceId": "yDwiBUUckpo27hh3UuLiduR83BEL3kSb"
}

输出示例

{
"Response": {
"WorkflowUrl": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=SEAL_APPROVE&userId=yDwhxUUckp3gl8j5UuFX33LSNozpRsbi&policyId=yDwhxUUckp3gl8j5UuFX33LSNozpRsbi&instanceId=yDwhxUUckp3gl8j5UuFX33LSNozpRsbi&channelType=AAA",
"RequestId": "s1696921563375938822"
}
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码描述
InvalidParameter.ParamError参数错误。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062