腾讯电子签集成版更新印章状态-API 文档-文档中心-腾讯云

1. 接口描述

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

此接口（ChannelUpdateSealStatus）用于第三方应用平台为子客企业更新印章状态。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelUpdateSealStatus。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
Status	是	String	印章状态，目前支持传入以下类型： DISABLE-停用印章示例值：DISABLE
SealId	是	String	印章ID
Reason	否	String	更新印章状态原因说明示例值：更新原因-停用印章

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 停用印章

1.指定AppId为yDwfwUUgygormhg1UuS2eARxjMT0mxAw
2.指定子客企业的OpenId为org_dianziqian
3.指定要操作的印章Id为yDRTZxxxxxJNR
4.指定设置印章状态为DISABLE

输入示例

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

{
    "Agent": {
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "732aaef****541b89c49e0cc"
        },
        "AppId": "yDwfwUUgygormhg1UuS2eARxjMT0mxAw"
    },
    "SealId": "yDRTZxxxxxJNR",
    "Status": "DISABLE",
    "Reason": "变更原因-停用"
}

输出示例

{
    "Response": {
        "RequestId": "s187098654322345"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

更新印章状态

本页目录：