有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: ivld.tencentcloudapi.com 。

描述自定义人物详细信息,包括人物信息与人物信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCustomPersonDetail。
Version String 公共参数,本接口取值:2021-09-03。
Region String 公共参数,详见产品支持的 地域列表
PersonId String 自定义人物Id
示例值:person-a1b2c3

3. 输出参数

参数名称 类型 描述
PersonInfo CustomPersonInfo 自定义人物信息
TaskIdSet Array of String 出现该自定义人物的所有分析人物Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:["task-123"]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功描述人物详细信息(包括出现这个人物的任务ID列表)

输入示例

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

{
    "PersonId": "person-Axgo3FYc"
}

输出示例

{
    "Response": {
        "PersonInfo": {
            "BasicInfo": "测试基本信息",
            "CreateTime": "2022-01-25 10:35:47",
            "ImageInfoSet": [
                {
                    "ErrorCode": "OK",
                    "ErrorMsg": "OK",
                    "ImageId": "image-Axgo3FYc-egMN",
                    "ImageURL": "https://test-251202813.cos.ap-guangzhou.myqcloud.com/CustomImages/image-Axgo3FYc-egMN.jpeg"
                }
            ],
            "L1Category": "明星",
            "L2Category": "巨星",
            "Name": "测试姓名",
            "PersonId": "person-Axgo3FYc"
        },
        "RequestId": "db04f25b-0d68-4cba-9171-254abc8ff3ac",
        "TaskIdSet": []
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UserInvalidStatus 用户状态异常。
AuthFailure.UserNotFound 用户无权限。
AuthFailure.UserStopArrear 用户已欠费停服。
InternalError.DBConnectionError 内部DB连接失败。
InternalError.InnerError 内部错误。
InvalidParameter.InvalidPersonId 人物ID不合法。
ResourceNotFound.RecordNotFound 记录不存在。
UnauthorizedOperation.UnauthorizedProduct 用户未激活该产品。