1. 接口描述
接口请求域名: cii.tencentcloudapi.com 。
本接口(CreateStructureTask)基于提供的客户及保单信息,创建并启动结构化识别任务。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateStructureTask。 |
Version | 是 | String | 公共参数,本接口取值:2021-04-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ServiceType | 是 | String | 服务类型 Structured 仅结构化 Underwrite 结构化+核保 示例值:Structured |
TaskInfos.N | 是 | Array of CreateStructureTaskInfo | 创建任务时可以上传多个报告,后台生成多个识别子任务,子任务的详细信息 示例值:[{ "TaskType": "HealthReport", "CustomerId": "04 |
PolicyId | 否 | String | 保单号 示例值:p0001 |
TriggerType | 否 | String | 核保触发方式 Auto 自动 Manual 手动 示例值:Auto |
InsuranceTypes.N | 否 | Array of String | 险种,如果是体检报告类型,此参数是必填,类型说明如下: CriticalDiseaseInsurance:重疾险 LifeInsurance:寿险 AccidentInsurance:意外险 示例值:["CriticalDiseaseInsurance"] |
CallbackUrl | 否 | String | 回调地址,接收Post请求传送结果 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
MainTaskId | String | 创建的主任务号,用于查询结果 示例值:46313288149458944 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建结构化任务接口示例
输入示例
POST / HTTP/1.1
Host: cii.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateStructureTask
<公共请求参数>
{
"ServiceType": "Underwrite",
"PolicyId": "0406-01",
"TriggerType": "Auto",
"InsuranceTypes": [
"CriticalDiseaseInsurance",
"LifeInsurance",
"AccidentInsurance"
],
"TaskInfos": [
{
"TaskType": "HealthReport",
"CustomerId": "0406-01-1",
"CustomerName": "0406-01-1",
"FileList": [
"original_upload_dir/test.pdf"
],
"ImageList": [],
"Year": "2021"
}
]
}
输出示例
{
"Response": {
"RequestId": "22dfcc05-1ba1-49b4-a751-f5611cdb3420",
"MainTaskId": "37835597617481728"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |