调用ListCustomPersons接口列出指定⼈物库下的所有⼈物和⼈脸信息。

调试

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

请求参数

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

操作接口名,系统规定参数。取值:ListCustomPersons

CategoryId String xxCategoryIdxx

⼈物库ID,⽤于唯⼀标识⼀个⾃定义⼈物库,由调⽤者⽣成,调⽤者⾃⼰保证唯⼀性。若不填写,将列出所有⾃定义⼈物库。

说明 不能与系统⼈物库ID相同(最⻓⽀持120字符,不区分⼤⼩写)。
PersonId String xxPersonIdxx

⼈物ID,若不填写,将列出CategoryId下所有⼈物。

返回数据

名称 类型 示例值 描述
RequestId String 1820B01E-D1B0-4BBD-828A-41A152EB****

请求ID。

Categories Array of Category

⼈物库数组。

Category
Persons Array of Person

⼈物数组。

Person
PersonName String xxPersonNamexx

⼈物名字。

PersonDescription String xxPersonDescriptionxx

⼈物描述。

Faces Array of Face

⼈脸数组。

Face
ImageUrl String http://xxxxxx.jpeg

注册时的⼈脸图⽚URL。

FaceId String 150968

⼈脸ID。

PersonId String xxPersonIdxx

⼈物ID。

CategoryId String xxCategoryIdxx

⼈物库ID。

CategoryName String xxCategoryNamexx

⼈物库名称。

CategoryDescription String xxCategoryDescriptionxx

⼈物库描述。

示例

请求示例

http(s)://[Endpoint]/?Action=ListCustomPersons
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListCustomPersonsResponse>
<RequestId>1820B01E-D1B0-4BBD-828A-41A152EB0ED1</RequestId>
<Categories>
    <Category>
        <CategoryId>xxCategoryIdxx</CategoryId>
        <CategoryName>xxCategoryNamexx</CategoryName>
        <CategoryDescription>xxCategoryDescriptionxx</CategoryDescription>
    </Category>
    <Category>
        <Persons>
            <Person>
                <PersonName>xxPersonNamexx</PersonName>
                <PersonDescription>xxPersonDescriptionxx</PersonDescription>
                <PersonId>xxPersonIdxx</PersonId>
            </Person>
            <Person>
                <Faces>
                    <Face>
                        <FaceId>150968</FaceId>
                        <ImageUrl>http://xxxxxx.jpeg</ImageUrl>
                    </Face>
                </Faces>
            </Person>
        </Persons>
    </Category>
</Categories>
</ListCustomPersonsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ListCustomPersonsResponse" : {
    "RequestId" : "1820B01E-D1B0-4BBD-828A-41A152EB0ED1",
    "Categories" : {
      "Category" : [ {
        "CategoryId" : "xxCategoryIdxx",
        "CategoryName" : "xxCategoryNamexx",
        "CategoryDescription" : "xxCategoryDescriptionxx"
      }, {
        "Persons" : {
          "Person" : [ {
            "PersonName" : "xxPersonNamexx",
            "PersonDescription" : "xxPersonDescriptionxx",
            "PersonId" : "xxPersonIdxx"
          }, {
            "Faces" : {
              "Face" : {
                "FaceId" : 150968,
                "ImageUrl" : "http://xxxxxx.jpeg"
              }
            }
          } ]
        }
      } ]
    }
  }
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError errorMsg:%s 内部错误,偶发请重试。

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

SDK示例