# Query the user status (/en/api-reference/api-ref/rtc/query-user-status)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

Retrieves the status of a specified user in a channel.

- OpenAPI: /openapi/rtc/channel-management.en.yaml
- Operation ID: cma-query-user-status
- Method: GET
- Path: /dev/v1/channel/user/property/{appid}/{uid}/{channelName}

## Servers

- https://api.agora.io

## Parameters

- `appid` (path, required) - The App ID of the project. You can get it through one of the following methods:
- Copy from the [Agora Console](https://console.agora.io)
- Call the Get all projects API, and read the value of the `vendor_key`
  field in the response body.
- `uid` (path, required) - The user ID. This parameter does not support string user accounts; use the integer user ID only.
- `channelName` (path, required) - The channel name.

## Request body

No request body.

## Responses

### 200

A `200` status code indicates success. The response body contains the result of the request.

- `success` (boolean) - The state of this request:
- `true`: Success.
- `false`: Reserved for future use.
No schema.
- `data` (object) - User statistics.
  - `data.in_channel` (boolean) - Whether the user is in the channel. When `false`, no other fields are returned.
No schema.
  - `data.uid` (number) - The user ID.
No schema.
  - `data.join` (number) - The Unix timestamp (in seconds) of when the user joined the channel.
No schema.
  - `data.role` (number) - The role of the user in the channel:
- `0`: Unknown user role.
- `1`: User, in a communication channel.
- `2`: Host, in a live broadcast channel.
- `3`: Audience, in a live broadcast channel.
No schema.
  - `data.platform` (number) - The platform of the user's device. Common values: `1`: Android, `2`: iOS, `5`: Windows, `6`: Linux, `7`: Web, `8`: macOS, `0`: Others.
No schema.
### default

The request failed. See the `message` field in the response body for the reason. Refer to Response status codes for details.

No schema.