1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
本接口(ChannelCreatePreparedPersonalEsign)用于创建导入个人印章(处方单场景专用,使用此接口请与客户经理确认)。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ChannelCreatePreparedPersonalEsign。 |
| Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 |
| UserName | 是 | String | 个人用户姓名 示例值:张三 |
| IdCardNumber | 是 | String | 证件号码, 应符合以下规则
示例值:620000198802020000 |
| SealName | 是 | String | 电子印章名字,1-50个中文字符 示例值:我的印章名称 |
| Operator | 否 | UserInfo | 执行本接口操作的员工信息。 |
| IdCardType | 否 | String | 证件类型,支持以下类型
注: 示例值:ID_CARD |
| Mobile | 否 | String | 手机号码;当需要开通授权签时,该参数必传 示例值:18888888888 |
| FileId | 否 | String | 印章图片文件 id取值:填写的FileId通过UploadFiles接口上传文件获取。 示例值:yDtOJUUckpftturtURxNEFKShAukAd2b |
| SceneKey | 否 | String |
示例值:E_PRESCRIPTION_AUTO_SIGN |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SealId | String | 电子印章ID,为32位字符串。 示例值:yDCYIUUckp7t75mxUxAAGY1B8z3p0AIA |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通过准备好的个人印章图片创建印章
通过准备好的个人印章图片创建印章
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreatePreparedPersonalEsign
<公共请求参数>
{
"Operator": {
"OpenId": "UxSq3Yhw6lLHwsZd9RZTCOz69ewqFzXChxs3bMD"
},
"Agent": {
"AppId": "yDwJBUUckpkl05jrUuxCKSQvQxffCN28",
"ProxyOrganizationOpenId": "org_dianzqin"
},
"UserName": "印章归属个人姓名",
"IdCardType": "",
"IdCardNumber": "身份证件号码",
"SealImage": "印章图片Base64",
"SealName": "我的印章名称",
"Mobile": "135*111",
"EnableAutoSign": true
}
输出示例
{
"Response": {
"SealId": "yDCYIUUckp7t75mxUxAAGY1B8z3p0AIA",
"RequestId": "6e3eb9ef-61f9-4884-9874-465eaffc3d64"
}
}
示例2 通过已上传的印章FileId创建印章
通过已上传的印章FileId创建印章
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreatePreparedPersonalEsign
<公共请求参数>
{
"Operator": {
"OpenId": "UxSq3Yhw6lLHwsZd9RZTCOz69ewqFzXChxs3bMD"
},
"Agent": {
"AppId": "yDwJBUUckpkl05jrUuxCKSQvQxffCN28",
"ProxyOrganizationOpenId": "org_dianzqin"
},
"UserName": "印章归属个人姓名",
"IdCardType": "",
"IdCardNumber": "身份证件号码",
"SealImage": "印章图片Base64",
"SealName": "我的印章名称",
"Mobile": "135*111",
"FileId": "yDwJB******************ddskaSIs"
}
输出示例
{
"Response": {
"SealId": "yDtOJUUckpftturtURxNEFKShAukAd2b",
"RequestId": "39f18b2b-03fe-40b8-8d16-dbf4ead3685f"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |