调用GetPersonList获取动态人列表实例

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetPersonList

系统规定参数。取值:GetPersonList。

CorpId String 区域id

区域id

CorpIdList Json ["corpId1","corpId2"]

区域id集合

PageNumber Long 1

当前页

PageSize Long 1000

每页大小,最大不能超过1000

FaceUrl String 图片完整地址

图片完整地址

FaceMatchingRateThreshold String 图搜相似度

图搜相似度,不能超过1

PersonIdList Json ["personId1"]

动态人id列表

返回数据

名称 类型 示例值 描述
Code String OK

响应码

Data Struct

响应数据实体

PageNumber Long 1

当前页

PageSize Long 100

每页大小

Records Array of Records

数据列表

FaceUrl String 图片完整地址

图片完整地址

FirstShotTime Long 1602571402

第一次出现的时间

LastShotTime Long 1602571402

最后一次出现的时间

PersonId String PersonId-example

动态人id

PropertyTagList Array of TagList

属性列表标签

Code String 标签code

标签code

TagCodeName String 标签项名称

标签项名称

TagName String 标签值名称

标签项名称

Value String 标签值。code+value确定唯一一个打标情况

标签值。code+value确定唯一一个打标情况

SearchMatchingRate String 0.8

匹配的相似度,不超过1

TotalCount Long 1000

总数

Message String SUCCESS

错误消息

RequestId String XXXX-XXX-XXXX

本地请求链路追踪id

示例

请求示例

http(s)://[Endpoint]/?Action=GetPersonList
&CorpId=区域id
&CorpIdList=["corpId1","corpId2"]
&PageNumber=1
&PageSize=1000
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>XXXX-XXX-XXXX</RequestId>
<Message>SUCCESS</Message>
<Data>
    <TotalCount>1000</TotalCount>
    <PageSize>100</PageSize>
    <PageNumber>1</PageNumber>
    <Records>
        <FirstShotTime>1602571402</FirstShotTime>
        <SearchMatchingRate>0.8</SearchMatchingRate>
        <PersonId>PersonId-example</PersonId>
        <FaceUrl>图片完整地址</FaceUrl>
        <LastShotTime>1602571402</LastShotTime>
    </Records>
    <Records>
        <PropertyTagList>
            <TagCodeName>标签项名称</TagCodeName>
            <Value>标签值。code+value确定唯一一个打标情况</Value>
            <TagName>标签值名称</TagName>
            <Code>标签code</Code>
        </PropertyTagList>
    </Records>
</Data>
<Code>OK</Code>

JSON 格式

{"RequestId":"XXXX-XXX-XXXX","Message":"SUCCESS","Data":{"TotalCount":"1000","PageSize":"100","PageNumber":"1","Records":[{"FirstShotTime":"1602571402","SearchMatchingRate":"0.8","PersonId":"PersonId-example","FaceUrl":"图片完整地址","LastShotTime":"1602571402"},{"PropertyTagList":[{"TagCodeName":"标签项名称","Value":"标签值。code+value确定唯一一个打标情况","TagName":"标签值名称","Code":"标签code"}]}]},"Code":"OK"}

错误码

HttpCode 错误码 错误信息 描述
401 InvalidCorpId The specified CorpId is invalid. ISV要操作的组织不存在.

访问错误中心查看更多错误码。