---
title: "Retrieves current user status"
method: GET
path: "/user/status"
tags: ["User"]
---

# Retrieves current user status

`GET /user/status`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/user/status`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/user/status/get.ts> (a function with typed inputs; its response is checked against the schema)

Get status of current user.

## Response `200`

OK

- object
  - `status` 'ONLINE' | 'ON_CALL' | 'OFFLINE': Status of extension: - `ONLINE` - `ON_CALL` - `OFFLINE`
  - `presence` 'DO_NOT_DISTURB' | 'AVAILABLE' | 'AWAY' | 'BUSINESS_TRIP' | 'LUNCH' | 'ON_CALL' | 'OFFLINE': The current presence of extension: - `DO_NOT_DISTURB`: - `AVAILABLE`: - `AWAY`: - `BUSINESS_TRIP`: - `LUNCH`: - `ON_CALL` - `OFFLINE`
  - `presence_note` string: The presence note.
  - `registration` object[]: Collection of registration information.
    - `instance_id` string: The instance ID of registration.
    - `user_agent` string: User agent of login device.
    - `application` string: The application name of login device.
    - `ip` string: The IP address of login device.
    - `enable_push` boolean: Whether push is enabled of login device.
    - `contact_address` string: The contact address information.
  - `enable_dnd` boolean: `Do Not Disturb` enabled or not.
  - `enable_acb` boolean: `Automatic Callback` enabled or not.

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)