跳到主要内容

创建导入处方单个人印章

1. 接口描述​

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

本接口（ChannelCreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，使用此接口请与客户经理确认）。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelCreatePreparedPersonalEsign。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
UserName是String个人用户姓名
IdCardNumber是String证件号码, 应符合以下规则
  • 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
  • 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
  • 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
SealName是String电子印章名字，1-50个中文字符
注:同一企业下电子印章名字不能相同
SealImage是String电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式。

Operator否UserInfo执行本接口操作的员工信息。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
IdCardType否String证件类型，支持以下类型
  • ID_CARD : 中国大陆居民身份证 (默认值)
  • HONGKONG_AND_MACAO : 港澳居民来往内地通行证
  • HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
  • OTHER_CARD_TYPE : 其他


注: 其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。
SealImageCompress否Boolean是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
Mobile否String手机号码；当需要开通自动签时，该参数必传
EnableAutoSign否Boolean此字段已废弃，请勿继续使用。
LicenseType否Integer设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
SceneKey否String
  • E_PRESCRIPTION_AUTO_SIGN : 电子处方场景
  • OTHER : 通用场景

示例值：E_PRESCRIPTION_AUTO_SIGN

3. 输出参数​

参数名称类型描述
SealIdString电子印章ID，为32位字符串。
建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 参数UserName不能为空​

参数UserName不能为空

输入示例​

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

{
    "Operator": {
        "OpenId": "abc",
        "Channel": "abc",
        "CustomUserId": "abc",
        "ClientIp": "abc",
        "ProxyIp": "abc"
    },
    "Agent": {
        "AppId": "abc",
        "ProxyOrganizationOpenId": "abc",
        "ProxyOperator": {
            "OpenId": "abc",
            "Channel": "abc",
            "CustomUserId": "abc",
            "ClientIp": "abc",
            "ProxyIp": "abc"
        },
        "ProxyAppId": "abc",
        "ProxyOrganizationId": "abc"
    },
    "UserName": "",
    "IdCardType": "abc",
    "IdCardNumber": "abc",
    "SealName": "abc",
    "SealImage": "abc",
    "SealImageCompress": true,
    "Mobile": "abc",
    "EnableAutoSign": true,
    "LicenseType": 0
}

输出示例​

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue",
            "Message": "参数UserName不能为空"
        },
        "RequestId": "xxxx111xxxx"
    }
}

示例2 参数IdCardNumber不能为空​

参数IdCardNumber不能为空

输入示例​

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

{
    "Operator": {
        "OpenId": "abc",
        "Channel": "abc",
        "CustomUserId": "abc",
        "ClientIp": "abc",
        "ProxyIp": "abc"
    },
    "Agent": {
        "AppId": "abc",
        "ProxyOrganizationOpenId": "abc",
        "ProxyOperator": {
            "OpenId": "abc",
            "Channel": "abc",
            "CustomUserId": "abc",
            "ClientIp": "abc",
            "ProxyIp": "abc"
        },
        "ProxyAppId": "abc",
        "ProxyOrganizationId": "abc"
    },
    "UserName": "abc",
    "IdCardType": "abc",
    "IdCardNumber": "",
    "SealName": "abc",
    "SealImage": "abc",
    "SealImageCompress": true,
    "Mobile": "abc",
    "EnableAutoSign": true,
    "LicenseType": 0
}

输出示例​

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue",
            "Message": "参数IdCardNumber不能为空"
        },
        "RequestId": "abc"
    }
}

示例3 通过准备好的个人印章图片创建印章​

通过准备好的个人印章图片创建印章

输入示例​

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

{
    "Operator": {
        "OpenId": "abc",
        "Channel": "abc",
        "CustomUserId": "abc",
        "ClientIp": "abc",
        "ProxyIp": "abc"
    },
    "Agent": {
        "AppId": "abc",
        "ProxyOrganizationOpenId": "abc",
        "ProxyOperator": {
            "OpenId": "abc",
            "Channel": "abc",
            "CustomUserId": "abc",
            "ClientIp": "abc",
            "ProxyIp": "abc"
        },
        "ProxyAppId": "abc",
        "ProxyOrganizationId": "abc"
    },
    "UserName": "印章归属个人姓名",
    "IdCardType": "",
    "IdCardNumber": "身份证件号码",
    "SealImage": "印章图片Base64",
    "SealName": "我的印章名称",
    "Mobile": "135*111",
    "EnableAutoSign": true
}

输出示例​

{
    "Response": {
        "SealId": "abc",
        "RequestId": "abc"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062