1. 接口描述
接口请求域名: chc.tencentcloudapi.com 。
创建人员到访工单
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreatePersonnelVisitWorkOrder。 |
Version | 是 | String | 公共参数,本接口取值:2023-04-18。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
PersonnelSet.N | 是 | Array of Personnel | 到访人员信息 |
IdcId | 是 | Integer | 机房 ID 示例值:169 |
IdcUnitIdSet.N | 是 | Array of Integer | 机房管理单元列表 示例值:[ 15802, 15803 ] |
EnterStartTime | 是 | String | 到访开始时间 示例值:2024-10-27 00:25:56 |
EnterEndTime | 是 | String | 到访结束时间 示例值:2024-10-27 00:25:56 |
VisitReason.N | 是 | Array of String | 到访原因,映射关系:IT_OPERATION IT运维 OTHER 其他 示例值:["OTHER"] |
VisitRemark | 是 | String | 到访说明 示例值:设备测试 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
WorkOrderSet | Array of WorkOrderTinyInfo | 创建的工单信息 示例值:[ { "WorkOrderId": "ord-24122317200212924", "ServiceType": "personnelVisit", "OrderType": "personnelVisit" } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建人员到访工单
输入示例
POST / HTTP/1.1
Host: chc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePersonnelVisitWorkOrder
<公共请求参数>
{
"PersonnelSet": [
{
"IDCardNumber": "****",
"IDCardType": "IDENTITY_CARD",
"Company": "某某公司",
"LanguageType": "CHINESE",
"Name": "张三",
"TelNumber": "13800138000",
"Position": "工程师",
"Wechat": "zhangsan_wechat",
"Email": "zhangsan@example.com"
}
],
"IdcId": 373,
"IdcUnitIdSet": [
2555
],
"EnterStartTime": "2025-03-08 17:25:04",
"EnterEndTime": "2025-03-10 17:25:04",
"VisitReason": [
"IT_OPERATION"
],
"VisitRemark": "需要参观"
}
输出示例
{
"Response": {
"RequestId": "289288d7-d662-4b66-b4ef-d18d8913ca18",
"WorkOrderSet": [
{
"OrderType": "personnelVisit",
"ServiceType": "personnelVisit",
"WorkOrderId": "ord-25030711303576000"
}
]
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。