Call the getPersonList operation to obtain a list of individuals - AI Guardrails

Call the getPersonList operation to query the IDs of all individuals in an individual group, with pagination support.

QPS limits

This operation supports up to 20 calls per second per account (QPS, queries per second). Exceeding this limit triggers throttling, which may affect your service. Design your call rate accordingly.

Request syntax

POST /green/sface/group/persons HTTPS|HTTP

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request parameters

Parameter	Type	Required	Example	Description
`clientInfo`	JSONObject	No	`{"userId":"120234234","userNick":"Mike","userType":"others"}`	The client information from the `ClientInfo` structure, serialized in JSON format. Contains the unique machine identifier (UMID) and International Mobile Equipment Identity (IMEI) of the client. For more information, see ClientInfo.

RequestBody

Parameter	Type	Required	Example	Description
`groupId`	String	Yes	`group1`	The ID of the individual group to query.
`currentPage`	Integer	No	`1`	The page number to return, starting from 1. Default value: 1.
`pageSize`	Integer	No	`20`	The number of entries per page. Valid values: 1 to 100. Default value: 20.

Response parameters

All responses are returned in JSON format. For common response parameters, see Common response parameters.

The data field contains the following parameters. This field may be empty if an error occurs.

Parameter	Type	Example	Description
`code`	Integer	`200`	The HTTP status code. For more information, see Common error codes.
`personIds`	StringArray	`["person1","person2"]`	The IDs of all individuals in the individual group.
`currentPage`	Integer	`1`	The current page number returned.
`pageSize`	Integer	`20`	The number of entries returned on each page.
`totalCount`	Integer	`100`	The total number of individuals in the individual group.

Examples

Sample request

POST /green/sface/group/persons HTTP/1.1
Common request headers
{
    "groupId": "group1",
    "pageSize": 10,
    "currentPage": 1
}

Sample success response

{
    "msg": "OK",
    "code": 200,
    "requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
    "data": {
        "code": 200,
        "personIds": [
            "person1",
            "person2"
        ],
        "pageSize": 10,
        "currentPage": 1,
        "totalCount": 17
    }
}