User Information

Last Updated on : 2023-06-20 12:34:13download

Get the information about users in a specified segment in the Data Profile service. User information includes the user ID, email address, mobile phone number, and more.

API address

GET: /v1.0/user-profile/group/users

Request parameter

Parameter name Type IN Required Description
params String query true JSON

Description of params

Parameter name Type IN Required Description
bizType String true The user domain.
groupId Integer true The ID of a specified segment.
pageSize Integer false The number of entries to be returned on each page.
lastId String false The ID of the last entry on the previous page. The parameter value is required when you query the next page. If it is left blank, the first page will be queried by default.

Return parameter

Parameter name Type Description
result OpenApiResult The returned result.

Description of result

Parameter name Type Description
resultDO Object The list of users.
error_code String The error code.
error_msg String The error message.
success Boolean Indicates whether the operation is successful.

Description of resultDO

Parameter name Type Description
data Arrary The information about a specified user.
lastUid String The lastId returned in the result.
totalCount Integer The total number.

Description of data

Parameter name Type Description
email String The email address.
uid String The user ID.
mobile String The mobile phone number.

Request example

GET: /v1.0/user-profile/group/users?params={"bizType":2xxx32,"groupId":1xx,"pageSize":10,"lastId":"ay15xxxxxxxxwnass3"}

Return example

{ "result": { "resultDO": { "data": [ { "mobile": "86-15XXXXXX587", "uid": "ay1xxxxxxx23101eifQI", "email": "" } ], "lastUid": "ay15xxxxxxxxwnT43", "totalCount": 1 }, "success": true }, "t": 1628236323685, "success": true }

Error code

For more information, see error code.