跳到主要内容

获取小程序签署链接

1. 接口描述​

接口请求域名： ess.tencentcloudapi.com 。

获取小程序签署链接

适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。

注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。

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

如您需要自主配置小程序跳转链接，请参考: 跳转小程序链接配置说明

默认接口请求频率限制：300次/秒。

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：CreateSchemeUrl。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，本接口不需要传递此参数。
Operator是UserInfo调用方用户信息，userId 必填
OrganizationName否String企业名称
Name否String姓名,最大长度50个字符
Mobile否String手机号，大陆手机号11位
EndPoint否String链接类型
HTTP：跳转电子签小程序的http_url，
APP：第三方APP或小程序跳转电子签小程序的path。
默认为HTTP类型
FlowId否String签署流程编号 (PathType=1时必传)
PathType否Integer跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
AutoJumpBack否Boolean是否自动回跳 true：是， false：否。该参数只针对"APP" 类型的签署链接有效
Agent否Agent代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

3. 输出参数​

参数名称类型描述
SchemeUrlString小程序链接地址，有效期5分钟
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 获取小程序跳转链接​

获取小程序跳转链接

输入示例​

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

{
    "FlowId": "1956103*****20fde6a",
    "PathType": 1,
    "Name": "张三",
    "Mobile": "13888888888",
    "OrganizationName": "测试企业",
    "EndPoint": "HTTP",
    "AutoJumpBack": false,
    "Operator": {
        "UserId": "00033e********4aa82a9"
    }
}

输出示例​

{
    "Response": {
        "SchemeUrl": "weixin://dl/business/?t= *TICKET*",
        "RequestId": ""
    }
}

5. 开发者资源​

腾讯云 API 平台​

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector​

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK​

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具​

6. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InternalError.Db数据库异常。
InternalError.DbRead内部错误,数据库查询失败,请稍后重试。
InternalError.System系统错误，请稍后重试。
InvalidParameter.DataNotFound数据不存在。
InvalidParameter.Mobile不合法的手机号，请检查后重试。
InvalidParameter.Name不合法的用户名称，请修改后重试。
InvalidParameter.ParamError参数错误。
InvalidParameterValue参数取值错误。
MissingParameter缺少参数错误。
OperationDenied.ErrNoResourceAccess此企业无该资源使用权限。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoFlowPermission无权限操作签署流程，请联系客服了解权限，并在修改后重试。
OperationDenied.NoIdentityVerify未通过个人实名认证。
OperationDenied.NoLogin用户未登录,请先登录后再操作。
OperationDenied.NoSupportJumpPage不支持的跳转页，请联系客服了解跳转配置规则，修改后重试。
OperationDenied.WhiteListForbid未开通功能白名单，请联系客服处理。
ResourceNotFound.Application应用号不存在或已删除。
ResourceNotFound.Flow签署流程未找到，请检查参数。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。