向人脸管理服务添加一个用户。

调试

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

请求参数

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

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

CustomUserId String 52242819650301xxxx

该参数为调用者业务系统中,用户的唯一ID,如身份证号、学号等。

FacePicUrl String https://test.com/xxx.jpg

图片URL下载地址,目前支持JPG、JPEG格式图片。

IsolationId String TestIsolati****

业务隔离ID。

用于租户下不同应用之间的数据隔离。如某用户在浙江、陕西都有业务,则可以为浙江和西安的业务分别创建两个隔离ID。

Name String ZhangSan

用户名。

Params String {"age":28, "sex":"male"}

用户信息。

返回数据

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

错误码。

Data Struct

用户信息。

CustomUserId String 52242819650301****

同请求参数CustomUserId。

Name String ZhangSan

同请求参数Name。

Params String {"age":28, "sex":"male"}

同请求参数Params。

UserId String 3mtjaqebeq4d****

人脸服务内部用户唯一ID。

UserId是用户在人脸管理服务中的唯一ID,调用者需要保存到自己的业务系统中,在调用人脸管理服务的其它接口时会使用。

ErrorMessage String success

错误码描述。

RequestId String 0A13279A-5640-45E7-87AA-83750541AD0E

请求ID。

Success Boolean true

是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=AddFaceUser
&CustomUserId=52242819650301xxxx
&FacePicUrl=https://test.com/xxx.jpg
&IsolationId=TestIsolati****
&<公共请求参数>

正常返回示例

XML格式

<AddFaceUserResponse>
      <RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>
      <Data>
            <UserId>3mtjaqebeq4d****</UserId>
            <Params>{"age":28, "sex":"male"}</Params>
            <CustomUserId>52242819650301****</CustomUserId>
            <Name>ZhangSan</Name>
      </Data>
      <ErrorMessage>success</ErrorMessage>
      <Code>200</Code>
      <Success>true</Success>
</AddFaceUserResponse>

JSON格式

{
    "RequestId": "0A13279A-5640-45E7-87AA-83750541AD0E",
    "Data": {
        "UserId": "3mtjaqebeq4d****",
        "Params": "{\"age\":28, \"sex\":\"male\"}",
        "CustomUserId": "52242819650301****",
        "Name": "ZhangSan"
    },
    "ErrorMessage": "success",
    "Code": "200",
    "Success": "true"
}

错误码

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