Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

User

Retrieve current user

Retrieve details of current user.

get/user

Response

OK

idstring

The unique ID of the resource.

namestring

The user's account name.
Only letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .).
Username cannot start or end with period (.).
admin, system, administrator, and root are reserved names for system admin only with case ignored.

emailstring

The email address.

display_namestring

The display name of user.

rolestring

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

  • SystemAdmin: the system administrator has almost all permissions.
  • Replicator: the application permissions collection.
  • Dealer: the sales manager has all sold tenant resource permissions
  • Admin: the admin has all tenant-wide resource permissions.
  • StandardUser: the user all user-wide resource permissions.
  • StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
  • QueueManager: The call queue manager.
enabledboolean

Allows temporarily disabling the extension.

mobile_phonestring

The mobile phone number of user.

work_phonestring

The office phone number of user.

home_phonestring

The home phone number of user.

addressstring

The address.

departmentstring

The department of user.

extension_numberstring

The extension number.

enable_audio_recordingboolean

Records all calls and saves audio recordings on server.

enable_video_recordingboolean

Records all calls and saves video recordings on server.

enable_dndboolean

Enable Do Not Disturb or not.

enable_acbboolean

Enable Automatic Callback or not.

enable_hot_deskingboolean

Enable hot desking feature or not.

anonymous_outbound_callsboolean

Always make outbound anonymous calls or not.

delivery_outbound_cidboolean

Always delivery outbound caller ID or not.

sms'DISABLE' | 'ALLOW' | 'ALLOW_WITH_SENDER_ID'

The preferred configuration for SMS/MMS.
Note: Only users with UserManagement::Users privilege can change this property.

  • DISABLE: Disable user SMS/MMS feature.
  • ALLOW: Enable user SMS/MMS feature but with outbound caller ID.
  • ALLOW_WITH_SENDER_ID: Enable user SMS/MMS but with trunk sender ID.
custom_optionsstring

Some custom configuration options serialized as json string

voicemail_promptstring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

enable_voicemail_pinboolean

Whether the PIN is required to access voice mail of extension.

voicemail_pinstring

The PIN number for accessing.
The PIN policies include:

  1. A sequence of numbers 6-10 digits in length.
  2. No repeating numbers (e.g. "111", "222")
  3. No sequential numbers (e.g. "012", "789")
enable_voicemail_notifyboolean

Enable voicemail to email notify.

voicemail_play_datetime'DISABLE' | '12_HOUR_CLOCK' | '24_HOUR_CLOCK'

Announces Date and Time of Message.

  • DISABLE: Do not read;
  • 12_HOUR_CLOCK: Read in 12-hour clock;
  • 24_HOUR_CLOCK: Read in 24-hour clock.
interface'WEB_DOMAIN' | 'PUBLIC_IPV4' | 'PUBLIC_IPV6' | 'PRIVATE_IPV4' | 'PRIVATE_IPV6' | 'SBC_DOMAIN'

The interface type for QR code or auto provisioning.
Can be neither:

  • WEB_DOMAIN:
  • PUBLIC_IPV4:
  • PUBLIC_IPV6:
  • PRIVATE_IPV4:
  • PRIVATE_IPV6:
  • SBC_DOMAIN:
preferred_transport'UDP' | 'TCP' | 'TLS'

The transport protocol:
Can be either:

  • UDP:
  • TCP:
  • TLS:
created_atstring date_time

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

avatar_file_namestring

The name of the file.

avatar_file_sizeinteger

The file size in bytes.

avatar_file_urlstring

The relative path to file url for file downloading.

profilestring

The unique ID of the resource.

sync_type'Microsoft 365'

The synchronization method.
Can be either:

  • Microsoft 365: Sync from Microsoft 365.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "email": "example@example.com",
  "role": "User",
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ],
  "office_hours": {
    "mode": "CUSTOM",
    "monday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  },
  "custom_forward_rules": [
    {
      "hours": {
        "monday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "tuesday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "wednesday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "thursday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "friday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "saturday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "sunday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        }
      }
    }
  ],
  "voicemail_prompt": "en-US",
  "created_at": "2017-07-21T17:32:28Z",
  "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
  "transports": [
    {
      "port": 80
    }
  ],
  "profile": "NzAwNTUxOTA5NzczMTQ4MTYw"
}